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

PingControl
readme.txt (Version 1)

(Last Modified - 03.24.07)

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

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


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

Table of Contents

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

1. About
   1.1 Functionality
2. Installation
   2.1 Server Installation
3. Configuration
   3.1 MinPing
   3.2 MaxPing
   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

PingControl is a small mutator that checks each player's ping during timed
intervals. If a player's ping falls above or below a set range, the player will
be warned that their connection does not coincide with server specifications.
If the player's ping does not adjust to the acceptable range during the
subsequent check, this player will be removed from the server. This mutator
disables itself in tournament mode.


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

2. Installation

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

2.1 Server Installation

To install, first extract the PingControl_v1.u and PingControl.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=PingControl_v1" to the
bottom of the ServerPackages list.

Save and close the appropriate server ini.

Open PingControl.ini.

Configure PingControl.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 PingControl.ini.


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

3. Configuration

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

3.1 MinPing

The minimum acceptable player ping. For example:
  MinPing=0

3.2 MaxPing

The maximum acceptable player ping. For example:
  MaxPing=300

3.3 TimerInterval

The number of seconds between each check verifying each player's ping.
For example:
  TimerInterval=30


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

4. Version Notes

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

4.1 Version 1

PingControl 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

