package minekube.gate.v1
Get desktop application:
View/edit binary Protocol Buffers messages
service GateService
gate_service.proto:8GateService is the service API for managing a Gate proxy instance. It provides methods for managing players and servers. All methods follow standard gRPC error codes and include detailed error messages.
rpc GetPlayer (, )
gate_service.proto:12GetPlayer returns the player by the given id or username. Returns NOT_FOUND if the player is not online. Returns INVALID_ARGUMENT if neither id nor username is provided, or if the id format is invalid.
message
gate_service.proto:118GetPlayerRequest is the request for GetPlayer method.
string id = 1
Gets the player by their Minecraft UUID. Optional, if not set the username will be used. If both id and username are set, the id will be used. Must be a valid Minecraft UUID format (e.g. "550e8400-e29b-41d4-a716-446655440000")
string username = 2
Gets the player by their username. Optional, if not set the id will be used. Case-sensitive.
message
gate_service.proto:131GetPlayerResponse is the response for GetPlayer method.
optional player = 1
The player matching the request criteria
rpc ListPlayers (, )
gate_service.proto:16ListPlayers returns all online players. If servers are specified in the request, only returns players on those servers.
message
gate_service.proto:137ListPlayersRequest is the request for ListPlayers method.
repeated string servers = 1
Filter players by server names. Optional, if empty all online players are returned. If specified, only returns players on the listed servers.
message
gate_service.proto:145ListPlayersResponse is the response for ListPlayers method.
repeated players = 1
rpc ListServers (, )
gate_service.proto:19ListServers returns all registered servers.
message
gate_service.proto:100ListServersRequest is the request for ListServers method.
(message has no fields)
message
gate_service.proto:103ListServersResponse is the response for ListServers method.
repeated servers = 1
rpc RegisterServer (, )
gate_service.proto:24RegisterServer adds a server to the proxy. Returns ALREADY_EXISTS if a server with the same name is already registered. Returns INVALID_ARGUMENT if the server name or address is invalid.
message
gate_service.proto:73RegisterServerRequest is the request for RegisterServer method.
string name = 1
The unique name of the server
string address = 2
The network address of the server (e.g. "localhost:25565")
message
gate_service.proto:81RegisterServerResponse is the response for RegisterServer method.
(message has no fields)
UnregisterServer removes a server from the proxy. Returns NOT_FOUND if no matching server is found. Returns INVALID_ARGUMENT if neither name nor address is provided.
message
gate_service.proto:84UnregisterServerRequest is the request for UnregisterServer method.
string name = 1
The name of the server. Optional, if not set, the address will be used to match servers.
string address = 2
The address of the server. Optional, if not set, the name will be used to match servers. If both name and address are set, only the server that matches both properties exactly will be unregistered. If only the address is set, the first server matching that address will be unregistered.
message
gate_service.proto:97UnregisterServerResponse is the response for UnregisterServer method.
(message has no fields)
rpc ConnectPlayer (, )
gate_service.proto:34ConnectPlayer connects a player to a specified server. Returns NOT_FOUND if either the player or target server doesn't exist. Returns FAILED_PRECONDITION if the connection attempt fails.
message
gate_service.proto:62ConnectPlayerRequest is the request for ConnectPlayer method.
string player = 1
The player's username or ID to connect
string server = 2
The target server name to connect the player to
message
gate_service.proto:70ConnectPlayerResponse is the response for ConnectPlayer method.
(message has no fields)
DisconnectPlayer disconnects a player from the proxy. Returns NOT_FOUND if the player doesn't exist. Returns INVALID_ARGUMENT if the reason text is malformed.
message
gate_service.proto:43DisconnectPlayerRequest is the request for DisconnectPlayer method.
string player = 1
The player's username or ID to disconnect
string reason = 2
The reason displayed to the player when they are disconnected. Formats: - `{"text":"Hello, world!"}` - JSON text component. See https://wiki.vg/Text_formatting for details. - `§aHello,\n§bworld!` - Simple color codes. See https://wiki.vg/Text_formatting#Colors Optional, if empty no reason will be shown.
message
gate_service.proto:59DisconnectPlayerResponse is the response for DisconnectPlayer method.
(message has no fields)
message
gate_service.proto:150Player represents an online player on the proxy.
Used in: ,
string id = 1
The player's Minecraft UUID
string username = 2
The player's username
message
gate_service.proto:108Server represents a backend server where Gate can connect players to.
Used in:
string name = 1
The unique name of the server.
string address = 2
The network address of the server.
int32 players = 3
The number of players currently on the server.