Main Page » Server Admins

Enabling Server Admin Users

Admin Configuration File

Scorched3D has an admin console and admin web console to allow server admins to manage games and players.

To enable the admin users you need to create a file that specifies the admin usernames and passwords. The admin usernames and passwords need to be in a file named adminpassword-27270.xml (change the number to match the port that you are running the server on).

This file should be created in the normal Scorched3D configuration area:-

 windows : c:\documents and settings\<username>\.scorched3d 
 unix : ~/.scorched3d 

The file should contain the following:-

 <users> 
       <user> 
               <name>username</name> 
               <password>password</password> 
       </user> 
 </users> 

Replace username with the name of your admin and password with their password. You can repeat the <user></user> blocks to add more than one user. Note: No server restart is needed after making any changes to this file.

Admin Permissions

From version 42 of Scorched3D you can set the permissions for each admin user. These permissions define what operations the admin user is allowed to perform. By default an admin user has no permissions and only view information and perform minor administrative operations.

These are the defined set of permissions

addplayer - allows the admin to add bots

banplayer - allows the admin to ban players

kickplayer - allows the admin to kick players

viewlogs - allows the admin to view the logs from the server

aliasplayer - allows the admin to see all aliases (ip addreses) of players

altergame - allows the admin to kill all players and restart the match/round

alterserver - allows the admin to restart the server (the actual process)

altersettings - allows the admin to change the server settings

Each of these permissions can be enabled using the permission tag. For example, here is user that has all permissions:-

 <users> 
       <user> 
               <name>username</name> 
               <password>password</password> 
               <password>ignatmit</password>
               <permission>addplayer</permission>
               <permission>aliasplayer</permission>
               <permission>altergame</permission>
               <permission>alterserver</permission>
               <permission>altersettings</permission>
               <permission>banplayer</permission>
               <permission>kickplayer</permission>
               <permission>viewlogs</permission>
       </user> 
 </users>

Enabling Web Admin Console

To determine if the web admin console is enabled check the server.xml file for the ManagementPortNo setting.

e.g.

       <option> 
               <name>ManagementPortNo</name> 
               <value>2000</value> 
       </option> 

The value (2000) is the port which may be used to connect to the web console.

Alternatively when running the server via the GUI check the management port setting.

Note: This port must not be blocked by any firewalls, and must be forwarded if behind a NAT router.

Viewing Web Admin Console

For example if the port is 2000 you can connect to the web admin tool via http://127.0.0.1:2000