Urban Terror Docs : Manual : Server setup & administration

Manual
Server setup & administration

A | Server Setup

1 Linux Server Install Guide

This part of the guide assumes the following. You have "SHELL" access to your dedicated Linux system. It also assumes that you have a basic knowledge of the Linux OS.

1. If you do NOT have access to the user root, please skip to Step 4.

2. Login as root and perform the following command:

useradd urt

If your server does not create home directories correctly issue the following commands:

mkdir /home/urt
chown urt /home/urt
usermod -d /home/urt urt

3. Now switch your current user over to urt by using the command:

su urt
NOTICE: If you are using a different user than urt, please replace all references of the user urt for your own username.

4. Make sure you are in your home directory, if in doubt, use the command:

cd ~

5. Now perform the following command:

wget <MIRROR URL> e.g. wget ftp://ftp.snt.utwente.nl/pub/games/urbanterror/UrbanTerror_41_FULL.zip

Download the zip file NOT the .exe installer.
NOTICE: You need the program wget for this, if you don't have it, please visit their website on how to install it.

6. Issue the command:

unzip UrbanTerror_<version>_FULL.zip

The archive will now decompress to the location /home/urt/UrbanTerror/

7. To clean up case sensitive unix paths (that will cause potential problems in case you forget) issue the command:

mv UrbanTerror/ urbanterror/

8. To move into the q3ut4 directory issue the command:

cd urbanterror/q3ut4/

9. Use your favorite linux file editor to edit the server.cfg file as explained in this manual.

10. Write a shell script to start your server.

Issue the command cd ~/urbanterror/ to make sure you are in the root urbanterror directory. Using your text editor, make a file called start.sh. In the file you wish to have the following;

#!/bin/bash
while true
do
/home/urt/urbanterror/ioUrTded.i386 +set fs_game q3ut4 +set dedicated 2 +set net_port 27960 +set com_hunkmegs 128 +exec server.cfg
echo "server crashed on `date`" > last_crash.txt
done

This script will automatically restart your game server should it crash. Useful also because a /RCON quit command will reset you server the old fashioned way.

11. You can now start you server by issuing the command:

sh start.sh

12. If you wish to run this as a screen, which you probably do, make sure you have the application screen (if not check their website for details on how to install it), issue the command:

screen -m -d -S UrT-Server sh start.sh

This will then run the server in the screen, and you will not shutdown your server when you terminate your shell.

You are finished, good job! Now go play.

2 Windows Server Install Guide

First of all you need to acquire the Urban Terror installer. You can download this form many mirrors listed on the main Urban Terror website. Once you have downloaded this file, install it as per the instructions along with the installer.

Once you have installed Urban Terror go to the Urban Terror directory. This is by default c:\Program Files\Urban Terror. You will then see a q3ut4 directory. Go into this folder and you should see a lot of files. One is called the server.cfg. Edit this file to the required settings (this is covered later in this manual).

To run your server go back to the Urban Terror directory where you saw the q3ut4 directory. You should see the file ioUrTded.exe, RIGHT click drag this to your desktop and create a shortcut.

Once you have your shortcut, right click on it and go to properties. Find the field called "target".

It should look like this:

C:\Program Files\UrbanTerror\ioUrTded.exe

Change it to:

C:\Program Files\UrbanTerror\ioUrTded.exe" +seta net_port <port> +exec <configname>
C:\Program Files\UrbanTerror\ioUrTded.exe" +seta net_port 27960 +exec server.cfg

Now you can click the shortcut and run the game!

3 Running ioUrbanTerror

Unzip the UrbanTerror installer. Edit the server.cfg and mapcycle.txt in the q3ut4 folder to your desired settings and start the server with the following arguments:

+exec server.cfg
For servers running Windows, you use ioUrTded.exe for servers running Linux use ioUrTded.i386.

4 Running Quake III Arena (& Punkbuster)

Install Quake III and Point Release 1.32. This also installs PB. Update Punkbuster with PBSetup. Install and unzip Urban Terror so that you have the /baseq3 folder, the quake3-executable and the q3ut4 folder together in the same folder. Edit the server.cfg and mapcycle.txt in q3ut4 to your desired settings and start the server with the following arguments:

+set fs_game q3ut4 +set dedicated 2 +exec server.cfg
For servers running Windows use quake3.exe, on Linux servers us q3ded.

5 Game Types

Bomb & Defuse (Bomb - gametype 8) The Red Team is the offensive team, who attempts to plant the bomb in one of two strategic locations denoted by the pulsating icon. The Blue Team defends the plant locations, either trying to kill the entire team or to defuse the bomb once it has been planted. The offensive team has the full round time limit to plant the bomb. Once the bomb has been planted, the round time will stop, which results the bomb timer starting its countdown to detonation, either exploding or be defused by the defending team.

Capture & Hold (C&H - gametype 6) Numerous flags or "capture" points are positioned around the level. When you occupy those points the flag changes to your team's color (red or blue). Every minute your team scores a point for each flag of your team's color. Your goal is to "hold" as many flags a possible at each scoring interval. If you get killed, you can respawn after a brief delay.

Capture the Flag (CTF - gametype 7) Each team has a home base which holds a flag. The team's goal is to get the flag from the enemy base and bring it back to their base. You must prevent the enemy from doing the same. If you are killed you must wait to respawn back into the game.

Free for All (FFA - gametype 0,) It is each gamer for themselves, in this fast paced game mode. After a preset number of minutes or frag count the round will end and the winner is the person with the greatest number of kills. If you are killed you will respawn at a random location on the map after a short delay.

Follow the Leader (FTL - gametype 5) At the beginning of each round the server selects one person on your team as the "Leader." The leader is designated by a red or blue helmet. A flag also spawns with your team. Your goal is to score as many points as you can. Only the leader can get points from touching the enemy flag. The round ends when a leader on either team touches an enemy flag, or either team is killed. If you are killed you cannot respawn until the end of a round.

Team Deathmatch (TDM - gametype 3) Your goal is to accrue kills for your team. After a preset number of minutes or total frags the round will end and the winning team is the one with the greatest number of kills. If you are killed you will respawn at a random map location after a short delay.

Team Survivor (TS - gametype 4) Your goal is to annihilate the opposing team. The round ends when all the members of one team are killed, the team left standing is awarded a point. If you are killed you cannot respawn until the next round. Depending on the server settings sudden death could apply.

6 Map Cycles

Map cycles in Urban Terror have been done to make configuring them easier. Instead of having strange commands in your server.cfg, Urban Terror loads maps and sets information from a simple text file.

By default, the map rotation file is called mapcycle.txt. This file must be placed in the q3ut4 folder of the server. You can change the name of the map cycle file by setting the g_mapcycle CVAR to the name of the alternate file. For example, to use a map rotation file called mymaps.txt, you'd go to the console and type:

/g_mapcycle " mymaps.txt"

The map rotation file is a basic text file (you can use MS Notepad, BBEdit, Word, etc to create it). In its most simple form, the file is just a list of maps, one map to a line. When the last map is finished, the first map in the file is loaded and the process repeats. So, for example, a mapcycle.txt that looks like this:

ut_ricochet
ut_swim
ut_uptown
Would load up ricochet, then swim, then uptown, and then restart.
You can also use the map rotation file to set any server CVAR. The format for
this is:
[mapname]
{
[cvar] [value]
[cvar] [value]
...
}

The [cvar] is the name of any Urban Terror server CVAR (eg: g_gametype) and the value is the value you want it set to. In the following example, the first example has been extended to set CVARs on ut_uptown:

ut_ricochet
ut_swim
ut_uptown
{
g_gametype 6
g_friendlyfire 1
g_maxteamkills 0
}

7 Autodownload

Auto-downloads only work on ioUrbanTerror clients of at least version 1.35urt (check your console to see the version), that have auto-download enabled (cl_autodownload 1). It works on any server.

The server sets a URL of the location of the maps using: sets sv_dlURL "mysite.com" (keep the URL as short as possible). When a client doesn't have a map that's being played, it will try to download it from that URL. For example, the map that is being played is ut4_example.bsp, the sv_dlURL is mysite.com and the client doesn't have the map. It will then try to download it from: http://mysite.com/q3ut4/ut4_example.pk3. So when your sv_dlURL is mysite.com, make sure the actual pk3's are in http://mysite.com/q3ut4/.

In 4.1, the default sv_dlURL is "urbanterror.net". There's a script running on urbanterror.net that will spread the downloads over multiple mirrors. Your client will need to be at least of version 1.35urt (supports redirects) and send a correct referrer (ioQ3://x.x.x.x) for the script to accept the request. Some security software blocks the referrer and you will get a 403 error. Turn off that 'security'.

B | Server CVARs

1 Urban Terror Specific CVARs

Server Name & Daily Settings

• set sv_hostname "" // Your server name here.
• set g_motd "" // Your message of the day here, it is displayed while connecting.
• set sv_joinmessage "" // Your join message here, it is displayed when the game is joined.

General Game Settings

• set sv_maxclients "12" // Max client slots available on the server, using more than 16 is not recommend. It can cause lag and most levels are not built for it (Default 12).

• set g_maxGameClients "0" // Max clients that can actually join the game. Other clients will be forced to spectator. (Default 0=all)

• set sv_privateClients "0" // Number of private slots. This number will be reserved for players who enter the right private password.

• set g_gametype "4" // 0=FreeForAll, 3=TeamDeathMatch, 4=Team Survivor, 5=Follow the Leader, 6=Capture and Hold, 7=Capture The Flag, 8=Bombmode. (Default 4)

• sets sv_dlURL "urbanterror.net" // Sets the address for auto-downloading.

Auto-download only works on ioUrbanTerror clients. The client will try to download <sv_dlURL>/q3ut4/mapname.pk3. So if your server is running ut4_coolmap and sv_dlURL is set to 'yoursite.com/maps', make sure the maps is hosted at http://www.yoursite.com/maps/q3ut4/ut4_coolmap.pk3. Leaving this set 'urbanterror.net' will make it use a map mirror with the most common maps on it. If you got your own hosting, please us that though, to save bandwidth.

Passwords

• set rconpassword "" // Password to control the server remotely using RCON.
• set sv_privatePassword "" // Password for private slots.
• set g_password "" // Password for the server. Nothing = public.

Limits & Times

• set timelimit "20" // Time in minutes before map is over, 0=never. (Default 20)
• set fraglimit "10" // Amount of points to be scored before map is over, 0=never. (Default 10)
• set capturelimit "0" // Amount of flagcaps before map is over, 0=never. (Default 0)
• set g_warmup "15" // Time in seconds before game starts when changed to a new map. This gives slower computers time to load before game starts. (Default 15)

Respawn (TDM,CAH, CTF)

• set g_respawnDelay "8" // Seconds before respawn, ignored when g_waverespawns is 1. (Default 8)
• set g_forcerespawn "20" // Seconds before respawn is forced, even when plater did not press fire. (Default 20)
• set g_waverespawns "0" // Use waverespawns, meaning everybody in a team respawns at the same time. (Default 0)
• set g_bluewave "15" // Seconds between blue wave respawns, ignored when g_waverespawns is 0. (Default 15)
• set g_redwave "15" // Seconds between red wave respawns, ignored when g_waverespawns is 0. (Default 15)
• set g_respawnProtection "2" // Amount of seconds a spawning players is protected from damage. (Default 2)

Rules

• set g_deadchat "1" // Determines if alive players can see dead players message. 0=living players can not see dead players chat 1=living players see only team-messages from dead teammembers 2=living players also see normal chats from dead players. (Default 1)

• set g_antiwarp "1" // Enable or disable antiwarp. This option smooths the movement of warping players (warping is caused by a poor connection, for instance downloading porn during playing). The warping player will experience stutters when this is enabled. (Default 1)

• set g_antiwarptol "50" // Tolerance of the antiwarp. Higher = more tolerant. (Default 50)
• set g_gear "0" // Bitmask that decides which votes are allowed and which not. Check Gears calculator to find the correct number.

• set g_allowvote "536871039" // Bitmask that decides which votes are allowed and which not. Check allowVote calculator to find the correct number.

• set g_failedvotetime "300" // Time in seconds before someone can call another vote after another has failed. (Default 300)

• set g_followstrict "1" // 1=no haunting of enemies when dead. (Default 1)
• set sv_floodprotect "1" // 1=stops clients from spamming many chat lines. (Default 1)

Matchmode

• set g_matchmode "0" // Matchmode is for matchplay. Features timeouts and ready-commands. (Default 0)
• set g_timeouts "3" // Amount of timeouts that a team can have per level. (Default 3)
• set g_timeoutlength "240" // Length of the timeout. (Default 240)
• set g_pauselength "0" // Length of a pause. This can only be done by RCON. 0=indefinitely (Default 0)

Team Game Settings

• set g_friendlyFire "1" // 0=no friendlyfire and 1=friendlyfire on, kick after too many TK's 2=friendlyfire on, no kicks. (Default 1)

• set g_maxteamkills "3" // Amount of team kills before you get kicked when friendlyfire is 1. (Default 3)
• set g_teamkillsforgettime "300" // Amount of seconds before team kills are forgotten. (Default 300)
• set g_teamautojoin "0" // Force players to auto join on connect, instead of letting them spectate until they join themselves. (Default 0)

• set g_teamForceBalance "1" // If on, you can't join a team when it has more players then the other. (Default 1)
• set g_maintainTeam "1" // When switching maps, players will stay in their team. (Default 1)
• set g_teamnamered "" // Name for the red team, nothing = Red Dragons.
• set g_teamnameblue "" // Name for the red team, nothing = SWAT.
• set g_swaproles "0" // When map is over, play it again with the teams swapped (recommended for bomb mode). After that, change map. 0=change map immediately when map is over, no swapping of teams. (Default 0)

Game Specific Settings

• set g_maxrounds "0" // Number of rounds before map is over, 0=never. (Default 0)
• set g_RoundTime "3" // Maximum minutes a round can take. (Default 3)
• set g_survivorrule "0" // 0=teams don't get a point when time is up before everyone is dead. 1=team with most players left gets point. (Default 0)

• set g_suddendeath "1" // When map is over and both teams have same amount of points, add another round. (Default 1)
• set g_bombdefusetime "10" // Number of seconds it takes to defuse bomb. (Default 10)
• set g_bombexplodetime "40" // Number of seconds before bomb detonates after planting. (Default 40)

CTF Specific Settings

• set g_flagreturntime "30" // If a flag is dropped, return it after this amount of seconds. (Default 30)
• set g_hotpotato "2" // When both flags are taken, they will explode after this many minutes. (Default 2)

Advanced Settings

• set sv_strictauth "0" // 1=check for valid CD key, this means ioUrbanTerror players will not be able to join. (Default 0)
• set sv_pure "1" // Don't let players load modified pk3-files. (Default 1)
• set sv_maxRate "0" // Maximum traffic per second the server will send per client. 25000 or 0 = max. (Default 0)
• set sv_timeout "180" // Time in seconds before player with a interrupted connection will be kicked. (Default 180)
• set g_inactivity "0" // Time in seconds before a non-moving player will be kicked. (Default 0)

Master Servers

• set sv_master1 "" // This one will be set automatically by the game-engine, so just leave it blank
• set sv_master2 "master.urbanterror.net"
• set sv_master3 "master2.urbanterror.net"
• set sv_master4 "master.quake3arena.com"
• set sv_master5 "" // Future master server.

Miscellaneous Settings

• set g_armbands "1" // Determines the behaviour of the armbandcolor (also shows on playerlist and minimap). 0=player's choice, set with cg_rgb 1=Based on teamcolor (red or blue) 2=assigned by server (random)

• set sv_maxping "0" // Max. ping a client may have when connecting to the server. (Default 0)
• set sv_minping "0" // Min. ping a client may have when connecting to the server. (Default 0)
• set g_allowchat "2" // 0=no chatting at all 1=teamchats only 2=all chats. (Default 2)
• set g_log "games.log" // Name of the logfile. Empty ("") means no log. Log will be in the q3ut4 folder in windows. Linux uses ~/.q3a/q3ut4. (Default games.log)

• set g_logsync "1" // Enables/disables direct writing to the log file instead of buffered. (Default 1)
• set g_loghits "0" // Log every single hit. Creates very big logs. (Default 0)
• set g_logroll "0" // Create new log every now and then, instead of always using the same one. (Default 0)
• set logfile "0" // Additional logging in separate qconsole.log file. 1=buffered, 2=synced. (Default 0)
• set g_cahtime "60" // Interval in seconds of awarding points for flags in Capture and Hold gamemode. (Default 60)

Map Rotation

• set g_mapcycle "mapcycle.txt" // Name of mapcycle file, located in q3ut4 directory. (Default mapcycle.txt)
• map ut4_casa // What map to start with. (Default ut4_casa)

Anti Cheat

• pb_sv_enable "1" // To enable PB (only works when using Quake III Arena, not ioUrbanTerror).
• set sv_battleye "0" // Keep this disabled, BattlEye is dead.

2 Gear Calculator

This simple program will allow you to calculate the figure needed when you want to restrict what weapons/gear (grenades) are used on a server. This server CVAR is g_gear and is set to zero, which is the default condition.

Please enable Javascript...

3 Allowvote Calculator

The Allowvote Calculator allows you to calculate the g_allowvote figure. By clicking on what can be voted on you will determine a unique figure that will be entered under the g_allowvote setting.

For example, if you wanted to let gamers vote on what map to play, cycle to the next map, kick a player and shuffle teams the figure would be '92' or set g_allowvote "92" in the server.cfg file.

Please enable Javascript...

Server CVARs can only be changed by people with access to a server. Generally, if you are playing in an online game your console commands will have no affect on the server settings. The only time you need to worry about server CVARs is if you are running a server. For a description of all the Quake III Arena CVARs see Command Keen's Quake 3 Console Page.

These are variables that are unique to Urban Terror. You can enable and disable them in the server.cfg file that came with Urban Terror.

C | Administration

1 Remote Control (RCON)

"RCON" is short for remote control; it allows you to make changes to the server and gives you access to administrative commands when you're connected to a remote server. To use the RCON, you first need to enter the password by typing:

/rconpassword [yourpassword]

After you have enter the RCON password you can access all the RCON capabilities, by typing:

/rcon [command]

RCON Commands

These commands allow individuals to remotely administer a server. Their use is based on having the RCON password. These commands are to be used in the console.

Kicking

There are two ways to do this. The first is to kick them using their player name:

/rcon kick [playername]

The second is to use their user number on the server:

/rcon status (this is to get a list of players and their user numbers)
/rcon clientkick [usernumber]

Restart Server

While you can't actually restart the server, you can reload the server.cfg, which amounts to about the same thing.

/rcon exec server.cfg

Ban an IP

The first thing that you have to do before banning anyone is to add this line to the server.cfg file:

set filterBan 1

Now you can add an IP to the ban list by typing at the console:

/rcon addIP [ip_address] (you can also use IP masks)

To remove an IP from the list:

/rcon removeIP [ip_address]

To list the IPs currently banned use the banlist.txt file.

2 Referees

Referees are a feature that has been added to help server admins manage their servers. The referee is like a less powerful version of RCON: you can set a password and give it out to trusted players. Unlike RCON, the referee has limited control over how they can affect the server. It gives them the ability to do things like mute annoying players, kick them and even ban them from the server for up to 3 hours. All referee commands start with the ref command. The basic referee command looks something like this:

ref {refcommand} [{parameters} ...]

Referee commands can only be used by a client who has logged on as a referee using the reflogin command with a valid password. If a password has not been set, or if the server has disabled the referee function, no one will be able to login as a referee.

Enabling Referees

To enable a referee, a server admin first needs to set the referee password:

/g_refpass "password"

Then set whether the referee can ban people:

• /g_refNoBan 0 (to give them ban power)
• /g_refNoBan 1 (to stop them from banning players)

Finally enable referees:

/g_referee 1

Be very careful with allowing referees to ban players on your server, unless you can trust them to use the power responsibly. Otherwise, you might find angry players boycotting your server!

Log on as Referee

To login as a referee you need to ask the server administrator for the referee password. Once you have it, you can login by pulling down the Quake III console and typing:

/reflogin "password"

If you enter the password correctly and the server is set up to allow referees, then you will receive a message telling you that you have successfully logged in. Once logged in you can use all the referee commands. These commands and their effects are listed below.

Referee commands

Command [1]	Usage[2]	Description[3]
Kick	ref kick player [reason]	Kicks a player from the server but does not ban them. You can enter either a player name or a client number (use the status command to see client numbers), so you can either do: /ref kick playername or /ref kick 5. You can also give an optional reason that the player was banned.
Mute	ref mute player seconds	Mutes a player for some number of seconds. Useful to shut up trolls. The player can be either a player name or a client number.
Forceteam	blue\|spectator\|free	Forces a player onto a team or into spectator mode. The player can be either a player name or a client number. Use "free" as the team name to ask the server to place them onto the team with the least players.
Ban	ref ban player minutes	Bans a player from the server. After using this on a player, the player cannot rejoin the server for a specified number of minutes. The player can be either a player name or a client number. Using this command, a referee can ban a player for up to 3 hours (180 minutes).
Resign	ref resign	Use this to make yourself a normal player again. You are also automatically stripped of your referee rights if you disconnect from the server.
Help	ref help	Prints out brief information about ref commands and what they do.

3 Server Bots

These are programs that run on a server in order to provide additional features not provided by Urban Terror. Bots can be used for administration, statistical parsing of game logs and to advertise your server(s). While this manual will not provide detailed information for downloading and installing these third party applications, you can find a list of them below:

• (NG) Urt0 Bot
• Bigbrother (B3) Bot