Proto

Protocol Documentation

Table of Contents

• plugin_messages.proto

  • PlayerCurrency

  • PlayerCurrency.TicketBundle

  • PlayerMode

  • ServerInfo

  • PlayerMode.Mode

  • ServerInfo.DFServerType

• Scalar Value Types

Top

plugin_messages.proto

PlayerCurrency

Sent when the player joins the server.

Field	Type	Label	Description
tokens	int32		The amount of tokens the player has.
tickets	int32		The amount of tickets the player has.
ticket_bundles	PlayerCurrency.TicketBundle	repeated	The unclaimed ticket bundles the player has.
sparks	int32		The amount of sparks the player has.

PlayerCurrency.TicketBundle

Represents an unclaimed ticket bundle.

Field	Type	Label	Description
event_name	string		The name of the event the bundle is from.
prize_name	string		The name of the prize the bundle is for.
ticket_amount	int32		The amount of tickets in the bundle.

PlayerMode

Sent when the player joins the server.

Field	Type	Label	Description
mode	PlayerMode.Mode		The mode the player is in.

ServerInfo

Sent when the player joins the server.

Field	Type	Label	Description
protocol_version	string		The version of the protocol in semver format.
bungee_name	string		The identifier of the server.
patch_version	string		The patch version of the server.
server_type	ServerInfo.DFServerType		The type of the server.

PlayerMode.Mode

Name	Number	Description
PLAY	0	Play mode.
BUILD	1	Build mode.
DEV	2	Dev mode.
SPY	3	Code-spectate mode.
VANISH	4	Mod vanish mode.
IDLE	5	Spawn mode.
VERIFY	6	Bot check mode.

ServerInfo.DFServerType

Represents a server type.

Name	Number	Description
MAIN	0	Main nodes.
BETA	1	Node beta.
DEV	2	Dev nodes.
PUBLIC_TEST	3	Unused.
PUBLIC_EVENT	4	Event node.
LOCAL_DEV	5	Local dev servers.
PRIVATE	6	Private nodes.

Scalar Value Types

.proto Type	Notes	C++	Java	Python	Go	C#	PHP	Ruby
double		double	double	float	float64	double	float	Float
float		float	float	float	float32	float	float	Float
int32	Uses variable-length encoding. Inefficient for encoding negative numbers – if your field is likely to have negative values, use sint32 instead.	int32	int	int	int32	int	integer	Bignum or Fixnum (as required)
int64	Uses variable-length encoding. Inefficient for encoding negative numbers – if your field is likely to have negative values, use sint64 instead.	int64	long	int/long	int64	long	integer/string	Bignum
uint32	Uses variable-length encoding.	uint32	int	int/long	uint32	uint	integer	Bignum or Fixnum (as required)
uint64	Uses variable-length encoding.	uint64	long	int/long	uint64	ulong	integer/string	Bignum or Fixnum (as required)
sint32	Uses variable-length encoding. Signed int value. These more efficiently encode negative numbers than regular int32s.	int32	int	int	int32	int	integer	Bignum or Fixnum (as required)
sint64	Uses variable-length encoding. Signed int value. These more efficiently encode negative numbers than regular int64s.	int64	long	int/long	int64	long	integer/string	Bignum
fixed32	Always four bytes. More efficient than uint32 if values are often greater than 2^28.	uint32	int	int	uint32	uint	integer	Bignum or Fixnum (as required)
fixed64	Always eight bytes. More efficient than uint64 if values are often greater than 2^56.	uint64	long	int/long	uint64	ulong	integer/string	Bignum
sfixed32	Always four bytes.	int32	int	int	int32	int	integer	Bignum or Fixnum (as required)
sfixed64	Always eight bytes.	int64	long	int/long	int64	long	integer/string	Bignum
bool		bool	boolean	boolean	bool	bool	boolean	TrueClass/FalseClass
string	A string must always contain UTF-8 encoded or 7-bit ASCII text.	string	String	str/unicode	string	string	string	String (UTF-8)
bytes	May contain any arbitrary sequence of bytes.	string	ByteString	str	[]byte	ByteString	string	String (ASCII-8BIT)