
This is the readme of the mutator HyperUnreal2k4. Thanks for using it!


1. Description
2. Configurable options
3. Important notes/Possible issues
4. Credit



1. Description

HyperUnreal2k4 offers the possibility to tweak most movement abilities of the players, and some other options about weapons. The default tweaks make the game a bit faster, more UT2004-like. It also brings back adrenaline and combos from UT2004.
The mutator is configurable from the UT3 mutators menu.
It is possible for scripters to create their own combos. See the sources included for this. As said in HU_ComboBase, don't forget to add any custom combo manually in the mutator's known combos.

Combos: 
Booster. Slightly increases your health, and then your shield if health is at maximum.
         Moves: Backward 4 times
Speed. Makes you much faster. Increases your jumping height too.
         Moves: Forward 4 times
Berserk. Increases your shooting rate.
         Moves: Forward 2 times, backward 2 times
Invisibility. Turns you invisible.
         Moves: Rightward 2 times, Leftward 2 times


2. Configurable options

One of the main points of HyperUnreal is that almost everything is configurable. Here a list of what you can tweak. Scalar = multiply UT3 default value by this option (1.0 = same, 2.0 = double, 0.5 = half)


Movement:

- Running speed (scalar): defines the ground speed of the players

- Jump height (scalar): defines the jumping height, for both ground and multi-jumps

- Number of multi-jumps: how many times can a player jump again in air (0 = no multi-jumps)

- Multi-jump boost: boost applied on jump height, for multi-jumps. The value should be lesser than 0, so that multi-jumps are lower than ground jumps.

- Dodge distance (scalar): Distance, both vertical and horizontal, of a dodge.

- Air control (scalar): Players' movement control while falling

- Dodge-jump: if checked, players will be able to do multi-jumps after a dodge.


Weapons:

- Fire rate: scales all weapons' fire rate. Smaller value = faster rate (0.5 = double fire rate, 1.0 = normal, 2.0 = 2x slower)

- Weapon switch: scales how fast a player switch weapons. Again, smaller value = faster



Adrenaline/combos:

- Kill reward: how much adrenaline gets a player when he kills another player

- death penalty: how much adrenaline is lost by a player that died

- Adrenaline enabled/disabled: enable or disable adrenaline and combos in the mutator

- Enabled combos: a list of every enabled combo in the mutator. "Disable this combo" will disable the combo selected in the box.

- Disabled combos: same, but for disabled combos.



3. Important notes

Not tested online. The mutator probably doesn't work in multiplayer, sorry for that.

Bot support, also for adrenaline and combos (though they're not very strategic, mostly use Booster).

Important: the combos use the default WSAD movement keys, and will not use your own bindings!! If you're not using these keys for movement, do the following:

Open My docs\My Games\Unreal tournament 3\UTGame\Config\UTHyperUnreal2k4.ini (not UTHyperUnreal2k4_Cont.ini!!!)
You should find the following in the end of the file:

[HyperUnreal2k4.HU_Adrenalinteraction]
ForwardKey=W
BackwardKey=S
LeftKey=A
RightKey=D


After each '=', you can see the WSAD keys. Replace each one by whatever you want.


Possible issues/Bugs (not sure about some of them):

- The problem shown above (about movement keys)
- A player won't be able to dodge-jump for several seconds at certain spawns (apparently fixed) 
- The icon showing the amount of adrenaline sometimes disappear
- The icon near the amount of adrenaline is black-coloured (shouldn't)
- Sometimes, it is impossible to do any combo for a while even if the adrenaline is full (apparently fixed)
- Some config menu's numeric boxes can be difficult to configure (they don't show what the user writes)
- if there are more than 1 multi-jumps allowed, and dodge-jump allowed, it is possible to have unlimited jump boots
- No effect for berserk
- No post processing effects are visible (there should be some)
- Game crashes each time the player leaves a map to main menu


4. Credit

Mutator made by HyperGames2008 team (Scripted by Kognefaure)
Many thanks to Epic games and the UT3 community!

Feel free to post any question/critic/suggestion/support request on epic games forums or Hypergames forums. They're all welcome!

http://utforums.epicgames.com/showthread.php?t=632791

http://hypergame2k8.yuku.com/directory