====================================================================================
ReadMe for BattleMOD V5
====================================================================================
Author:       Nico de Vries
Platform:     Unreal Tournament 3 Retail 1.01
Website:      www.onsrpg.com (BattleMOD forum can be used for feedback and requests)
Release date: December 2 2007
Version:      V5

====================================================================================
Installation
====================================================================================
Windows:

Store the .u file(s) in your ..\Unreal Tournament 3\UTGame\CookedPC\ directory.
Store the .ini file(s) in your ..\My Games\Unreal Tournament 3\UTGame\Config\ directory.

If you have multiple users in Windows make sure you use the proper My Games directory.

Linux:

Still awaiting Linux server to determine this.

REMARK: Due to a bug (which Epic promised they will patch) in UT3's autodownloading
logic I have been forced to remove the HUD enhancements (PPH etc.) for now. See also
http://utforums.epicgames.com/showthread.php?t=588343

REMARK: the .uc files contain sourcecode for those who are interested in that. They 
are not needed to use and run BattleMOD.

====================================================================================
Manual
====================================================================================
This mutator allows you to tune many aspects of UT3 like weapon switching speed, 
fire rate of weapons, walking speed, extra starting health, health regeneration, 
extra high jumping, dodge jumping, max ammo, ammo regeneration and 
starting the game with all weapons.

Everything is fully configurable so you can choose which settings you want to use.

Every setting has been tested to work with dedicated servers.

A multiplier setting of 1.0 means 100% normal speed. A setting of 0.5 means 50% 
of normal speed. A setting of 2.0 means 200% of normal speed. Etc. A 0.0 
multiplier is not a valid value and will automatically be replaced.

The following settings are available (also see BattleMOD.INI):
  CfgGameSpeedMultiplier          Total gamespeed (same as Speed Freak mutator).
  CfgWeaponSwitchSpeedMultiplier  Weapon switching speed.
  CfgWeaponSpeedMultiplier        Fire rate of weapons.
  CfgWalkingSpeedMultiplier       Walking speed.
  CfgHealthMultiplier             Extra starting health.
  CfgJumpMultiplier               Extra high jumping.
  CfgbMaxAmmo                     Weapons start with max ammo.
  CfgbAllWeapons			      Players start with all weapons (except the redeemer).
  CfgHealthRegenPerSecond         Players health regenerates at this rate.
  CfgHealthMaxRegen               Players health regenerates until this health level.
  CfgAmmoResupplyPerSecond        Players get ammo for their weapons at this rate.
  CfgbAllowDodgeJumping           Players can do UT2004 style dodge jumping.

The Slomo and the Speed Freak mutators that are included in the game also manipulate
the gamespeed. So it is best not to use those together with BattleMOD. Slomo is 
identical to CfgGameSpeedMultiplier=0.8 and Speed Freak is identical to 
CfgGameSpeedMultiplier=1.35.

REMARK: The CfgHoverVehicleSpeedMultiplier is not working yet.

====================================================================================
Changes
====================================================================================
V4.1 -> V5
Removed the HUD enhancements pending Epic patch.
Added CfgbAllWeapons, CfgHealthRegenPerSecond, CfgHealthMaxRegen, 
CfgAmmoResupplyPerSecond and CfgbAllowDodgeJumping settings.
Fixed CfgWeaponSwitchSpeedMultiplier to work properly for dedicated servers.

V4 -> V4.1
Replace .u with the proper version (V4 had the wrong one).
Added warning about UT3 autodownload problems.

V3 -> V4
Upgraded the mutator from UT3 1.00 to UT3 1.01.
Added PPH to the scoreboards.
Added Deaths to the Warfare, CTF, VCTF and Team Deathmatch scoreboards.

V2 -> V3
Fixed CfgWeaponSwitchSpeedMultiplier being dependent on CfgbMaxAmmo.

V1 -> V2
New setting: CfgWeaponSwitchSpeedMultiplier.

====================================================================================
Thanks to
====================================================================================
Woooo from London for suggesting CfgWeaponSwitchSpeedMultiplier.
Shambler from Ireland for the suggestion of using ClientSetHUD.
Mysterial from Epic for explaining how to change the scoreboard.

====================================================================================
BattleMOD Copyright (C) 2007 Nico de Vries.

BattleMOD is free software: you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation, either version 3 of the License, or
(at your option) any later version.

This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
GNU General Public License for more details.

You should have received a copy of the GNU General Public License
along with this program.  If not, see http://www.gnu.org/licenses/.

This program also contains elements (e.g. graphics and certain code fragments) 
which are Copyright 1998-2007 Epic Games, Inc. All Rights Reserved. That part 
is covered by the Epic license and not by the GPL.
====================================================================================