Crate 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.

Clients will send the protocol version they’re using. So if the client sends a protocol_version of 2 they will be using messages from version_2.

In each version module there is an opcodes module that contains enums for possible client and server messages. As well as utility functions for reading/writing the correct message.

Notice that the same game version may use different protocol versions for login/reconnecting. See the table on the WoWDev wiki or the table below for further information.

Game Version	Login	Reconnect
1.1.2.4125	2	2
1.12.1.5875	3	2
2.0.0.6080	3	2
2.0.1.6180	3	2
2.0.3.6299	5	5
2.0.5.6320	6	6
2.0.6.6337	5	5
2.0.7.6383	6	6
2.0.8.6403	6	6
2.0.10.6448	6	6
2.0.12.6546	6	6
2.1.0.6692	6	6
2.1.0.6729	6	6
2.1.1.6739	6	6
2.1.2.6803	6	6
2.1.3.6898	6	6
2.2.0.7272	6	6
2.2.2.7318	6	6
2.2.2.7318	6	6
2.2.3.7359	6	6
2.3.0.7561	7	7
2.3.2.7741	7	7
2.3.3.7799	7	7
2.4.0.8089	8	8
2.4.1.8125	8	8
2.4.2.8278	8	8
2.4.3.8606	8	8
3.3.5.12340	8	8

The helper module contains utility functions for common operations.

The ClientMessage (sent from the client) and ServerMessage (sent from the server) are the primary interface for sending messages.

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 use the structs from the relevant version module.

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.

Modules

• all
• errors
• helper
  Utility functions for common operations.
• version_2
• version_3
• version_5
• version_6
• version_7
• version_8

Constants

• DEFAULT_PORT
  Default used by the auth server. Clients will automatically connect to this when no port is specified in the realmlist.wtf.

Traits

• ClientMessage
  Trait to write messages sent from the client.
• ServerMessage
  Trait to write messages sent from the server.