Skip to content
Antoine edited this page Sep 25, 2025 · 2 revisions

Events

00001 - SERVER.STARTING

Fired when a server is starting.

Arguments:

Name Type ID Description
timestamp datetime 001 the exact time the message was sent
server_name str 002 the name of the server that is starting

Returns:

None : Nothing


00002 - SERVER.STARTED

Fired after a server has started.

Arguments:

Name Type ID Description
timestamp datetime 001 the exact time the message was sent
server_name str 002 the name of the server that has started

Returns:

None : Nothing


00003 - SERVER.STOPPING

Fired when a server is stopping.

Arguments:

Name Type ID Description
timestamp datetime 001 the exact time the message was sent
server_name str 002 the name of the server that is stopping

Returns:

None : Nothing


00004 - SERVER.STOPPED

Fired after a server has stopped.

Arguments:

Name Type ID Description
timestamp datetime 001 the exact time the message was sent
server_name str 002 the name of the server that has stopped

Returns:

None : Nothing


00005 - SERVER.CRASHED

Fired when a server has crashed.

Arguments:

Name Type ID Description
timestamp datetime 001 the exact time the message was sent
server_name str 002 the name of the server that has crashed

Returns:

None : Nothing


00006 - SERVER.START

Request to start a server.

Arguments:

Name Type ID Description
timestamp datetime 001 the exact time the message was sent
server_name str 002 the name of the server to start

Returns:

None : Nothing


00007 - SERVER.STOP

Request to stop a server. The emmitter will wait for the server to stop before returning.

Arguments:

Name Type ID Description
timestamp datetime 001 the exact time the message was sent
server_name str 002 the name of the server to stop

Returns:

bool : True if the server was stopped successfully, False otherwise


00008 - SERVER.RESTART

Request to restart a server.

Arguments:

Name Type ID Description
timestamp datetime 001 the exact time the message was sent
server_name str 002 the name of the server to restart

Returns:

None : Nothing


00009 - SERVER.CREATE

Request to create a new server.

Arguments:

Name Type ID Description
timestamp datetime 001 the exact time the message was sent
server_name str 002 the name of the server to create
server_type str 003 the type of the server to create
server_path str 004 the path where the server will be created
autostart bool 005 whether the server should autostart
mc_version Version 006 the Minecraft version for the server
modloader_version Version 007 the modloader version (if not vanilla)
ram int 008 the amount of RAM to allocate

Returns:

None : Nothing


00010 - SERVER.DELETE

Request to delete a server.

Arguments:

Name Type ID Description
timestamp datetime 001 the exact time the message was sent
server_name str 002 the name of the server to delete

Returns:

None : Nothing


00011 - SERVER.RENAME

Request to rename a server.

Arguments:

Name Type ID Description
timestamp datetime 001 the exact time the message was sent
server_name str 002 the current name of the server
new_name str 003 the new name for the server

Returns:

None : Nothing


00012 - SERVER.CREATED

Fired after a server has been created.

Arguments:

Name Type ID Description
timestamp datetime 001 the exact time the message was sent
server_name str 002 the name of the server that was created
server_type str 003 the type of the server
server_path str 004 the path where the server was created
autostart bool 005 whether the server should autostart
mc_version Version 006 the Minecraft version for the server
modloader_version Version 007 the modloader version (if not vanilla)
ram int 008 the amount of RAM allocated

Returns:

None : Nothing


00013 - SERVER.DELETED

Fired after a server has been deleted.

Arguments:

Name Type ID Description
timestamp datetime 001 the exact time the message was sent
server_name str 002 the name of the server that was deleted

Returns:

None : Nothing


00014 - SERVER.RENAMED

Fired after a server has been renamed.

Arguments:

Name Type ID Description
timestamp datetime 001 the exact time the message was sent
server_name str 002 the previous name of the server
new_name str 003 the new name of the server

Returns:

None : Nothing


00015 - SERVER.LIST

Request a list of all servers.

Arguments:

Name Type ID Description
timestamp datetime 001 the exact time the message was sent

Returns:

List[Dict[str, Any]] : A list of dictionaries, each containing server information


00016 - SERVER.PING

Request to ping a server.

Arguments:

Name Type ID Description
timestamp datetime 001 the exact time the message was sent
server_name str 002 the name of the server to ping

Returns:

str : Returns the server's status as a string: "online", "offline", or "starting".


00017 - SERVER.SEED

Request the world seed of a server. Returns the seed as a string.

Arguments:

Name Type ID Description
timestamp datetime 001 the exact time the message was sent
server_name str 002 the name of the server

Returns:

str : The world seed as a string


00018 - SERVER.INFO

Request detailed information about a server. Returns a dictionary containing server information.

Arguments:

Name Type ID Description
timestamp datetime 001 the exact time the message was sent
server_name str 002 the name of the server

Returns:

Dict[str, Any] : A dictionary containing server information


00019 - SERVER.CREATING

Fired when a server is being created.

Arguments:

Name Type ID Description
timestamp datetime 001 the exact time the message was sent
server_name str 002 the name of the server being created
server_type str 003 the type of the server
server_path str 004 the path where the server will be created
autostart bool 005 whether the server should autostart
mc_version Version 006 the Minecraft version for the server
modloader_version Version 007 the modloader version (if not vanilla)
ram int 008 the amount of RAM to allocate

Returns:

None : Nothing


00020 - SERVER.STARTED_AT

Request the time a server was started. Returns a datetime object representing the start time.

Arguments:

Name Type ID Description
timestamp datetime 001 the exact time the message was sent
server_name str 002 the name of the server

Returns:

datetime : The datetime object representing the server's start time


00257 - CONSOLE.MESSAGE_RECEIVED

Fired when a console message is received from a server.

Arguments:

Name Type ID Description
timestamp datetime 001 the exact time the message was sent
server_name str 002 the name of the server
from str 003 the sender of the message
message str 004 the message content

Returns:

None : Nothing


00258 - CONSOLE.LOG_RECEIVED

Fired when a log message is received from a server.

Arguments:

Name Type ID Description
timestamp datetime 001 the exact time the message was sent
server_name str 002 the name of the server
content str 003 the log content

Returns:

None : Nothing


00259 - CONSOLE.SEND_MESSAGE

Request to send a message to a server's console.

Arguments:

Name Type ID Description
timestamp datetime 001 the exact time the message was sent
server_name str 002 the name of the server
_from str 003 the sender of the message
message str 004 the message content

Returns:

None : Nothing


00260 - CONSOLE.SEND_COMMAND

Request to send a command to a server's console.

Arguments:

Name Type ID Description
timestamp datetime 001 the exact time the message was sent
server_name str 002 the name of the server
command str 003 the command to send

Returns:

None : Nothing


00513 - PLAYERS.JOINED

Fired when a player joins a server.

Arguments:

Name Type ID Description
timestamp datetime 001 the exact time the message was sent
server_name str 002 the name of the server
player_name str 003 the name of the player who joined

Returns:

None : Nothing


00514 - PLAYERS.LEFT

Fired when a player leaves a server.

Arguments:

Name Type ID Description
timestamp datetime 001 the exact time the message was sent
server_name str 002 the name of the server
player_name str 003 the name of the player who left

Returns:

None : Nothing


00515 - PLAYERS.KICKED

Fired when a player is kicked from a server.

Arguments:

Name Type ID Description
timestamp datetime 001 the exact time the message was sent
server_name str 002 the name of the server
player_name str 003 the name of the player who was kicked

Returns:

None : Nothing


00516 - PLAYERS.BANNED

Fired when a player is banned from a server.

Arguments:

Name Type ID Description
timestamp datetime 001 the exact time the message was sent
server_name str 002 the name of the server
player_name str 003 the name of the player who was banned

Returns:

None : Nothing


00517 - PLAYERS.PARDONED

Fired when a player is pardoned (unbanned) from a server.

Arguments:

Name Type ID Description
timestamp datetime 001 the exact time the message was sent
server_name str 002 the name of the server
player_name str 003 the name of the player who was pardoned

Returns:

None : Nothing


00518 - PLAYERS.KICK

Request to kick a player from a server.

Arguments:

Name Type ID Description
timestamp datetime 001 the exact time the message was sent
server_name str 002 the name of the server
player_name str 003 the name of the player to kick
reason str 004 the reason for kicking the player

Returns:

None : Nothing


00519 - PLAYERS.BAN

Request to ban a player from a server.

Arguments:

Name Type ID Description
timestamp datetime 001 the exact time the message was sent
server_name str 002 the name of the server
player_name str 003 the name of the player to ban
reason str 004 the reason for banning the player

Returns:

None : Nothing


00520 - PLAYERS.PARDON

Request to pardon (unban) a player from a server.

Arguments:

Name Type ID Description
timestamp datetime 001 the exact time the message was sent
server_name str 002 the name of the server
player_name str 003 the name of the player to pardon

Returns:

None : Nothing


00521 - PLAYERS.LIST

Request a list of all players currently online on a server.

Arguments:

Name Type ID Description
timestamp datetime 001 the exact time the message was sent
server_name str 002 the name of the server

Returns:

list[str] : the list of online players


00769 - GET_VERSIONS.MINECRAFT

Request a list of all available Minecraft versions.

Arguments:

Name Type ID Description
timestamp datetime 001 the exact time the message was sent

Returns:

list[Version] : A list of available Minecraft versions


00770 - GET_VERSIONS.FORGE

Request a list of all available Forge versions for a specific Minecraft version.

Arguments:

Name Type ID Description
timestamp datetime 001 the exact time the message was sent
mc_version Version 002 the Minecraft version

Returns:

Dict[Version, Dict[str, Any]] : A list of dictionaries, each containing one Forge version and information about it


01025 - GET_DIRECTORIES.MINECRAFT

Request a list of all available Minecraft directories.

Arguments:

Name Type ID Description
timestamp datetime 001 the exact time the message was sent

Returns:

list[str] : A list of available Minecraft directories, set in the config file


Clone this wiki locally