Dedicated Server file

LEGAL NOTICE
The Dedicated Server application ("The Application") is provided to the User
"As Is" without warranty of any kind. Massive Entertainment shall not be liable
to User for any damages, including but not limited to data loss, loss of
goodwill, work stoppage, computer failure or malfunction, or any other losses.
Massive Entertainment does not provide any customer service or technical
support for the Application.

Dedicated Server - Ground Control II - Operation Exodus
Version 1.0.0.8
November 3rd, 2004

[ To read this file, select Edit/Word Wrap from the menu above ]

TABLE OF CONTENTS

[1] Introduction
[2] Setup
[3] Firewall issues
[4] Commandline options
[5] INi-files options
[6] Custom Maps

[1] INTRODUCTION
====================================

This Readme.txt file will give a brief explanation how to setup and run a
Dedicated Server (DS).

[2] SETUP
====================================

One DS will be able to host a game for up to 8 players. If you want
to host games for more players you will have to setup the servers to
use different (unique) ports (see INI-file Options below).

Quick setup:

1. Edit the dedicated.ini file:
* Change [GameName] to something other than the default name.
* If it's a LAN game change [ReportToGamespy] to 0

2. Run the server by starting gc2ds.exe

3. Have fun

Good practice is usually to make the server restart automatically in case of
problems using some kind of script or batch file. See runserver.cmd for an
example.

[3] FIREWALL ISSUES
====================================

You have to allow outgoing traffic on the following ports:

UDP:
13139
29910

TCP:
27900
28910
29900
29920

You also have to allow incoming traffic to the ports defined in the INI-File
(QueryPort, ReliablePort and UDPRangeStart).

If you are behind a firewall you will need to forward incoming traffic on the
ports defined in the INI-file (QueryPort, ReliablePort and UDPRangeStart). If
your server doesn't show up, try setting [UseFireWallSettingsFlag] to 1 and
enter your firewalls public IP under [PublicIP].

[4] COMMANDLINE OPTIONS
====================================

-inifile
Tells the DS to read inidata from instead of dedicated.ini

-debugfile
Tells the DS to output debug info to instead of gc2ds_debug.txt

-nodebug
Turns off output of debug info

example:
gc2ds.exe -inifile ds1.ini -debugfile debug_ds1.txt

[5] INI-FILE OPTIONS
====================================

This section will describe some of the more complex INI-file options. For short
descriptions see the comments in the attached INI-file.

* [League]
This tells Massgate which League the server is supposed to be visible under.
The default Leagues for the various regions are:
649 - European Public League
651 - North American Public League
652 - Asian Public League

Other Leagues may exist, but are usually only meant for certain servers run by
VUG or Partners.

* [UDPRangeStart]
The game server needs up to 10 UDP ports to function correctly. This sets the
first port used by the server.

For instance, if you set this to 42000, the server will use UDP ports 42000 to
42009.

* [ContentDownloadAllowed]
Setting this to 1 will enable players to download custom maps and game replays
located in the custom_maps and replay directories respectively.

* [RankedFlag]
Set this to 1 only if you know your server is allowed to report stats to the
League. Only VUG/Massive and trusted Partners can report stats to the ladders.

* [UseFireWallSettingsFlag]
You should only enable this if your server doesn't show up in the ingame list
of games. If you set this to 1 you have to enter a valid [PublicIP] as well as
forward incoming traffic on the ports specified in the ini-file (default UDP
6500, TCP 42000 and UDP 42010-42019).

* [StatsServerPort], [StatsServerIP]
If these are enabled (port > 0 and a valid IP is entered) one UDP packet every
60-120 seconds will be sent to that IP/Port.

Packet content:
(all numbers are unsigned int, little endian format)
4 bytes - DS Build number
4 bytes - Protocol version
4 bytes - Gameinfo protocol version
4 bytes - UDP packet type
4 bytes - size of gamename (not including NULL termination)
string length + 1 - gamename
4 bytes - size of IP string (not including NULL termination)
string length + 1 - Text string of server IP
4 bytes - Servers reliable port
4 bytes - Servers League

UDP Packet type can be one of:
0 - Server started
1 - Server shutdown
2 - Game started
3 - Game ended
4 - I'm Still Alive message

if the UDP packet is of type 4 these additional numbers are sent:
4 bytes - Number of players in Lobby
4 bytes - Number of players ingame
4 bytes - 0 if no game is being played, 1 if game is running
4 bytes - number of seconds since the server was started

This feature can be used in conjunction with a program that for instance
receives the UDP packets and reports to a database how many players are online
at the moment.

[6] CUSTOM MAPS
====================================

The GC2 community are constantly producing Custom maps using XEd. XEd outputs a
SDF file containing all the data needed to play on the map. If you want to be
able to host games using these maps, place them in a directory named
"custom_maps".