========================================================================
BATTLE RECORDER
========================================================================


USAGE

The BattleRecorder allows a round to be recorded and distributed.
The system is very flexible, and the current implementation can be easily
changed. We recommend you have a good knowledge of Python before you
edit the scripts used here.


There are two components to BattleRecorder. First is the Dedicated Server
Launcher.

The Dedicated Server Launcher requires the following information:
- AutoRecord
  Set AutoRecord to on to enable the BattleRecorder. Every round played
  on the server will now be recorded to a file.

- DemoDownloadURL <http://YourServer.com/YourDirectory/>
  This is the URL that will be passed to all the connected clients at the
  end of the round. This is the URL that the Battlefield 2 front end will
  try and download the demo file from when the user selects 'download'.
  The demo file must be in the directory specified in the URL, or the
  demo download will fail.

- AutoDemoHook <adminutils/demo/Your_Script.exe>
  The server runs this script at the end of every round where AutoRecord
  is enabled. Note that the exe ending is only relevant for the
  windows-server, on linux it can be any executable file. A python script,
  for instance.


The second component to BattleRecorder is the script that is run when a
round ends. This script can be rewritten or replaced as needed. The
Battlefield 2 server will simply attempt to execute the script specified
in AutoDemoHook at the end of each round.

The default script, called auto_rotate, was written in Python and then
built in to an executable.

The Python script can be found here \adminutils\demo\rotate_demo.py

The script will move a BattleRecorder file from the server to a new local
location, or to an FTP site. You can also specify the number of files to
keep archived.

The script is configured using a configuration file, called
'auto_rotate.cfg', found in the root of the Battlefield 2 installation
root directory.

In this file you can configure:

- file_limit = <value>
  Use this value to set the number of BattleRecorder files you would like
  to keep available. The default is 30. Once the limit is reached, a new
  file will replace the oldest one.

- target_root = <local directory path>
  If you intend to transfer to a local directory, enter the path here.

- use_ftp = <bool>
  Set this to 1 if you wish to FTP the DemoRecorder file to a new
  location.

- ftp_target_dir = <path to webroot demos>
  Enter the path on the FTP site where you want the DemoRecording
  transferred to.

- ftp_server = <server URL or IP>
  Enter the URL or IP of your FTP server.

- ftp_user = <FTP login username>
  Enter your FTP sites login username.

- ftp_password = <password>
  Enter the password for your login account.


NOTES

DemoRecorder files become larger as you increase the number of players
and the ticket allocation. For a round with 64 players with 250 tickets
on each side, you should expect a file size of around 10-12 Mb.