===============================================================================
 LFSLapper
===============================================================================

Copyright (c)  2005-2006  Janez Cufer.
    Permission is granted to copy, distribute and/or modify this document
    under the terms of the GNU Free Documentation License, Version 1.2
    or any later version published by the Free Software Foundation;
    with no Invariant Sections, no Front-Cover Texts, and no Back-Cover Texts.
    A copy of the license is included in the section entitled "GNU
    Free Documentation License".

===============================================================================

LFSLapper is external module for Live For Speed game.
It provides scripting capability to LFS servers.

===============================================================================
 Installation & Configuration
===============================================================================

1.Extract LFSLapper filer to arbitrary directory.

2.Start LFS server with argument "/Insim=29999"
or type "/insim 29999" in talk window when server is already running.

===============================================================================
 Starting LFSLapper
===============================================================================

1.Open sample script (LFSLapper.cfg) in cfg folder with text editor (like notepad).

2.Modify it to suit your purposes (usually only Password needs to be changed). Save it then.

3.Run LFSLapper.exe from command line, providing script file name as argument:

e.g.:

LFSLapper.exe ..\cfg\LFSLapper.cfg

or:

LFSLapper.exe ..\cfg\LFSLapper.cfg debug

to see debugging information

When using Mono, LFSLapper can be started by:
mono LFSLapper.exe ..\cfg\LFSLapper.cfg

Other ways to start LFSLapper in Windows:

Starting LFSLapper using windows shortcut:

	1.Drag lfslapper.exe on desktop using right mouse button.
	2.Create shortcut.
	3.Open its properties and add path to script file in target field.
	4.Double-click on shortcut to run application.

Starting LFSLapper using "Open with" dialog in explorer:

	1.Right click on script file (LFSLapper.cfg).
	2.Select Open with.
	3.Select Choose program.
	4.Browse for LFSLapper.exe (located in bin directory) and select it.

Starting LFSLapper by drag-and-drop:

	1.Drag script (LFSLapper.cfg) holding right mouse button from cfg
directory and drop it on LFSLapper.exe in bin directory.

===============================================================================
 Stopping LFSLapper
===============================================================================

1.Press CTRL+C in LFSLapper console window ,kill LFSLapper process from
command line or just close the console window.

===============================================================================
 LFSLapper integrated commands
===============================================================================

Just type command in talk window of LFS.
All integrated LFSLapper commands begin with exclamation mark and are case-sensitive.
List of supported commands:

!top [offset] [3-letter car name] ["filter" pattern]
!drf [offset] [3-letter car name] ["filter" pattern]
----------------------------------------------------

Displays 15 positions in table after position "offset"
filter pattern - Shows only names that match the given pattern

Examples:

!top 5 XFG - Shows 15 results from position 5 (to 20) for car XFG
!top XRT filter a - Shows 15 results from position 1 for car XRT that match
"a" pattern (Only players with nicknames that contain Letter a)
!top - Shows top 15 results for car XRT (It is default car)
!top XRG - Shows top 15 results for car XRG

!stats [playername pattern]
!dstats [playername pattern]
---------------------------

Displays personal best lap statistics of player with "playername pattern"
in his name for all cars.

If pattern is not specified, statistics of player who issued command is shown.

!ver
----

Displays information about LFSLapper.

===============================================================================
 Files
===============================================================================

LICENSE
-------
GNU GPL License

LFSLapper.exe
-------------
Main program

LFSLapper.cfg
-------------
Sample script of keys and values that define behaviour of module.
Keys are case-sensitive, but key order is not important.

See provided sample script for description of entries.

readme.txt
----------
Instructions (this file)

PB.txt (created by program if not present)
------------------------------------------
Database of best personal lap times, players and their cars

Format of file is as follows:

line 1 - Player NickName
line 2 - Car Name
line 3 - Lap Time in format MM.SS.HH
line 4 - Track Name
line 5 - 1st Split Time
line 6 - 2nd Split Time
line 7 - 3rd Split Time

line 8 - Player NickName
line 9 - ...
...

DriftPB.txt (created by program if not present)
-----------------------------------------------
Database of best personal lap drifting scores, players and their cars

Format of file is as follows:

line 1 - Player NickName
line 2 - Car Name
line 3 - Drifting score
line 4 - Track Name

line 5 - Player NickName
line 6 - ...
...