Protocol

Introduction

In AziPluginMessaging, the packets are communicated using plugin messages (as the plugin name indicates).

Definitions

Player

Field Name	Field Type	Notes
UUID	String
Has Username?	Boolean	If false, the next field is not present.
Username	String

Packets

All packets are sent encrypted except for Encryption Request (Proxybound) and Encryption Response (Serverbound).

The encryption process:

1. S→P: Encryption Request
2. P→S: Encryption Response
3. Server validates the response, and both enable encryption

Proxybound

Encryption Request

Packet ID	Bound To	Field Name	Field Type	Notes
0x00	Proxy	Challenge Token	String	Challenge token to respond back to the server.
		Public Key	String	Public key of the server

Set Rank

Sets the player's current rank on the server. If the player has multiple ranks, all other ranks will be removed.

Any groups that are not in the rank track will be denied.

Packet ID	Bound To	Field Name	Field Type	Notes
0x01	Proxy	Rank	String	Rank group name (this must be present in the `rank` track)
		Player	Player	the target player to set the rank

Give Gaming Sara

Grants gamingsara rank to the player. This action is irreversible.

Packet ID	Bound To	Field Name	Field Type	Notes
0x02	Proxy	Player	Player	the target player to grant the rank

Give Sara

Grants (amount)sara rank to the player. This action is irreversible.

Possible values of amount (hardcoded):

• 100
• 500
• 1000
• 2000
• 5000
• 10000

Packet ID	Bound To	Field Name	Field Type	Notes
0x03	Proxy	Amount	Int	See above
		Player	Player	the target player to grant the rank

Toggle Gaming Sara

Toggles whether the gamingsara should be shown.

Packet ID	Bound To	Field Name	Field Type	Notes
0x04	Proxy	Player	Player

Toggle Sara (Hide)

Toggles whether the sara rank should be hidden (in global).

Packet ID	Bound To	Field Name	Field Type	Notes
0x05	Proxy	Player	Player

Toggle Sara (Show)

Toggles whether the sara rank should be shown (in rankable servers).

Packet ID	Bound To	Field Name	Field Type	Notes
0x06	Proxy	Player	Player

Serverbound

Encryption Response

The proxy sends the response packet after the request packet was received.

Packet ID	Bound To	Field Name	Field Type	Notes
0x00	Proxy	Challenge Token	String	Challenge token from Encryption Request packet. The encryption response fails if this does not match.
		Public Key	String	Public key of the proxy.

Action Response

Sends a message to the player.

Packet ID	Bound To	Field Name	Field Type	Notes
0x01	Proxy	UUID	String	UUID of the player to send message to.
		Message	String	Legacy formatted message. Can contain section (\u00a7) character.