Difference between revisions of "Server console"

From AAGRINDER wiki
Jump to navigationJump to search
imported>Maze
(Created page with "While running an AAGRINDER server, the admin has access to the server console. The console displays various kinds of data about activity on the server. Additionally, the conso...")
 
(Update and clean up entries)
 
(3 intermediate revisions by one other user not shown)
Line 1: Line 1:
 
While running an AAGRINDER server, the admin has access to the server console. The console displays various kinds of data about activity on the server. Additionally, the console accepts input on [[wikipedia:stdin|stdin]]. This allows the admin to type commands in the server console. The following table describes all these commands. Please note that the Enter key needs to be pressed after each typed command.
 
While running an AAGRINDER server, the admin has access to the server console. The console displays various kinds of data about activity on the server. Additionally, the console accepts input on [[wikipedia:stdin|stdin]]. This allows the admin to type commands in the server console. The following table describes all these commands. Please note that the Enter key needs to be pressed after each typed command.
 +
 +
Please note that these commands are exclusive to the server console, it is not possible to run them from within the game. For a list of in-game commands, see [[command list]].
 +
 
{| class="wikitable"
 
{| class="wikitable"
 
|-
 
|-
Line 6: Line 9:
 
| save || Saves the world to disk.
 
| save || Saves the world to disk.
 
|-
 
|-
| stop || Saves the world to disks and stops the AAGRINDER server.
+
| stop || Saves the world to disk (if [[server config|autosave]] is enabled) and stops the AAGRINDER server.
 
|-
 
|-
| admin || Reloads the list of admins from the files ''admins.txt'' and ''sudo.txt''.
+
| kill || Immediately stops the AAGRINDER server without saving.
 
|-
 
|-
| forcereload || Reloads all clients. Note that just restarting the server does not reload clients, so you will need to run ''forcereload'' if you want to update clients to a new version.
+
| players || Displays a list of online players.
 +
|-
 +
| kick || Takes 1 argument, the name of the player who will be kicked. Useful if you are stuck online server-side. No quotes required around argument.
 +
|-
 +
| chat || Takes an unlimited number of arguments. A chat message is then sent to all clients. In chat, the message sender appears as '''[SERVER]'''.
 +
|-
 +
| admin || Reloads the list of admins from the files ''admins.txt''.
 +
|-
 +
| passwd || Takes 2 arguments: player name and new password. If password is ''""'', the password is removed from the account.
 +
|-
 +
| forcereload || As of [https://gitlab.com/MRAAGH/aagrinder/-/commit/9c1e65c1fd8574fa3fb281de997c2003b898fbb5 30th June 2020], this no longer reloads clients. Instead, it displays a message to all users, asking them to reload.
 
|-
 
|-
 
| log || Saves all submitted client logs and server logs to disk. Only available if ''debug_server'' is set to ''true'' in [[server settings]].
 
| log || Saves all submitted client logs and server logs to disk. Only available if ''debug_server'' is set to ''true'' in [[server settings]].
 +
|-
 +
| clearlog || Deletes the recorded server event debuglog.
 
|}
 
|}
 +
 +
It is currently not possible to close the server console without also stopping the server. If you want to disconnect from the console without losing the session, I recommend using a [[wikipedia:terminal multiplexer|terminal multiplexer]] such as [[wikipedia:gnu screen|Screen]] or [[wikipedia:tmux|tmux]].

Latest revision as of 08:02, 9 July 2024

While running an AAGRINDER server, the admin has access to the server console. The console displays various kinds of data about activity on the server. Additionally, the console accepts input on stdin. This allows the admin to type commands in the server console. The following table describes all these commands. Please note that the Enter key needs to be pressed after each typed command.

Please note that these commands are exclusive to the server console, it is not possible to run them from within the game. For a list of in-game commands, see command list.

Command Description
save Saves the world to disk.
stop Saves the world to disk (if autosave is enabled) and stops the AAGRINDER server.
kill Immediately stops the AAGRINDER server without saving.
players Displays a list of online players.
kick Takes 1 argument, the name of the player who will be kicked. Useful if you are stuck online server-side. No quotes required around argument.
chat Takes an unlimited number of arguments. A chat message is then sent to all clients. In chat, the message sender appears as [SERVER].
admin Reloads the list of admins from the files admins.txt.
passwd Takes 2 arguments: player name and new password. If password is "", the password is removed from the account.
forcereload As of 30th June 2020, this no longer reloads clients. Instead, it displays a message to all users, asking them to reload.
log Saves all submitted client logs and server logs to disk. Only available if debug_server is set to true in server settings.
clearlog Deletes the recorded server event debuglog.

It is currently not possible to close the server console without also stopping the server. If you want to disconnect from the console without losing the session, I recommend using a terminal multiplexer such as Screen or tmux.