! These are undocumented and unofficial features !

This is a short instruction how to adminstrate the server at runtime. First we will setup the client for sending raw protocol commands through the chat inputbox.

The commands need to be prefixed by a / (forward slash) in order to get sent raw to the server. Note: The commands are all upper-case, the check is case sensitive (for versions <=0.0.5)!

Steps:
- Set client config variable chat_console to the value true.
- Restart client and login to the server
- Type /CHAT -1 hello! and send it. You'll notice that you just sent a chat message to the foyer with the text "hello!".
- Depending on the command the server sends you a response as chat message.

Commands:

Most of the administration commands require you to execute this command once a session.
/AUTH <type> <password>
Authenticate as server admin (valid till client logoff).  Note: If the authentication was successful the server sends no response. Otherwise an error message is sent.
Example: /AUTH -1 secret_password

/CONFIG get <variable_name>
Get (read from) a server config variable at runtime and output the variables' value.
Example: /CONFIG get max_connections_per_ip

/CONFIG set <variable_name> <variable_value>
Set (write to) a server config variables at runtime. Note: The command does not send a response. If the variable does not exist it will be created. Use double quotes (") in order to send a value with spaces in it. Note: The changes are not persistent. All variables are reset when the server is restarted. Moreover some config variables (e.g. port) cannot be changed at runtime; their re-assignment has no effect.
Example: /CONFIG set max_connections_per_ip 5
Example: /CONFIG set welcome_message "This is a welcome message"

/CONFIG save  (for versions >= 0.0.5)
Save the current state of config to the config file.

/REQUEST serverinfo
Request information and statistics about the server.

/REQUEST start <game-id>
Start a game in waiting state before the minimum player count has reached. The game will be started immediately.
Example, start game with id 123: /REQUEST start 123

/REQUEST restart <game-id> <0|1>
Set option "restart" for a game.
Properties of restart-games:
- They are not deleted if the last players parts from a waiting game.
- They restart automatically when the game has been deleted. This happens after some time the game has been ended.
- After a restart the game is again in waiting state and it's previous options are restored.
Example, set option restart for game with id 123: /REQUEST start 123 1
Example, clear option restart for game with id 123: /REQUEST start 123 0

!sqlite branch only!
/REQUEST playerstats
Request own player information such as ranking. The players are identified by their UUID.

Last edited by datag (2009-09-23 19:41:10)