 _________________
|                 |
|  CSPSP Server   |
|  version 0.5    |
|  by Kevin Chen  |
|  2008           |
|_________________|


 ________
|-INTRO- |
|________|

   This is version 0.5 of the game server application for CSPSP. 
   

 _______________
|-INSTALLATION- |
|_______________|

   Extract the files to any location you want, and run the CSPSPServer.exe executable to start the server application. 

***If you are behind a router, you will have to port foward the port (udp only) specified in config.txt (default is 42692). Similarly, if you are using a firewall, you will have to unblock/open the port. Since the steps for these procedures vary among router types and different firewalls, I won't give any specific instructions here. A quick google search should be enough though (http://www.portforward.com is helpful).***
   

 ________________
|-CONFIGURATION- |
|________________|

   To configure your server, open up data/config.txt. Inside, you'll find a few settings that you can change. They should be pretty self-explanatory, but I'll give short descriptions of them here:


   "name" - the name of your server (max 32 characters)

   "map" - the name of the map to run (make sure you spell it right, or the server will automatically close)

   "friendlyfire" - enables/disables friendly fire ["on"/"off"]

   "maxplayers" - the maximum number of players that can join the server (max 32, although a realistic value should be around 10)

   "roundtime" - the duration of a round in seconds (minimum 10)

   "freezetime" - the freeze time before a round in seconds (max 10)

   "port" - the port that the server will use (between 1024 and 65536)

   
***Modifying the data/guns.txt is not recommended since CSPSP clients won't reflect the changes you make (which might lead to strange results for players).***


 ________________
|-COMMON ERRORS- |
|________________|

   Here is a list of a few error messages and their explanations/solutions:


   "Error: Map could not be loaded" - the map specified in config.txt could not be loaded (this could mean either that the map name is incorrect, or the map itself has problems)

   "Error registering server: Server already registered" - the server was not unregistered correctly the last time it was closed. This is more of a warning than an error, and the server will still function normally.

   "Error registering server: Version outdated" - a new version of the server application is available. Although the server will still run, only people with compatible CSPSP clients will be able to join. It's recommended that you update as soon as possible.

   "Error contacting master server" - the master server that holds the list of servers is unavailable (or your internet connection isn't working). The server will still run, and people who have it saved in favorites will still be able to connect.

   "Error registering server: Supplied IP does not match" - the IP sent to the master server differs from the IP that the master server sees. This error is usually uncommon; try restarting the server application if this happens.


 _______
|-TODO- |
|_______|

   More settings to change

   Commands for the admin of the server (kick, ban, etc.)

   Map rotation