TTM 2003 v2.3
The Tournament Mod for Unreal Tournament 2003

Hi and thanks for downloading TTM v2.3 !

We hope you enjoy this newer more feature rich addition to the TTM series of mutators. This read me covers installing TTM v2.3 (copying files to correct directories etc) and also explains each and every feature that you can access in and out of game.

TABLE OF CONTENTS
  1. What's TTM?
  2. Install Preparation
  3. Installation
  4. TTM Features
  5. TTM In-Game Menu
  6. TTM Console Commands
  7. Teamsays
  8. Credits

1. What's TTM?

TTM 2003 is a competition mod for Unreal Tournament 2003. TTM 2003 is meant to be ultimate solution for competitive gamers and server admins maintaining servers for clanwars, leagues, ladders and other online and LAN tourneys.

TTM 2003 is adopted by world's largest competitive tournaments: ClanBase, Electronic Sports World Cup (ESWC), The Cyberathlete Professional League (CPL), World Cyber Games (WCG) and many other tournaments all over the world.

It runs on every 4th server in the world and is, probably, most frequently used cusom mutator for UT2003.

Short list of TTM's features:


2. Install Preparation

Before installing TTM, please ensure you have your UT2003 install updated with the 2225 patch, which you can download here:  

    http://www.fileplanet.com/files/110000/116278.shtml


3. Installation

The installation procedure is as follows :
  1. Download the file ttm2003v23.zip from TTM2003 downloads page (http://www.planetunreal.com/ttm/downloads.html).
  2. Unzip the files into their respective folders. There are 4 folders inside the zip file, simply copy the contents from these folders into their respective folders in your UT2003 install directory.
  3. Open your UT2003.ini file and under the [Engine.GameEngine] header add this line: ServerPackages=ttm2003v23
  4. Start an Instant Action and add TTM2003 v2.3 to the list of mutators, or join an online server with TTM v2.3 enabled and play the game. At any time during the game you can access the in-game TTM menu simply by pressing F7 or getting into the console (press: ~) and typing ‘menu’.


4. TTM Features

There are quite a number of features in TTM, but 3 of those require some specific explanations. Those are TTM's brightskins, TTM's hitsounds, TTM’s HUD/scoreboard and TTM's warmup feature. Other features are covered in "TTM In-Game Menu" section of this document.


4.1. BRIGHTSKINS

TTM’s "brightskins" is an option to color skins of players/bots in clear, distinguishable manner. It is done by adding some color on the original skin of the player/bot, thus not making it monochromatically one-colored, preserving lookout of original skin. It works with every model and skin there is.

This feature is server-side optional, off by default, and votable (this voting subject can be disabled by server admins). Even if this feature is enabled on the server, a player has to enable it in his/her personal preferences, using main menu (F7) -> player-side settings -> brightskins preferences.

There is another implementation of the brightskins concept, made by Epic Games as an addendum to patches 2225 onwards. These Epic brightskins allow a player who installs them to see his/her opponents/teammates in one of the predefined models with a highly visible red-colored or blue-colored skins. It requires downloading of some optional skinpack (30MB).

NOTE: It is important to mention that TTM's brightskins work well with Epic’s brightskins on the same server. If both are enabled on the same server, it’s all up to the player's decision to use either TTM’s or Epic’s brightskins.


4.2. HITSOUNDS

Another TTM-specific feature that needs detailed explanation is TTM’s hitsounds. Hitsounds are some ‘ding’ or ‘dong’ sounds that a player gets when he/she successfully hits his/her opponent (or teammate). Those hitsounds are also server-side optional, off by default, and votable (this voting subject can be disabled by server admins).

TTM has 3 server-side modes of hitsounds: disabled, enabled ‘line-of-sight’ and enabled ‘everywhere’.
There are 3 hitsound types available for you to choose from:
You can also select how loud you want those hitsounds to be (personal preferences) or disable’em altogether.


4.3. HUD & SCOREBOARD

Another TTM feature we need to cover briefly is TTM’s HUD and scoreboard. This is also server-side optional, off by default, and votable (this voting subject can be disabled by server admins). It is also configurable player-side when it's enabled on the server.

It works only for the following gametypes:

    - DeathMatch
    - Team DeathMatch
    - Capture the Flag
    - Double Domination
    - Bombing Run.

It adds a game clock to the HUD, the same the scoreboard has even without TTM. It shows how much time of the match left. In the scoreboard, TTM adds accuracy and pickup stats, that is detailed info for how good did you shoot thoughout the game and how many important pickups did you get.

See samples: On-screen clock, Accuracy stats.

4.4. WARMUP

TTM’s warmup feature is for the clan games or any other competitive games. It allows players to run around the level before the actual game start, shoot, pick up items and so on, though no scoring happens at that time. Warmup can be either time-limited (with configurable timelimit, see menu description) or time-unlimited (in that case warmup will go on until all players click "ready" in their menus (F7) or typed "ready" in the console).

To encourage "warming up" of shooting skills, server admin can enable "All-weapons warm-up" feature. It will give all palyers all weapons with full ammo on respawn and every successfull kill will result in resetting killer's health to 100 (to encourage shooting).

5. TTM In-Game Menu

Once in a game with TTM v2.3 enabled, press F7 on your keyboard to bring up the TTM menu. If F7 isn't working, typing 'menu' in console (press ~) will bring it up.

You are now presented with the root menu of options. See screenshot.
Options from top to bottom:
  1. Return to Game
  2. Votings
  3. Player-side settings
  4. Server-side Settings
  5. Show Server Info
  6. Set up IRC Reporting
  7. About TTM 2003
These options are explained below.


1. RETURN TO GAME

Does what it says, closes the menu and returns you to the game.


2. VOTINGS

This menu is used to start votings and to participate in votings that have been started by somebody else. If there is a voting in progress, you’ll hear a voting call sound and you'll see a message showing the current voting at the top left corner of your screen.

If there is no voting started, you can start a new voting by going into main menu -> votings and selecting there a subject for your voting. You get a list of possible voting subjects in this menu. Each of these options within this sub menu are 'voting', so for a server it will be placed in the voting list, and other human players can decided if they wish to use that feature, and once there are enough votes the server will make the change without an admin’s help.

If there is a voting in progress and TTM suggests you to participate in it, go to main menu (F7) and you’ll find a window with a description of the current voting subject and buttons ‘Yes’ and ‘No’ to cast your vote (see screenshot).

Voting can either ‘timeout’ (if there isn’t enough ‘Yes’ votes for it for a given amount of time), ‘pass’ or ‘fail’ (if there is too much ‘No’ votes).

NOTE: It is best if you restart the map after any of the changes that you can read about below.


RESTART Current Map
 This simply restarts the map again, with current settings.
CHANGE map Gives you a choice of maps of your selected game type, and when you have made your choice click on “CALL VOTE: (map name)”.

See screenshot.

NEW: The maps list is taken from the server, not from client. So player who starts voting sees only maps that are on server.

NEW: Server admin may configure defined map list to be propagated from server to client. In this case player starting map voting will see only maps from that defined list, not all maps that are on server. To do this server admin must edit server's .ini file and add following lines to ut2003.ini:
[ttm2003v23.TTM_MapList]
PropagateConfiguredMapList=true
Maps=MapName1
Maps=MapName2
ENABLE/DISABLE improvements of HUD & Scoreboard This enables an advanced HUD with more info like the game clock, and in the score board you get extra features like weapon accuracy and pikcup stats.
Please take a look onto section “HUD & scoreboard” of this document
ENABLE/DISABLE bright skins This toggles brightskins usage. When brightskins are enabled, everyone’s player model is a bit more visible.
Please take a look onto section “TTM’s brightskins” of this document.
CHANGE hitsounds mode Allows you to select “Disable hit sounds” (No hit sounds at all), “Line-of-sight hit sounds” (Hit sounds only if the person is in front of you), or “Hitsounds everywhere” (You get the hit sound no matter where you are).

Hit sounds are a little “tink” that you get whenever your shots hit an enemy player. It is helpful in telling you if your shots are hitting their mark.

NOTE: This is a server dependant setting, if the server admin has chosen to not allow hitsounds you cannot turn them on.
ENABLE/DISABLE adrenaline combos Goes into another submenu so you can select the adrenaline combos that players are allowed to use in the game. Combos you can alter are the standard game ones: Booster, Invisibility, Speed, and Berserk.
ENABLE/DISABLE double damage Does what it says.


NOTE 1: Any of the voting subjects can be forbidden by server admins. You’ll get a message about that if you’ll try to start voting on a forbidden subject.

NOTE 2: If a voting passes and you’re given advice to restart a level in order for changes to take effect, please do that. The best way to is then to start voting for map change/restart.


3. PLAYER-SIDE SETTINGS

See screenshot of player-side settings window.

Let's start with the settings directly available under the Player-side Settings menu. We'll examine the submenus afterwards.

3.1. Direct preferences

Turn off weapon shaking Normally when firing certain guns (most noticeable are the Assault Rifle), the entire game screen will shake. This feature turns it off/on.
Hidden weapon Select this to turn your view of your weapon on/off (hides your weapon).
Take after game screenshot After the game is finished and the score is displayed, a screen shot will be taken and the .bmp file will be placed in your UT2003/System directory.
Record demo in each match Switches on automatic demo recording, giving you a command line with settings. You can use the following switches:
    %t - current time,
    %d - current date,
    %n - player's name,
    %c - clantags extractor; is replaced with teams' tags (for example, RUS_vs_GER),
    %o - opponent(s) name,
    %m - map name.
The default demo filename mask is '(%d)-(%t)-%n-on-%m'.
Ignore server's enforcement of demorec Allows you to get rid of server-side enforcement of demorec in every match (see info below).
Track personal weapon stats This will track your accuracy and pickup stats through a match. It uses quite a bit of bandwidth so you may wish to keep it turned off. It can be enabled/disabled many times during one match.
Display personal weapon stats Toggles the displaying of personal stats in the scoreboard.
Default character Allows you to set one of several "default characters" for other players.
In-game menu key Option to change the TTM mutator menu key to your preference (default F7). Click the button, then press the key you wish to change the menu to.


3.2. Hitsounds preferences

Takes you to a submenu, which gives you a drop down list of volume selections for the hitsounds feature explained in the previous section. You can select “Off”, “Soft”, “Normal”, or “Loud”. You can also select there which hitsound you would like to get.


3.3. Brightskins preferences

Takes you to a submenu, giving you an option to turn on/off bright skins. Ticking the check box ‘Use TTM’s brighskins’ to “on” gives you the following options:

Teammates color The color of your teammates' brightskins.
Enemies color The color of your enemies' brightskins.
Define coloring on teammate/enemy basis If checked, you get the same colors for your opponents in every game you play, no matter if you’re on the Red team or in the Blue team. Otherwise you define colors for the Red team and for the Blue team.
Darken dead bodies If checked, dead bodies are getting instantly black, thus not distracting attention from still alive opponents. This option also disabled the green ghosting effects.
Team-colored HUD If checked, your HUD gets colored with your team’s brightskin color (works only if TTM’s HUD is enabled).
Team-colored spawn/xloc effects If checked, spawn and translocator visual effects are colored the same as the team's brightskin colors.


3.4. HUD and scoreboard preferences

Another submenu giving you the following options:

Short death messages This client side option is disabled by default. If you enable it the messages are shorter than standard. So for example, instead of "Caio's cranium was made extra crispy by Tizio's lightning gun" you will get something like "Caio | head-shot | Tizio".
Display spectators’ talks This is on/off to have spectators chat displayed in game.
Clock position Drop down box allowing you to choose where to place the game clock.
Crosshair Drop down box allowing you to choose what type of cross hair you like.

NOTE: TTM has more crosshairs than original UT2003 does, so it uses separate variable to store info about selected crosshair. That means that when you start TTM v2.3 for the first time, you’ll get default crosshair in it, no matter what was configured in UT. Please proceed to this menu to set it up to your taste.
Display scoreboard when dead Checking this just displays the game score board when you die letting you see what your current placing is.


4. SERVER-SIDE SETTINGS

The Server-side Settings submenu presents you with the following options :

Votings settings Fairly self-explanatory option. This simply allows you to control what players can and cannot vote on. Tick boxes or slider bars to alter settings.

By default voting expiration time is 40 seconds and you need 51% of ‘Yes’ votes for a vote to ‘pass’. We strongly recommend not to set voting expiration time less than 20 seconds.
Warm-up settings Lets you enable/disable the warm-up feature.
Also lets you give a time limit (using the slider bar) and to enable/disable giving all weapons to players during that warm-up period. If ‘All-weapon warmup’ is used, players will get all guns and 999 ammo for it at *every* respawn.
Combos enabling/disabling You the server admin can allow or not allow players to use certain adrenaline combos.
Auto demo recording You can make server record server-side demos for every match and make every player record player-side demos for every match here (see info about player-side setting for auto-demo rec).

NEW (v2.3): %n tag is now supported in server-side demo recording too.
Misc settings Gives you the option to turn on or off player side settings on the server. Refer to previous sections for a description of features, other than “Put [TTM] tag in the server’s name”. For example your server might be named “Bob’s UT2003 Server”, but once you tick this option it becomes “[TTMv2.3] Bob’s UT2003 Server”. This lets players searching in the server browser to see that your server is running the TTM mod at version 2.

NEW: "Enable lockdown" feature. If this checkbox is disabled, it makes linkgun and minigun not to affect targeted player's movement at all. NOTE: this checkbox doesn't switch UT2003's MinigunLockDownFactor and LinkLockDownFactor variables' values.



5. SHOW SERVER INFO

Simply goes into a list box giving a run down of all settings on the server you are playing on currently. Scroll down to see all of them.


6. SETUP IRC REPORTING

In v2.3 IRC-reporter is started only player-side, that is, the player/spectator who starts the IRC-reporter becomes a reporter.  His/her bandwith is spent on it (not much though), not the server's bandwith.

Settings list from top to bottom :

Bot name Use whatever name you want to be seen in the IRC room as the “user” in that room. Example, “BobsUT2003bot”.
IRC server place your IRC server name here. Often something like “irc.servername.com”.
IRC channel place the IRC channel name here. Usually something like #yourroom or similar.
Kills to report Option to let you choose between “All kills” or “Only significant kills”.
Report pickup of critical items Items that will be displayed by the bot are things like Shields, Redeemer, Keg of health, etc.
Red team name Put the red teams name here.
Blue team name Put the blue teams name here.
Report scores every Slider bar to allow a range of times to report scores in the IRC channel.
Colored reporting Will use colors to distinguish between things like kills and pickups, etc.
Report every match Will automatically start IRC reporter for every played match (until stopped from this dialog box)

Once you have filled in these settings, start the IRC Reporter bot by clicking on the button labeled "Start IRC reporting". This closes the menu and starts the IRC bot a configured. To stop the bot, bring up this very same menu, and click on the button labeled "Stop IRC reporting".

7. ABOUT TTM 2003

This takes you to a screen of information about the team that made TTM v2.3 for UT2003 (see section 6, 'Credits', below).

6. TTM Console Commands

bh <param> Short version of behindview <param> command.
bskin <params>
 Changes your brightskins settings. This command accepts several subcommands:
bskin 0|1 Toggles brightskins.
bskin <team> <color>
    <team> = team | enemy | red | blue
    <color> = red | blue | green | cyan | yellow | gold | violet | pink | white
 Set color of specified team
bskin forceteams 0|1 Force coloring on team/enemy basis.
bskin darkening 0|1 Darken dead players.
bskin hud 0|1 Color the HUD same as team.
bskin spawn 0|1 Color spawn and xloc effects same as team.
changeCrosshair Cycles through all crosshairs there are, step by step.
echo <message> Displays message for current player only (instead of say, which will display that message to all players).
hand 1|2 1 for showing weapon, 2 for hiding it
maskdemorec <mask> Starts recording demo whose filename is made from the mask (same way as in the auto-demorec).
menu Call’s TTM’s menu (bound to F7 by default)
no If there is voting on progress, you vote ‘no’ with this command
notready Makes you not ready (to start the match)
ready Makes you ready (to start the match)
setcrosshair <number> Sets crosshair *and* stores that setting in ttm2003.ini
setmouseX <value> For setting mouse sensitivity for X axis (can be used for advanced weapon binds)
setmouseY <value> Same for Y axis
setmouseXY <value1> <value2> Sensitivity for both axises in one command
showTTMstats Toggles displaying of TTM’s accuracy and pickup stats
speclist Displays list of spectators of this match
startreporter Starts IRC-reporter with configured settings
startvote <subject param> Starts a voting. Subject can be:
  1 for map switch (don't forget to mention map name);
   2 for server-side TTM's hud & scoreboard enhancements toggle;
   3 for TTM's brightskins toggle;
   5 for server-side hitsound mode;
   6 for combos enabling/disabling (use param; for example 0110 stands for Booster off, Invis on, Speed on and Berserk off);
  7 for map restart;
   8 for amp enable/disable.
stopreporter Stops irc-reporter
tmpsetcrosshair <number> Sets crosshair and *doesn't* store that setting in ttm2003.ini
yes If there is voting on progress, you vote ‘yes’ with this command
 


7. Teamsays

You can use TTM's special support for teamsays.
8. Credits

Those who coded for TTM (in order of appearence in the project): pakman, Volf, Nomad, 32_Pistoleta, TNSe, MrFrost, F@ust, Rork and Garfield.

Sounds by SchmaKK.

Lots of inspiration in brightskins area by DayWalk3r & OutZ.

Short death messages by Dest1ny.

This readme by Kodiak.

Big thanks to dr|clone and PolishFool for their efforts for promoting TTM on the scene. Big thanks to Garfield for forums / IRC support of TTM.

The TTM's team would like to thank Epic Games for making excellent games over years.

pakman would like to thank Epic Games' Joe "DrSin" Wilcox for a public support for TTM and help with some technical issues.

pakman also would like to thank his wife BabyDeath: for your help, support,valuable ideas and also for being my wife.