ReadMe for SUDvasion for Unreal Tournament 2k4

        Title: SUDvasion
       Author: Durath
 Release Date: March 6, 2004
Latest Update: May 16, 2004
      Version: 1.0.1
      Contact: Through the sudreal forums at www.sudreal.org or through the Atari forums (as Dur@th).


Mutator Description
-------------------

A mutator designed specifically for the invasion gametype.  It causes players to spawn at the red base and 
monsters to spawn at the blue base of team maps (CTF, BR, DOM, ONS), giving more of an "invasion" feel to the 
game.  On ONS maps, the powernode locations are also spawn points for monsters and players - powernode 
locations close to the red base are set as player spawn points and all other powernode locations are set 
as monster spawn points.
This mutator was designed to work with the Vehicle Invasion, Satore Monster Pack mutators, and/or by itself.

Features:
- Players spawn at red base, monsters spawn at blue base
- "classic" monster spawning in DM maps (monsters spawn "only" at player spawn points)
- Custom map and map type wave configs
- Configure more than 16 waves through the config menu
- Custom wave configs includes number of waves (ie. you can different final waves for different maps) 
  as well as "classic" monster spawn option
- Control over which weapons nali fighters spawn with each wave
- Wave messages displayed at the begining of each wave
- Web config

Note: SUDvasion overrides Satore Monster Pack's wave config.

Installation
------------

Unzip SUDvasion.zip
Store the following files in your .../UT2004/System directory:
	SUDvasion.ini
	SUDvasion.u
	SUDvasion.ucl

If you are updating to the latest version then you only need to copy over SUDvasion.u and SUDvasion.ucl - 
you can keep your old ini.

Add "SUDvasion" from the mutator list.

Configuration
-------------

You can configure SUDvasion through the mutator menu or you can configure it through web config (if it is 
enabled).  Configuring the waves is fairly straight forward and, if you are familliar with Satore Monster
Pack, you will notice alot of similarities.  There are two main features to SUDvasion's config menu that
separates it from Satore's config menu.  They are the ablility to save custom wave configs and the ability
to control what weapons nali fighters get each wave.

Saving Custom Wave Config:
You can load and save custom wave configs for different maps and map types.  To create a new wave config 
through the mutator config menu: 

1, Create the wave config
2. Hit the save button
3. Under "Config Name" type the name of the map or the prefix(*) of the maps you want to set this config for.
   For example, if you want to make a wave config for deathmatch 1 on 1 maps save the config as "dm-1on1" 
   (without the quotes).  To save a wave config for br-serenity, save the config as "br-serenity".
4. Hit Ok.

Saving a new wave config through the web config differs slightly.  Instead of setting the custon config name
after configuring the wave, you must set the config name first.
The 

(*)Note: The custom wave config that will used in game is the one that is the longest matching prefix to
the name of the current map. So, it is possible to have, for example, a custom wave config for CTF maps and 
one for CTF-FaceClassic.

Configuring Nali Weapons:
You will notice in SUDvasion's main config menu a section titled "Nali Weapon Classes" with a number of combo
boxed.  Select the wave and then select (or type in) the weapon classes of the weapons you want the nali to have 
that wave. To add more weapon classes to the drop-down list, open up SUDvasion.ini in a text editor and add the
folowing line under [SUDvasion.SUDvasionConfigMenu]

	NaliWeaponClasses=packagename.weaponclassname

replacing packagename and weaponclassname with, respectively, the name of the package the weapon belongs to and
the weapon's class name.
  
NOTE: I recommend that you make sure every weapon class you assigned to the nali is also listed in 
satoreMonsterPack.ini under [satoreMonsterPackvXXX.SMPNaliFighter], otherwise the nali may never spawn with some 
weapons.

Wave Messages:
To add/edit wave messages, open up SUDvasion.ini and add/edit the following lines under [SUDvasion.MutSUDvasion]:

	WaveMsg=your message

The first WaveMsg will be displayed at the begining of wave 1, the second WaveMsg will be displayed at the 
begining of wave 2, etc...

Server
-----

This mutator is server-side only.  Clients do not need this mutator installed, therefore you do NOT need to 
add this mutator to the serverpackages list.

Version History
---------------
v1.0.1:
- added option to turn of SUDvasion's wave config - nali weapon control stays on no matter what this option 
  is set at
- displays version in server info
- fixed bug that caused some setting not to save in the SUDvasion's config menu but you must be careful to 
  hit cancel in "Mutator Configuration" menu (NOT SUDvasion's config menu) otherwise the old setting may be 
  saved over your changes


v1.0.0:
- "official" release version

Testing
-------

Tested with invasion, vehicle invasion 1.13, Satore Monster Pack 1.16 - 1.20.

Acknowledgements
----------------

Thanks to Codeslave for the original idea and others of the Sudreal community for their input.
Thanks to satore for letting me borrow some of his wave config code from his Satore Monster Pack Mutator.
