diff --git a/docs/reference.xml b/docs/reference.xml index aed98388..ff28e64e 100644 --- a/docs/reference.xml +++ b/docs/reference.xml @@ -295,17 +295,54 @@ Connects to a server. + + + If the server name ist omitted, the client will try to connect to an available server in the LAN. + + - connect 127.0.0.1 myPassword + connect 127.0.0.1 myServerPassword + + + + + + + + + + Connects to a server and tries to claim admin state. + + + This command will connect to a server just like the command 'connect' and + try to claim admin state. If the specified password is correct, the admin + will be able to connect even if he is locked out by ban, private master mode or taken client slots. + If successfully connected, bans assigned to the admin's host will be removed automatically. If all + client slots are taken a random client will be kicked to let the admin in. + + + If the server name ist omitted, the client will try to connect to an available server in the LAN. + + + + + + connect 127.0.0.1 myAdminPassword + + + + + + - - + + Leaves a server. @@ -510,7 +547,7 @@ Bans a specified player from the server. - Requires admin state. The ban duration is fixed to 20 minutes. + Requires master or admin state. The ban duration is fixed to 20 minutes. @@ -526,7 +563,7 @@ Removes all bans on the server. - Requires admin state. + Requires master or admin state. @@ -566,6 +603,36 @@ + + Forces a specified player to join the enemy team. + + + Requires master or admin state. + + + + + + + + + + + + Gives the master state to specified player. + + + Requires admin state. The admin will lose his admin state after successfully issuing this command. + + + + + + + + + + Adds a new section to the ingame documentation. diff --git a/docs/server.xml b/docs/server.xml index c4d7e1f0..69fbafa3 100644 --- a/docs/server.xml +++ b/docs/server.xml @@ -84,101 +84,88 @@ administrative actions normal players can't.

-
- setmaster B -
-

- where is B is 1 to claim master or 0 to give up master. -

- -

- The master can change the master mode of the server using the mastermode command: -

- -
- mastermode N -
- -

- sets the master mode to N. Possible master modes are: + There exist two master modes a server master can set:

- -

- Once you claimed master, you can also kick people from the server. Open the scoreboard (key: TAB) to look up the client number (cn) of the player - you want to kick. -

-
- kick N -
-

- kicks the player with the client number N from the server. See the scoreboard to look up the client number. + The idea behind this is to avoid the need for 'real' administrators that have to babysit the server 24/7. + Unlike other games, the players control themselves using the described master role and the master modes.

- The current master can enable the auto-team option for the server. If enabled, newly connected clients will be forced to the smaller team and switching to the bigger - or equal sized team won't be possible anymore. A team shuffle is performed every time the game mode changes from FFA to a team mode and when the auto-team - option is initally enabled. -

- -
- autoteam N -
- -

- where N is 1 to enable and 0 to disable the auto-team option. + Related commands:

+ +

Server Admin

- There is an additional client role a player can claim called 'admin'. In addition to the commands a master - can execute, an admin can also ban players from the server. + There is an additional client role a player can claim called admin. + It can be claimed by the real owner of a server to control the situation + if an abusive master is doing bad stuff. Claiming admin state works similiar to the master state, however it requires a password that matches the server configuration.

-
- setadmin N P -
-

- where is B is 1 to claim admin or 0 to give up admin. P is the required password. - The owner of a server can configure this password to gain control over his server using this command. - As soon as a player successfully claims admin, all existing master or admin players lose their privileged state. - So assume a some dumb player abuses the master state and kicks all players from your own server, you - can get control back by issuing these commands as example: -

- -
- connect myserver.mydomain.com; setadmin 1 myPassw0rd -
- -

- This connects to the server myserver.mydomain.com and immediately claims admin state using the "myPassw0rd" password. + Related commands:

-
- ban N -
+

- bans the player with the client number N from the server and refuses any connection attempts from his IP for the next 20 minutes. + Use the setadmin command to claim admin if you are already connected to a sever. + However if you are locked out of your own server because you are banned, master mode is private or because all + client slots are taken, you can use the connectadmin command to get control + back though. Once the mess is cleaned up, the command givemaster can be used + to give back the master state to a honest player.

- -

- This removes all active bans. + The admin password is configured using the -x command-line option.

Server Operator Menu