
     UTCOMP3 v3 readme.

	1. QUICK OVERVIEW.

Utcomp adds much useful game features and customization options into original UT3 gameplay.
Based on sources code of CustomUTv1b.
Short list of UTComp features you can see below:

   -Brightskins
   -Configurable teammate/enemy models
   -Hitsounds
   -Custom crosshairs
   -Advanced voting system
   -Custom player names
   -Client side demorec
   -Ping correction
   -Coach spectator
   -Lots of advanced settings and GUI improvements

	2 COMPATIBILITY:
Software requirements:
  - Platform: PC Unreal Tournament 3.
  - Server: UT3 linux or windows server v1.3 or higher.
  - UT3 client: v1.3 or higher is strongly recommended.


	3. ADVANCED FEATURES OVERVIEW.
 3.1 Ping correction:
A ping correction can be enabled on server trough commandline or bEnablePingCorrection=true in ini.
Every player can disable it for own weapon, uncheck 'enable ping correction' checkbox in menu.
If you usually don't have ping less some value on any server and you wont play like with this ping,
you can set 'MinDesiredPing' editbox in menu. For instance, you set mindesiredping=40 and connect to server vith ping 120 and with enabled pingcorrection,
you will play like with ping 40. If you set  mindesiredping=120 and your ping equal 60, pingcorrection will be disabled for you.
Too high ping correction can cause some gameplay changes for other players, so it limited on server with 'MaxPingCorrection' setting.
Recommended values is 150 for public server, 80-100 for clanwar or more skillful matches.
If you connect to server with MaxPingCorrection=100 and have ping 250, you got overall playability like with ping 150.

 3.2 Pause voting: 
	 Pause voting have own vote passed percentage, by default is PauseVotingPercentRequired=49. 
It mean, one player in duel or one full team in team gametype can set game pause. 
Also available admin console command "AdminPause" if pause voting blocked by server settings.
Autopause set pause after any player have disconnect during match(not in warmup), and before this playercount was equal 'maxplayers' setting, 
or two player in duel mode. 

 3.3 Advanced voting settings:

Check "Enable Advanced Options" checkbox to enable options. Initial values is copy of current game settings. 
  
	* Duel/TDM Mod - Check to set standart duel and tdm settings such as force respawn, no redeemer,
, no darkwalker, no invulnerability in TDM, and additionally no doubledamage, no berserk and no invisibility for duel. This options work only in duel and tdm game mode.
Equal bEnableDuelTDmMod=True in config settings. Now Duel/TDM Mod not remove berserk and invis from TDM game.

	* 100%TeamDamage - Check to set full team damage. Equal bEnableFullTeamDamage=True in config settings.

	* NoSpawnProtection - Check to set no spawn protection. Equal bEnableNoSpawnProtection=True in config settings.

	* Armor Stacking - This checkbox permit pickup armor if a player has full load of same type armor.
Equal bEnableArmorStacking=True in config settings.

	* WeponStay - If UNCHECKED, turn weapon stay off, if checked, do nothing.
Equal bAllowWeaponStay=True in config settings.

	* TimeLimit - no comments.
	* MaxPlayers - no comments.
	* Max Spectators - enabled in UTCOMP3 v3
	* UnlimitedTransloc - check it to add unlimited translocator charge.

 3.4 Client console commands:
	* Ready
	* Notready
	* ToggleReady
	* AdminReady
	* Voteyes
	* Voteno
	* AdminPause
	* TogglePingCorrection

 3.5 Crossahair factory:
	Hint: To get your custom crosshair config, copy/paste 'CustomCrosshairs' strings from other UTComp ini higher than v2b,
		and crosshair components indexes will fixed automatically.

 3.6 Demo dump to *bmp screenshots.
 	Currently is experimental feature. You can start or stop it with 'DumpDemoToScreens' console command. 
I use MaxSmoothedFrameRate=100 and MinSmoothedFrameRate=100 and demo dump proceeded very slow, but good and with stable fps.
You can try change 'DemoDumpSlomo' in ini to change dump speed. It not tested yet, and i try only with 800x600 shots size.

 3.7 Demo mask replacement list:
	%m – Map Name
	%GT – Game Type
	%P – Player
	%AP – All players
	%td – Date Time

 
	4. SERVERSIDE SETUP.
4.1  installation:
Unpack archive into "\My Documents\My Games\Unreal Tournament 3\UTGame\" under Windows or equivalent folder under Linux. 
To initialise UTComp on dedicated server add ?mutator=utcomp3v031.UTMutator_utcomp3v031 in server commandline.


4.2  Quick reference of server config variables:

All server config settings are located in [UTComp UTComp_ServerSettings] part of UTComp.ini.
This file with default settings you can find in DefaultUTComp.rar. Be carefully with replacing this file, 
if you use utcomp3 v3 or higher release earlier because this file can store common settings for other versions. 

[UTComp UTComp_ServerSettings]

	Global voting settings:
bEnableVoting=True			
bEnableColorskinsVoting=True
bEnableHitsoundsVoting=True
benablewarmupVoting=True
bEnableGametypeVoting=True
bEnableAdvancedVotingOptions=True
bEnablePauseVoting=True
bEnablePingCorrectionVoting=True
bEnableKickVoting=True
bEnableCurrentGameServerDemorecVoting=True

	advanced voting game settings:
bEnableDuelTDmMod=True
bAllowWeaponStay=True
bEnableNoSpawnProtection=False
bEnableArmorStacking=False
bEnableFullTeamDamage=False
bEnableUnlimitedTransloc=False

	internal voting settings: 
VotingPercentRequired=51.000000		Minimum  vote passed percentage
PauseVotingPercentRequired=49.000000	Minimum  pause voting passed percentage
VotingTimeLimit=30.000000		Voting time out


	Game types voting:			See chapter 4.3
VotingGametypes=... 			Examples of vote options

	UTcomp game settings:
bEnableColorskins=True			Allow players to use color skins and force model
bEnableCustomNames=True			Allow custom nicknames
MaxNameChanges=3			Maximum of allowed name changes
bAlwaysAllowWeaponPickup=False		Players can get full ammo load when touching weaponrespawn and weaponstay is enabled
bAnnounceMultiKills=True		Multikills will be broadcast announced
AnnouncerLevel=0			Minimal multikill will be announced: 0=DoubleKills, 1 = MultiKills, 2 = MegaKills, 3 = UltraKills, 4 = MonsterKills
EnableHitSoundsMode=1			0 = HS disabled, 1 = Line of sight 2 = Always
WarmupTime=150				Warmup time
warmuphealth=199			Warmup players health
bPauseOnPlayerDisconnect=False		The game will be paused if disconnect happened. It works in team gametypes and if both teams full. 
					Disabled by default
bEnableWarmup=True			Enable warmup

bEnablePingCorrection=False		Enable ping correction
MaxPingCorrection=120			If ping exceed this value, only this part of ping will be corrected.
					Recommended values is 150 for public server, 80-100 for clanwar.

bFixClientDemorecording=True		Allow recording utcomp's clientside demos.
ServerDemoMask="Demo-%AP-%GT-%m"	%ap = allplayers %gt = gametype %m = map. If server cmdline with ?demo="demoname" was used, this variable override this name.
bForceServerAutoDemorec=false		Force server autodemorec every game, equal ?demo="demoname" in server commandline. 


4.3
Serverside gametype voting setup.

Players can vote for a variable 'sets' of settings which should be specified in 'VotingGametypes' strings of UTComp.ini
You can use up to 10 strings of VotingGametypes.

Example: 
VotingGametypes=(GametypeClass="UTGameContent.UTVehicleCTFGame_Content",GameTypeName="Vehicle CTF",MapList=("vCTF"),ExtraOptions=)

GametypeClass="UTGameContent.UTVehicleCTFGame_Content"		-Gametype class name
GameTypeName="Vehicle CTF"					-Short name to display in a voting menu
MapList=("vCTF")						-Map prefix, instead of gametype prefix you can place here desired map list.
								   example: MapList=("DM-Deck","DM-Arsenal")
ExtraOptions=""							-Place here other game options which may be used in server command line, like ?MaxPlayer= , ?Mutator= etc.
							Please note: every settings here override same settings in command line and will be 
							used while not be overriden by next voting with this settings. Maximum length is 440 characters.
4.5
UTComp server commandline variables.

To more flexible server setup, utcomp have commandline variables which duplicate ini vars. You can use it in server cmdline or
with voting 'ExtraOptions' same as UT3 cmdline vars. It allow sets different settings for different gametypes.
Now awailable this switches:

    ?EnableBrightSkins= 	[0/1]
    ?EnableWarmup= 		[0/1]
    ?HitSoundsMode= 		[0/1/2]
    ?WarmupTime= 		[time]
    ?EnableDuelTDmMod= 		[0/1]
    ?AllowWeaponStay= 		[0/1]
    ?EnableNoSpawnProtection= 	[0/1]
    ?EnableArmorStacking= 	[0/1]
    ?EnableFullTeamDamage= 	[0/1]
    ?PauseOnPlayerDisconnect= 	[0/1]
    ?UnlimitedTransloc= 	[0/1]
    ?EnablePingCorrection=	[0/1]
    ?AnnounceMultiKills= 	[0/1]
    ?AlwaysAllowWeaponPickup=	[0/1]


	5.CREDITS:

    UTComp3 author - Evgeny 'faust' Teleshov. 

	Other mod and source code authors:	
    CustomUTv1b - Aaron "Lotus" Everitt.
    Overtime timer - Per-Erik Mahl aka evr3ka.
    Advanced Scoreboard code - ]HeLL[-Bagotios.

    Special thanks to |ufo|Amigos for beta-testing and help.

	Visit us on the web - www.utcomp.org.





