The Project Zomboid Game does not expose its backend functionalities for creating custom server/admin commands through its Lua scripts modding tooling, making the only other way to achieve similar results patching the game Java files.
This project is an attempt to provide a way for dedicated server administrators to remotely run custom commands towards their servers.
- Allows server administrators to define and run custom commands.
- No need to modify the game's Java files.
- Utilizes Lua scripting to extend the game's functionalities.
- Using the
/servermsgadmin command through RCON, you will send a broadcast message to all users online - The mod will be "listening" for
OnAddMessagesevent. - This event is triggered when a message is about to be create on users chat window.
- The mod will filter these
servermsgmessages looking for custom/command - If the message contains one of the custom commands, it will suppress the message for the user client and the command will be processed by the server
- As the event will be registered by all clients online. The mod has an internal logic to avoid duplication when running the custom commands
Unfortunately, the Event being used to triggered the commands is a Client event. Therefore, you will need at least one player online at your server for the command to be triggered.
It doesn't have any dependencies on the player itself, literally just need a player online.
Send commands via RCON:
Use your preferred RCON client to send commands to the server.
-
servermsg "/spawn_zombies <command_id> <pos_x> <pos_y> <pos_z> <zombie_qty>"- i.e
servermsg "/spawn_zombies 1 100 200 0 50"
- i.e
-
servermsg "/spawn_item <command_id> <item_name> <pos_x> <pos_y> <pos_z>"- i.e
servermsg "/spawn_item 1 Base.Axe 100 200 0"
- i.e
- duplicate the file media/lua/server/RCONCommand_template.lua
- rename to match you new custom command name i.e
RCONCommand_new_command.lua - edit for your liking
- either restart the server or update the lua file via RCON
reloadlua RCONCommand_new_command.lua