Proto

Protocol Documentation

Table of Contents

• mod_api.proto

  • PlayerCurrency

  • PlayerCurrency.TicketBundle

  • PlayerMode

  • PlayerPermissions

  • PlotInfo

  • PlotInfo.PlotPlayer

  • ServerBooster

  • ServerBooster.ActiveBooster

  • ServerInfo

  • Mode

  • ServerInfo.DFServerType

• Scalar Value Types

Top

mod_api.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 switches modes.

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

PlayerPermissions

Sent when the player joins the server, admins will have all permissions set to their highest level.

Field	Type	Label	Description
donor	int32		The donor rank level of the player. (Noble, Emperor, Mythic, Overlord)
support	int32		The support rank level of the player. (JrHelper, Helper, SrHelper)
mod	int32		The mod rank level of the player. (JrMod, Mod, SrMod)
admin	int32		The admin rank level of the player. (Dev, Admin, Owner)

PlotInfo

Sent when the player joins a plot.

Field	Type	Label	Description
id	int32		The identifier of the plot.
name	string		The name of the plot as a serialized component in JSON format.
owner_name	string		The name of the owner of the plot.
owner_uuid	string		The UUID of the owner of the plot (36 characters including dashes).
plot_size	int32		The size of the plot (1 = Basic, 2 = Large, 3 = Massive, 4 = Mega).
plot_min_x	int32		The minimum X coordinate of the plot.
plot_min_z	int32		The minimum Z coordinate of the plot.
spawn_pos_x	int32		The spawn X coordinate of the plot.
spawn_pos_y	int32		The spawn Y coordinate of the plot.
spawn_pos_z	int32		The spawn Z coordinate of the plot.
is_owner	bool		Whether the player is the owner of the plot.
is_developer	bool		Whether the player has developer permissions on the plot.
is_builder	bool		Whether the player has builder permissions on the plot.
tags	string	repeated	The tags of this plot (e.g. "adventure", "combat", ...).
handle	string		The handle of the plot, or empty if none is set.
players	PlotInfo.PlotPlayer	repeated	The players currently on the plot.

PlotInfo.PlotPlayer

Represents a player in a plot.

Field	Type	Label	Description
user_name	string		The name of the player.
user_uuid	string		The UUID of the player (36 characters including dashes).
is_owner	bool		Whether the player is the owner of the plot.
is_developer	bool		Whether the player has developer permissions on the plot.
is_builder	bool		Whether the player has builder permissions on the plot.
mode	Mode		The mode the player is in.

ServerBooster

Sent when the player joins the server.

Field	Type	Label	Description
is_active	bool		Whether a booster is currently active.
active_booster	ServerBooster.ActiveBooster	optional	The active booster, if any.

ServerBooster.ActiveBooster

Represents an active booster.

Field	Type	Label	Description
tipped	bool		Whether the booster was tipped by the player.
multiplier	int32		The multiplier of the booster (e.g. 2 for 2x).
time_remaining	int64		The time remaining of the booster in milliseconds.
user_name	string		The name of the player who activated the booster.
user_uuid	string		The UUID of the player who activated the booster (36 characters including dashes).

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.

Mode

Represents a player's mode.

Name	Number	Description
PLAY	0	Play mode.
BUILD	1	Build mode.
CODE	2	Dev (code) mode.
STALK	3	Code spectate (stalk) mode.
VANISH	4	Mod vanish mode.
SPAWN	5	Spawn (idle) mode.
VERIFY	6	Account check (verify) 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)