Installation
------------

Edit sof-logger.cfg. You must change these settings for your server:
  net_server_ip=192.168.1.1
  net_server_port=28910
  net_server_rcon="secret-password"

Edit run.bat if you want a different window size (or change the window size in
the logger window properties)

Start the logger by executing run.bat

Change the logger window properties:
- Open the properties menu by left-clicking on the left side of the title bar
  or by right clicking on the title bar
- Change the font to Lucida Console on the font tab (if you don't do this, some
  characters, like the euro sign, will not be displayed correctly)
- Optionally change the window size on the layout tab (or force a size by
  editing run.bat)
- Press OK and select 'save properties for future windows with same title'
- Restart the logger


Info
----

You can get into and out of console mode by pressing the '~' or the 'F1' key
Note: Don't put 'rcon' in front of the commands

Be careful with the access control keys (+, -) and don't press 'K'
and 'B' too much ;)

Stop the logger with the 'Q' key. Don't click the X with your mouse


Features
--------

- Log names and IP addresses
- Show detailed information about clients
- Show a message when a player is connecting and when a player disconects
  while connecting
- Kick function with autokick ... seconds after the client was kicked. To
  prevent reconnecting immediately
- Ban function
- Access levels: specify access levels for each ip. When an access level is
  set (0..9) lower access levels can't connect
- Execute rcon commands in console mode


Versions
--------

Changes in the 2011-08-29 version:
- Reduced CPU usage

Changes in the 2011-08-02 version:
- Made it work on newer Windows versions. The program has been tested on Linux,
  Windows XP SP3 and Windows 7 Ultimate.
- Removed even more code

Changes in the 2008-09-14 version:
- Removed about half the code, because SoFplus handles that now

Changes in the 2004-03-17 version:
- Fixed a bug when the game froze at the start of a map
- Some small changes

Changes in the 2004-03-15 version:
- Added next round map voting and vote info
- Added SPAM (that should be fun)
- Added a signal handler for closing the program
- Updated this readme
- Removed some things that didn't work with the new cygwin1.dll

Changes in the 2004-03-08 version:
- Players with CYAN color name with the intention to create lag
  can be auto banned
- Added voting capabilities
  This is very experimental. New features were already requested, so a new
  and improved version will come soon
- Replaced cygwin1.dll, to make it work with W2K3
  You should remove all old versions of the DLL from your system.
  You might have to reboot if the old version is still loaded in memory

Changes in the 2004-01-19 version:
- Players with CYAN color name can be auto kicked
- Players with an invalid rate can be auto kicked
- Color for console messages can be set in the configuration file
- The 'console: ' text has been removed from console messages

Changes in the 2003-11-02 version:
- In Windows, a fake console cursor displayed now.
- In windows, the borders are drawn now when the logger is started.
- Added the 'g_movescale' parameter to the configuration file
- Fixed the logfile line termination in DOS mode

Changes in the 2003-10-08 version:
- The 0x0d character (namehack) is not displayed in console messages
  anymore
- The wait delay at the start of a map is corrected (why on earth would
  anyone set poll_interval_status to more than 1 ;)
- The run.bat file has been fixed for Win9x

Changes in the 2003-10-01 version:
- Less segfaults
- Color names are displayed in the console messages


Known issues
------------

- In Windows, the program window cannot be resized. Edit run.bat to
  set your preferred window size. I'm working on a solution.

- The user interface responds a bit laggy. Response can be improved
  by reducing net_response_timeout_1 and net_response_timeout_next
  timeouts. I can set them to 50 and 25 ms on the LAN.
  Setting this too low will cause loss of UDP packets

- The '#' and '$' character aren't displayed in console messages, because
  of security concerns.


Credits
-------
Spy and WOLF:  For testing, feature requests, improving the manual, ...


Links
-----

The latest logger version can be found at http://sof1.megalag.org/
You can email me at sof1@megalag.org