wow_login_messages

Crates.iowow_login_messages
lib.rswow_login_messages
version0.4.0
sourcesrc
created_at2022-04-03 12:30:16.078635
updated_at2024-02-21 19:29:09.971933
descriptionMessage definitions for World of Warcraft authentication servers
homepage
repositoryhttps://www.github.com/gtker/wow_messages
max_upload_size
id561292
size922,953
(gtker)

documentation

README

wow_login_messages

Implementation of the network protocol used between World of Warcraft authentication/login servers and clients for game versions 1.0.0 (Vanilla) to 3.3.5 (Wrath of the Lich King). See the WoWDev Login page for details.

Usage

To add only the synchronous methods run the following command:

cargo add --features 'sync' wow_login_messages

For async support see the Features section.

And then check out the docs.

Features

Tokio and async-std support are gated behind the tokio and async-std features. Synchronous (std) support is gated behind sync. All of these are disabled by default. You must enable at least one of them, otherwise there's not much point to the crate.

Auto Generation

This crate is partially auto generated by the wowm files in the wow_messages repository.

Design Decisions

Types have been named the ugly CMD_SCREAMING_SNAKE_CASE way because that's what other (mostly C++) emulators call them. This makes it significantly easier to search through other emulators or other documentation.

Other Work

  • vMaNGOS (C++) and MaNGOS derivatives in general have a relatively complete list of messages for popular versions, but they are not available as a library.
  • Ember (C++) has all messages for 1.12, although some work will probably be required in order to use it as a standalone library.
  • Shadowburn (Erlang) has messages for 1.12, although they are not in the form of a library.
  • gophercraft (Go) seems to have most messages in a library format.

License

Licensed under either of

at your option.

Contribution

Unless you explicitly state otherwise, any contribution intentionally submitted for inclusion in the work by you, as defined in the Apache-2.0 license, shall be dual licensed as above, without any additional terms or conditions.

Commit count: 0

cargo fmt