1.0.0 - BACKGROUND INFORMATION
4.1.0 - Key Bindings
4.1.1 - Any new keys that I need to bind?
4.1.2 - Key/Command Chart
4.2.0 - Client CVARs
4.2.1 - Changing the color of the crosshairs
4.2.2 - Add sub section here
4.2.3 - Add sub section here
4.2.4 - Add sub section here
4.3.0 - Configuration Files
4.3.1 - What are configuration files?
4.3.2 - How are configuration files started?
4.3.3 - Could you explain these config files?
4.3.4 - Creating adn autoexec.cfg file
4.3.5 - How to modify the autoexec.cfg
4.3.6 - How come my autoexec isn't working?
4.3.7 -I get an error and my script doesn't work
4.3.8 - Where can I find more info on scripts?
4.4.0 - User Interface
4.4.1 - User interface
4.4.2 - The starting interface (out of game)
4.4.3 - The in-game interface
4.4.4 - Joining a team and selecting your gear.
4.4.5 - Choosing your player model and skin
4.4.6 - The player models/skins
4.4.7 - The heads up display (HUD)
4.4.8 - Visible weapon switching interface
4.4.9 - The radio interface
4.4.10 - Keeping score
4.4.11 - The mini-map
4.4.12 - How do I use cg_maptoggle?
4.5.0 - Specific Commands
4.5.1 - Stop myself from bleeding to death
4.5.2 - Healing your teammates
4.5.3 - Ability to grab and climb ledges
4.5.4 - How do I turn items off?
4.5.5 - How do I open doors?
4.5.6 - Using the alternate fire key
4.5.7 - Assigning the string variables
4.5.8 - Breakout key assignments
4.5.9 - Snake key assignments
4.0.0 - CONTROLS & USER INTERFACE
4.1.0 - Key Bindings
Urban Terror requires you bind quite a few keys that are non standard to Quake 3 Arena. As mentioned in Section 3.0.0, there are about five keys required to play. If you would like to take more time to set up your keys for movement, weapons, special use keys and radio commands, then go through Section 4.0.0.
4.1.1 - Are there any new keys that I need to bind for Urban Terror?
There are quite a few new options and controls to configure for Urban Terror. You have two methods of setting your controls, in-game and in your configuration file (config or .cfg file). Controls can be modified before entering a game by clicking SETUP->CONTROLS. Alternatively, if you are in game and wish to change controls, simply hit the ESCAPE key and click the CONTROLS option that appears. Another method, for advanced users only, is to pull down the Quake3 console (usually with the tilde key), and type in the command at the console prompt. For example, type /bind x ut_radio 1 1 (x being any key you choose and with spaces between the 1 and the 1.
The following section will list the controls, the default keyboard/mouse mapping, a description and the Quake III command for each key.
4.1.2 - Key/Command Chart
4.2.0 - Client CVARs
Urban Terror also implements new client variables, known as CVARs. These are variables, that you can change from their default setting. The CVARs listed in our manual are the ones that are Urban Terror specific or related.
4.2.1 - Client CVAR Chart
Client cvars can be changed by anyone, but they only affect what happens on your computer - you cannot affect what other people see or hear by changing client cvars. To change a cvar, go to the console (press the ~ key) and type a slash (/) followed by the name of the cvar, followed by the value you want to set it to. For example: /cg_maxFragments 16. This cvar would set the cg_maxFragments cvar to "16". You can enter the name of the cvar without a value to see what it is presently set to.
4.2.1 - Changing the color of the crosshairs
Urban Terror Crosshair Color Chart
Use this color chart for the following cvars:
\cg_crosshairRGB
\cg_crosshairFriendRGB
\cg_scopeRGB
\cg_scopeFriendRGB
Values with a decimal, for example, "1 .5 .5 1" will need to have a preceeding zero included in order to work. So in the example, "1 0.5 0.5 1" would be the correct value to have light red.
Order of values: "Red Green Blue Alpha"
Red - Value of Red (Range: 0-1)
Green - Value of Green (Range: 0-1)
Blue - Value of Blue (Range: 0-1)
Alpha - Value of Alpha (Range: 0-1) [1 is opaque, 0 is transparent]
Example:
\cg_crosshairRGB "1 1 1 1" - This would set the color of the crosshairs to white.
\cg_crosshairRGB "1 0.5 1 1" - This would set the color of the crosshairs to a light pink.
You cannot set the crosshairs in order to identify enemies, only teammates.
To find the x-hair color thats right for you grab any graphic's application that use's a standard RGB pallet, and find some thing that you like in its color picker, which should list values like so roughly:
Red: 34
Green: 128
Blue: 243
Hehe what that color is I haven't the slightest off hand. Now take and divide those values by 255.
34 / 255 = 0.13+
128 / 255 = 0.5+
243 / 255 = 0.95+
Now since the x-hair color cvars values are in this order Red,Green,Blue,Alpha we would then use the above values like so:
set cg_crosshairRGB 0.13,0.5,0.95,1
Or if you only want it some what visable:
set cg_crosshairRGB 0.13,0.5,0.95,0.6
4.3.0 - Configuration Files
4.3.1 - What are configuration files?
Configuration or config files are text files with the file extension of ".cfg" rather than the standard ".txt". These are used to store binds, cvar values, and cvar stings (scripts) that allow you to move about and interact with the game world that is Urban Terror.
Most experinced gamers will create their own personal configuration files, with or with out scripts included just so the game is tweaked so that they can better interact with the game. These range from tweaking the network settings so that the connection to the server is always smooth as sild, or its to pull a few more FPS out of thier system, or just to have all the keys where they want them.
In order to aid you in setting up your first config file, we recommend you download and save this sample.cfg (right-click and SAVE AS). This file was created by Nologic over at UT Scripts and is an excellent starting point. Each section is commented, such as "Movement", "Weapons" & "Radio" as well as a section dealing with cvar values. This should help you out when trying to find your own perfect setup.
4.3.2 - How are Configuration files started?
When Quake III Arena starts it automatically executes three config files by default. First off the default.cfg is executed and will create a q3config.cfg if one isn't already present, next is the q3config.cfg if its present, lastly is the autoexec.cfg if its present. Each one over writes the priors ones values and binds upon exectution.
4.3.3 - Could you explain these config files?
The default.cfg is stored in one of the main pk3 files of the host game, and provides basic binds and cvar values, and will create a q3config.cfg if currently there isn't one present. This file can not and should not be edited.
The q3config.cfg is created or over written each time the game is exited correctly. Should the game exit incorrectly because of a crash or simply executing the command "quit" in the console, the then current values and binds will not be written to the q3config.cfg. This so that the game may recover from the crash by using the last known working values and binds. Also any changes you make in the SETUP->CONTROLS will be reflected in this file. This file should not be edited, and it should not be write protected.
The autoexec.cfg is where all customization should be done. This over writes all values and binds set by the prior two config files, and allows for the execution of many more sub config files should the need arise, this can also be used to store scripts. This file can and should be edited. :)
4.3.4 - Creating an autoexec.cfg config fil
If you don't have an autoexec.cfg file you may create one, just by right clicking in the q3ut3 directory and selecting "New" from the right click menu, move down to and click "Text Document", now name it "autoexec" and change its file extension to ".cfg" rather than its current ".txt".
If you can not see its file extension select "Tools" from the menu bar, then select "Folder Options" from the drop down menu, then select the "View" tab. Now here you be presented with a number of options in the "Advanced settings" tree view. Unmark the following:
Hide file extensions for known file types - Unmark this one
Now click the "Apply" button. Now you are all set to rename text file's ".txt" to config file's ".cfg".
4.3.5 - How to Modify the autoexec.cfg
To modify your autoexec.cfg file, open the .cfg file with Notepad or any other text editor and modify as necessary. Once you have have finished save the file to your q3ut3 folder. I recommend using QBind, as it is a text editor designed for scirpts with a few nice little features. You can find it at the below URL:
www.planetquake.com/clandestyne/qbind.asp
4.3.6 - How come my autoexec.cfg isn't working?
Normally the autoexec.cfg will execute with out a hitch, but there are times when it can fail. Normally this is because of heavy fragmenation of the hard drive, so first try defragging your drive (if any thing it can't hurt).
If the autoexec.cfg file still doesn't execute, you may right click on your shortcut for Urban Terror Beta 3.1, and click on "Properties" from the menu, then on the "Shortcut" tab in the "Target:" field the command line should contain:
"C:\Program Files\Quake III Arena\quake3.exe" +set fs_game q3ut3
Now add the following to that line:
+exec autoexec.cfg
Your command line should now read -
"C:\Program Files\Quake III Arena\quake3.exe" +set fs_game q3ut3 +exec autoexec.cfg
Should it STILL not execute correctly, drop down the command console by hitting the tidle key "~" this is normally the one right above the TAB key. Once the console has been dropped enter the following at the command prompt:
/bind x "exec autoexec.cfg"
With "x" being your preferred key, normally out of the way of your normal binds. I also recomend that the above bind be placed in your autoexec.cfg
You can also just enter the following into the console should the bind not work:
/exec autoexec.cfg
How ever ether of the above two methods will require you repeat it every time you start the game.
SHOULD IT STILL NOT EXECUTE...hehe shoot your computer...just kidding...frankly I have no idea...and I guess God just doesn't want you to script. ;)
Actually read the next subject that may provid the answer you are needing.
4.3.7 - I get an error and my script doesn't work?
There are two main errors that can happen..both of which I'm drawing a blank on the actual error messages. One deals with to many charters, in other words the script is to big. All scripts should stay under 16KB in size, to solve this problem break the script or scripts into smaller files, that can be then executed from the autoexec.cfg, simply add lines like the following to your autoexec.cfg (with FileName being the name of your files):
exec FileName_1.cfg
exec FileName_2.cfg
Also if you get into using a lot of sub scripts its advised to create a folder in which to store them, to keep your game directory fairly tidy. This can be done by creating a new folder by the name "cfg" in your q3ut3 folder, it doesn't need to be called "cfg" but it works for our purpose. Now place all your sub scripts into this folder, the autoexec.cfg should NOT be placed in this folder by any means. Now in your autoexec.cfg which should still be in your q3ut3 folder add lines that look like so:
exec cfg\FileName_1.cfg
exec cfg\FileName_2.cfg
The other is triggered when you have to many cvar strings active (ie to many scripts) this pops up with some thing like "insert text over flow" the only way to solve this issue is to start hacking away at what you really don't need in your scripts...there are some ways around this with some creative scripting but thats beyond the scope of this manual.
4.3.8 - Where can I find more information on scripting
If you would like to learn more about modifying your config file, we highly recommend UT Scripts. This site provides many excellent binds and scripts to help you play Urban Terror.
Other helpful links:
Commander Keen's - http://www.planetquake.com/q3console
I.am/Q3A - http://q3a.gamehelp.com/
Quake 4 Dummies - http://www.kan.org/michael/Quake
SAS's Guide to Quake3:Arena - http://guides.barrysworld.com/quake3
UPSET CHAPS - http://ucguides.savagehelp.com/
the bind arena - http://www.planetquake.com/thebind
4.4.0 - User Interface
4.4.1 - User Interface Defined
The user interface (UI) of Urban Terror has been completely redone and scripted from scratch. Using technology from id Software's latest Quake 3 Team Arena release, we have been able to create some great effects and add many more menus that were not even in Team Arena. The UI is divided into two sections, out of game menus and in game menus. Both can be used to change controls, system settings, player settings, and other applicable settings. In the next few subsaections you will find images of what these sections look like and what each button does.
4.4.2 - The starting interface (out of game)
Below is an image of the starting interface, with descriptions.
To connect to an online game (1), click "Play Online." The setup menu (2) will allow you to change your player and keyboard configurations, along with changing values for your video and audio settings. To start a server (3), you can manually set it up through the user interface. "Other Mods" (4) displays other Quake 3 mods that are installed on your computer. Urban Terror is reflected in this menu. To view "Demos" (5) that have been previously saved, click here. If you would like to quit out of the mod and Quake 3, click "Quit" (6).
4.4.3 - The in-game interface
Below is an image of the in-game interface, with descriptions. You can reach the in-game interface by pressing the ESCAPE key while in a game. Once displayed, you have game options you can change as designated by the red numbers in the figure below.
Listed in the image above are ten menus you can access within the user interface. (1) About: Tells you infromation about the server you are currently on. (2) Player: You can join a team ,select your preferred weapons / gear here, or change your player appearance. (3) Add Bot: Allows you to add bots to single player games. (4) Controls: This is where you set your binds and control related options. (5) System: Graphical system settings can be adjusted in this menu. (7) Vote: Used to call a vote, change game type, alter server settings or switch maps. (8) Rcon: Allows admins and players with rcon password to take control of the server. (10) Exit: Let's you quit out of the mod.
4.4.4 - Joining a team and selecting your gear.
When you first join a game, a set of interface elements is brought up that allow you to choose your team and weapons/gear. This can be accessed later while playing, to change teams or weapons, but comes up also upon joining a server for your convenience. These menus can be navigated with both key presses and by pressing the number hot key that appears in the same box as the button you wish to activate. To gain access to these menus again, you can either bind a keys to the team select and gear select menus, or you can hit ESCAPE to bring up the in game interface, then press PLAYER and finally choose either TEAM SELECT or WEAPON / GEAR SELECT. Below are two images to show you what this looks like. (Important note: you are limited to what you can carry in a few ways, if an item slot has a circle with a slash icon in it and says, "not available" you have reached your current weapon / item limit. To carry more items you must drop your grenades, secondary item or both.)
Choose TEAM SELECT or WEAPON / GEAR SELECT. Below are two images to show you what this looks like. (Important note: you are limited to what you can carry in a few ways, if an item slot has circle with a slash icon in it and says "not available" you have reached your current weapon / item limit. To carry more items you must drop your grenades, secondary item or both.)
Team Select Image:
Choose TEAM SELECT in ordr to change your status as a player. You have three options available to you when you enter this menu, as listed above in red. (1) Team selection, you can manually select the 'Red Team' or 'Blue Team', (2) 'Auto-Join' will automatically place you on a team, based on the number of gamers currently playing and the score. It is recommended you use this option when connecting. (3) If you want to drop off either team, then select 'Spectate.' If this is selected, you are still taking one player slot on the server.
Gear Selection Image:
Choose WEAPONS/ITEMS menu in order to load out your player with weapons and gear. Your primary (1) and secondary (2) weapons are your main weapons. Click on each of these to select your weapons of choice. You must carry a sidearm (3) and have two pistols to select from. Depending on your load out, you can choose grenades (4). You can also carry up to three pieces of gear (5, 6, 7) depending on weapon selection and grenades. See Section 6.0.0 - Gear for a more detailed explanation of loading out your player..
4.4.5 - Choosing your player model and skin
You can choose your player model both in game and out of game. To choose your model from the starting interface, press the SETUP button, followed by the PLAYER button. To set up your player in game, press ESCAPE to activate the in game interface, and then press PLAYER, followed by PLAYER SETUP. Both methods will show you a visual model of how your character will look in game. To change models, scroll through the head icons and click to select your choice. Your model will change to reflect your choice. Below are two image examples of these menus.
From this in game menu (player setup) you can set your 'Name' and 'model' depending on what level is being played. Once you have set this information, click 'Accpet' to save it and continue on.
4.4.6 - The player models/skins
Our player modelers and skinners have produced some really great looking models and skins for you to choose from. Below are the skins [teams] that are available for use in Urban Terror. The teams are now designated by a number, in order for level designers to designate what skins they want used on their level. The numbers in parenthesis are the skin numbers.You can only choose race and gender because the skins are set by the mapper via a set file included with the map:
RED TEAM SKINS
RED SKIN (0)
BLUE TEAM SKINS
BLUE SKIN (0)
RED SKIN (1)
BLUE SKIN (1)
RED SKIN (2)
BLUE SKIN (2)
RED SKIN (3)
BLUE SKIN (3)
4.4.7 - The heads Up Display (HUD)
The HUD for Urban Terror contains familiar elements such as ammunition and some unfamiliar elements such as the stamina bar. Learning how the HUD operates is vital to playing well in Urban Terror. Below is an image that describes the various parts of the HUD.
The HUD is configurable to some degree. You have the option to toggle some of the individual elements on/off or to reposition them on the HUD. (1) is your minimap, which displays teammate positions, medics, captured flags and call for help. More information is provided on the minimap in Section 4.4.11. (2) is a combination hit detection model and stamina bar. The stamina bar is discussed below. (3) is called the team overlay (cg_teamoverlay 1), it provides kill/deaths of each teammate, along with the number of enemies remaining. (4) shows your current weapon, number of rounds and magazines remaining. (5) consists of your mini scoreboard (configured in the menu) and your FPS/ping. (6) is the wave respawn timer, shows the time remaining until gamers on each team respawn. (7) shows the player's name and their health when your crosshairs are moved over them. The green bar represents health, when injured the green bar turns red to show that a player has been injured.
Here is an example of how the stamina bar works graphically:
4.4.8 - Visible weapon switching interface
Urban Terror features a unique system of icons that are displayed when switching weapons or items. A list box is displayed that presents easily identifiable items, along with the ability to see what you are currently carrying at a glance. Below is an example image of how this looks in game.
The two primary features in the above image shows a player's current inventory. You can see a bar of icons (1) that represent each piece of gear or a weapon in the player's inventory. The player above has the HK G36 selected and is scrolling through their inventory. (2) is the icon that appears when you select the bomb from your inventory (available only in Bomb/Defuse mode). Once the bomb is selected, you cannot carry a weapon, it must be shouldered, in order to arm and plant the bomb.
4.4.9 - The radio interface
In Urban Terror, radio communication accommodates both advanced and new users with ease. Depending on your personal preference you can either use the in game radio interface, or you can bind specific radio commands to keys like other actions. Most users will bind the most commonly used radio commands to keys, while using the radio interface for less commonly used keys. Below are two screenshots, with information below that on how the system works.
The first screen appears (1) when you press the key that you bound to open the radio menu. You have a selection of choices of subsections of radio messages: Responses, Orders, Statements and General. Press a number key, or click the section you want with your mouse.
The second screen opens after you press a number key or make a selection. Here is where the actual radio commands are located. This menu operates identical to (1) where both number key presses and mouse clicks play the radio command.
Radio messages can STILL be played through key bindings in .cfg files or in the console. To bind a key to play a specific message, use this example:
/bind x ut_radio y z
Where x equals the key you press to play the sound, y equals the subsection number of the radio command and z equals the sound file within that subsection. The subsections and radio commands both start with the number 1 and end with the number 9. The first subsection in screen 1 is "Responses", so the subsection number for a radio command within responses would be 1. This also means that inside the subsection "Responses" the same rules apply. The first sound is "Affirmative", so that sound is designated 1.
So if we wanted to bind a key to play the sound in the example screenshots, Responses > Reporting for duty, we would type the following in the console:
/bind x ut_radio 1 5
Remember, x still equals the key you want bound and that you need a space between ut_radio and the first number - along with a second space between the first and second numbers. Also, there are different radio messages for males and females. The meaning behind the messages is the same for both male and female, but the female voice will often say different things. A full listing of the radio commands for:
4.4.10 - Keeping score
The Urban Terror scoreboard is not only readable at a glance, but provides important information such as status, player name, kills, deaths, ping and time. You can access the scoreboard by binding a key to "+scores" without the quotes. The default key to show scores is TAB. Below is an image of the scoreboard.
There are two componants to the Urban Terror scoreboard. The team header (1) shows which team (red or blue) the players are on, along with total players on that team, the team name (currently showing Blue Team) and the team score. (2) Underneath the team header are the individual players who make up that particular team. Details include status, player name, kills, deaths, time and ping.
>4.4.11 - The mini-map
The mini-map is an overhead depiction of the level that is being played on the HUD. It will show a basic layout of the level, including hallways, teammates and flag position (CTF only). The mini-map is very configurable, as there are five CVARs that control the look and position of the mini-map during play.
The mini-map can be moved in a counter-clockwise direction around the screen, depending on where you want the placement of it. Along with changing the transparancy of the map arrows and the mini-map, you can also change the size of the mini-map or toggle the mini-map on and off.
The minimap can be used in both, team and free for all games. If used in a team play mode, like CTF or TS, then you will be able to see all your teammates who are alive. In CTF, you will also see the current positions of the maps. In free for all games, all the player triangles are represented in yellow.
In the first pane, you are on the blue team, as you can see your blue teammates, on the map ut_docks, with the red flag near the water. Pane two, shows a blue gamer who has grabbed the red flag and is making their way back to the blue flag. Finally, in pane three, we see a free for all game, as only a single, yellow triangle is represented.
4.1.12 - How do I use cg_maptoggle?
You can use this command in a script form or a straight bind. To bind it in a single command line drop into the console and type:
\bind [key] "toggle cg_mapToggle"
If you want to use it in a script and get a bit fancy you can cut and paste this into your config file:
In ths script, you can replace the 'x' key with whatever key you want to bind it to. Also note that you cannot bind any of the cg_map commands in the setup menu, they must be configured manually in your config.
4.5.0 - Specific Commands
4.5.1 - How do I stop myself from bleeding to death?
If you get shot, you start to bleed. The location in which you were hit and the number of times you were hit determines the amount of health you lose each second. To stop yourself from bleeding, you need to bandage your wounds. You can bandage wounds in two ways: you can bandage yourself with the bandage command [most people will set up a key to bandage using the CONTROLS-> SPECIAL menu]. The second way to bandage is to have a teammate bandage you.
4.5.2 - Healing your teammates
In order to promote teamwork, it is possible to act as a medic and heal your teammate when their health drops to near fatal levels. To perform the healing, walk up to your injured teammate and walk forward. While doing this, press the your bandage key and the player will rejuvenate health, back to 40% without the medkit and 80% with the medkit.
In the example above, Oswald is calling for a medic, while on the mini-map his player trangle is flashing red, allowing team medics to see his location on the mini-map, in order to heal him. The other visual reference, is the caduceus medical symbol that will pulsate above an injured gamer's head when they call for a medic.
4.5.3 - Ability to grab and climb ledges
Ledge grabbing adds a new dimension to first person gaming. This feature allows a player to run, jump, and grab the ledge of any structure [for example, a building or crate] within an Urban Terror map. To perform the ledge grabbing maneuver run towards a structure and jump for the ledge. If you reach the edge of the structure, keep the jump key depressed and you will pull yourself up. The only limitation is, you must be able to reach the ledge, if not you will fall, injuring yourself or worse yet, kill yourself.
4.5.4 - How do I turn items on/off?
It's hard to ambush people if your laser sight is shining on a wall and giving you away. You can turn off the night vision goggles [NVGs] and the laser sight in Urban Terror by pressing the use item key. This key is bound in the SETUP->CONTROLS->MISCELLANEOUS menu, and can also be set in the console [press tilde [~] to get into the console] by typing /bind [key] +button2. You must have the item you want to turn on/off in the FIRST slot of your gear inventory. If it is in the second or third position, then you will have to cycle through your gear to get to it, then activate it.
4.5.5 - How do I open doors?
You can control the direction the doors open in Urban Terror. Hold down the walk forward or backpedal key when you press the 'ut_opendoor key'. It takes some coordination and practice to master, but will stop players from camping in front of doors and holding them closed.
4.5.6 - Using the alternate fire key
Many of the weapons come with a few different firing modes, such as semi-automatic, full-automatic and burst mode. There are times when it will work to your advantage to use each different mode. Remember to bind it in the menu. For weapon specific information See Section 5.0.0.
4.5.7 - Assigning the string variables
Gamers are able to give more information to their teammates by using the string variables that are included in Beta 2.6. There are nine variables that can be included in any "say" statement. This information will be transmitted if you have it bound. The string variables include:
An example of using the variables could be:
\bind 2 say "I have the $gameitem!!"
The result on screen would look like, "I have the flag!!" The examples are endless, be creative, you can also combine them with radio calls to create your own unique commands. So you could combine $location, $health and $gameitem to let your teammates know where you are, your current health and that you have the flag.
4.5.8 - Breakout key assignments
What's the best way to kill time while waiting to respawn? To play Breakout, what else?
\breakout_play
\breakout_reset
\breakout_pause
\breakout_left
\breakout_right
4.5.9 - Snake key assignments
What's the next best way to kill time while waiting to respawn? To play Snake, what else?
\snake_up
\snake_down
\snake_left
\snake_right
\snake_pause
\snake_play
\snake_reset