################################################################################

AntiRape
readme.txt (Version 1)

(Last Modified - 03.24.07)

################################################################################

Thank you for downloading AntiRape. This README file contains information
regarding the installation and usage of AntiRape.


################################################################################

Table of Contents

################################################################################

1. About
   1.1 Functionality
2. Installation
   2.1 Server Installation
3. Configuration
   3.1 BaseDeviceInclusionList
   3.2 TeamPlayerMin
   3.3 TimerInterval
4. Version Notes
   4.1 Version 1
5. Contact Information
   5.1 Comments, Questions, and Concerns
   5.2 Donate
6. Warranty
7. Copyright


################################################################################

1. About

################################################################################

1.1 Functionality

AntiRape is a small mutator that checks the number players on each team during
timed intervals. If the number of players per team is less than a specified
minimum, all desired base assets will become invincible. That is, rape will be
disabled under these circumstances. Conversely, if the number of players per
team meets the specified minimum, rape will be enabled, and the base devices
will become susceptible to damage. AntiRape will broadcast a message anytime
rape has been enabled or disabled. This mutator disables itself in tournament
mode.


################################################################################

2. Installation

################################################################################

2.1 Server Installation

To install, first extract the AntiRape_v1.u and AntiRape.ini files to the
\Program\Bin\ folder of your server installation.

Open the appropriate server ini. This is typically
\Program\Bin\Beta_Dedicated_Server.ini.

Under the [Engine.GameEngine] section, add "ServerPackages=AntiRape_v1" to the
bottom of the ServerPackages list.

Save and close the appropriate server ini.

Open AntiRape.ini.

Configure AntiRape.ini to your liking. For a full explanation of the
configuration ini, please refer to the following section of this README.

Save and close the AntiRape.ini.


################################################################################

3. Configuration

################################################################################

3.1 BaseDeviceInclusionList

The list of base device classes affected by AntiRape. For example:
  BaseDeviceInclusionList=Class'BaseObjectClasses.BaseCatapult'
  BaseDeviceInclusionList=Class'BaseObjectClasses.BaseDeployableSpawn'
  BaseDeviceInclusionList=Class'BaseObjectClasses.BaseInventoryStation'
  BaseDeviceInclusionList=Class'BaseObjectClasses.BasePowerGenerator'
  BaseDeviceInclusionList=Class'BaseObjectClasses.BaseResupply'
  BaseDeviceInclusionList=Class'BaseObjectClasses.BaseSensor'
  BaseDeviceInclusionList=Class'BaseObjectClasses.BaseTurret'

3.2 TeamPlayerMin

The minimum number of players on a team before rape is enabled. For example:
  TeamPlayerMin=6

3.3 TimerInterval

The number of seconds between each check verifying all teams' player count.
For example:
  TimerInterval=30


################################################################################

4. Version Notes

################################################################################

4.1 Version 1

AntiRape released.


################################################################################

5. Contact Information

################################################################################

5.1 Comments, Questions, and Concerns

If you have any questions, comments, or concerns, feel free to drop me a message
at rapher@rapher.net. Granted, I may not always respond promptly, but I will do
my best to address any mail that is sent my way. Alternatively, you can visit my
website at http://www.rapher.net/ for the most up to date information.

5.2 Donate

If you appreciate my work or would like to show your support, donations are
graciously accepted. Donations may be sent via PayPal to rapher@rapher.net.


################################################################################

6. Warranty

################################################################################

THIS SOFTWARE IS PROVIDED "AS IS" AND WITHOUT ANY EXPRESS OR IMPLIED WARRANTIES.
IN NO EVENT WILL THE AUTHOR BE HELD LIABLE FOR ANY DAMAGES ARISING FROM THE USE
OF THIS SOFTWARE.


################################################################################

7. Copyright

################################################################################

Copyright (c) 2006 Chase "rapher" Sensky

