Hi unknown Freelancer Admin, I'm pleased to meet you.

This is the readme for CheatersDeath lite (CD), which features freelancer anticheat services.
Please read the following lines before you run the anticheat.

I can be contacted using ICQ if questions arise: 164437397
or via the Leipzig-City webforum (Mischa), 
or at our CDlite Website (http://www.cdlite.de.vu/).
******************************
First of all:
You should backup your Database before you run CD.
Don't blame me if anything seriously goes wrong, I simply haven't tested it very carefully under all possible configurations.
BTW, CD has been built and tested under Win2k only so far. 

******************************
REQUIREMENTS
You need an ENGLISH version of flserver.
You need to have the 1.1 Patch installed. This is important because CD parses the flserver-console output.
You may only run one flserver.exe, for  CD will not work properly otherwise.

CD needs WinPCap 3.1 installed. See www.winpcap.org for details.

For faster startup of CD, you should have decompressed your freelancer inifiles. (Install the sdk for example).
This is not a requirement though, CD will start up anyway and try to decompress its needed inifiles with debini.exe, causing
some screen flicker while doing that (opening/closing many command line boxes fast).

flhash and debini are included in the rar archive and need to stay in the same directory with CD. 
I hereby explicitely want to thank the developers of those great tools for making them available for free.

WARNING
CD might cause problems if run concurrently with FLAC. 
It might have problems with FLSHELL as well, if you have the online-change-player-name feature enabled there.
I haven't had time to test this, though. 

It will run quite smoothly together with IONCROSS, but remember to turn off automatic player online update.
It is heavy in ressourceusage anyway without much gain.
Also you should decide if you use IONCROSS servercontrol OR the servercontrol built into CD, for that matter.

As of version 1.08, CDlite optionally integrates with FLhook (v. 1.42 and higher).

If you have been using FLAC, you might consider replacing FLAC's autoban files with 
Freelancer banned files. A simple tool for doing this should be available at:
http://softbytelabs.com/downloads/NameWiz%20Setup.exe
Thanks to Crazy for pointing out that problem to me.


******************************
SERVERMODS
If you are running servermods, be aware that your Mod must be written very clean in terms of fl-ini-style, 
THAT MEANS SPACES BEFORE AND AFTER EQUAL SIGNS,
COMMENTS ALWAYS ON SEPARATE LINES AND SO ON. 
Some things for CD are defined in cdstartupinfo.ini, for example all known bases and systems and ships.
You perhaps have to adjust it to meet your mod.
The ships you use have to be defined in shiparch.ini in the same way the original player ships are designed.
Don't forget to set those simple things like nano_bot_limit and so on^^.

CD recognizes equipment for ships which uses the class-system only. 
For example,  it will never import an unmodded invulnerable shield,
because it uses no class: hp_type = hp_elite_shield_generator
But would you mod it to: hp_type = hp_elite_shield_special_1 it would be allowed in ships which 
have a defining line similar to:hp_type = hp_elite_shield_special_1, HpShield01
I think if you are familiar with modding you understand what I mean.

Alternatively, you might consider including that equipment into CD by adding a line to
cdstartupinfo.ini ->[Inclusions]:
include = <nickname>

CD is not yet fully tested with many mods, since I'm not into modding myself.
But I know it appears to smoothly run on HC-Server and DFLS when configured properly.
If it doesn't work with your mod or behaves strangely (bans players and so on) plz. contact me if nothing else helps.

CD WILL FROM VERSION 1.05 ON DISABLE YOUR FLSERVER-CONSOLEOUTPUT (when running).
It will instead internally use that output and dump it into the flserveroutput.log-File with 
Date and Time prefixed.

******************************
KNOWN ISSUES

Weapon Range Detection doesnt work very well up to now. It will be improved in future versions, though.

SpeedModDetection sometimes erroneously detects System jumps for modded speeds. This is under investigation,
however, I suggest you only kick (not ban) players using speedmods until that has been fixed.    
(Fixed from version 1.21 on)

******************************
MULTICPU SERVERS

If you have got a HT or MP System, you should consider setting the following registry value for better 
and more reliable WinPCap Packet Timestamps which affects CD as well:
HKLM\System\CurrentControlSet\Services\NPF\TimestampMode = 2 
See winpcap.org for more details.

From version 1.12 on, a MultiCPU fix for flserver.exe is included in CD. It basically ensures flserver is running on one single CPU and
thereby prevents flserver from repeatedly crashing because of internal sychronisation problems.

******************************
RUNNING THE PROGRAM

Now about how to run it:

DON'T FORGET TO BACKUP YOUR FILES FIRST!
Decompress the CDlite.zip into a separate Directory. Don't (re)move any of the files.

Adjust cdstartupinfo.ini to your needs. 
Again, it is important that you carefully watch your syntax. CD is not tolerant about that.

Now silently speak a prayer and run cheatersdeathlite.exe. *g*

If you have got a huge Player database, CD will take its time when starting up. Especially after server reboot
it will take up to 5 minutes before the gui comes up. This is normal since it scans all player files for names 
und builts up an internal database for fast file access.

When you got the main screen up, configure CD: Menu Properties->Configuration.

Most parts should be self explanatory, others not. The initial values will give you some hint, though. :-)
Smoothness: the higher this value, the slower pings and lags change (they are smoother)
The lag kick threshold is computed from the LagKick offset and the LagKick Multiplier as follows:
LagKick(ms) = Multiplier * AverageLagofallPlayers + Offset
It therefore adjusts somewhat dynamically to bad network conditions, which affect all players.
The Traffic Check Module is disabled in the gui because it is not very reliable in practice. 
But since I'm a romantic I cling to it because it has been my very first approach to anticheating in spring 2005 ;-) .

Now configure: Menu Properties ->Modules
As of CD Version 1.17 , the Weapon Range Check is not fully developed yet. 
You should consider using only the Log feature of it. I hope to come up with an improvement soon.

Well, so far so good.
Now go back to the main window and click on GetAdapters to retrieve a list of your avail. IP Adapters, choose the right one. 
Choose your correct flserver port. Normally this is 2302, but if you run
a client on the same machine it might have moved higher (2304 or so).

After that, Let's Rock Baby!
You can automate this startup procedure later in the configuration window. You need to fill in the ip-address and
enable it. 
The port will be automatically remembered, too, but cannot be changed in the configuration window.
You will have to change it on the mainwindow. (Disable automatic winpcap startup to do this).

OK, if all went well, incoming players will be listed in the main window, with combo boxes for information about their characters 
and weapons and timings. Doubleclick opens a popup with info about their base, ship and so on. Rightclick provides additional commands 
when flhook is connected.
CD will not recognize players already online (before CD starts up). But it will kick them after 5 Minutes so that should not be 
a big problem there.

The other features are the userlist and the servercontrol. Play around with them at your leisure.
Admin Players :
	Administrative Players have the right to use Universe chat .
	I provided 2 Ingame Commands for that: 
	/u which gives small yellow text 
	/U which gives larger yellow text (for events and so on.)

For new features, bugfixes and more plz look into changes.txt.


******************************
ACKNOWLEDGEMENTS

I hereby would like to thank the many people who helped me during that project.
There are, of course, many I don't even know, but I used their freeware.
And many others helped me right out of the situation, when I needed new ideas and approaches.
I cannot name them all here, but some of them have to be announced here because they simply proved invaluable and helpful:

Special thanks to Trent, Marc, SkiF, Eagle, Crazy, Wodk4, Medulin, and Crabtree.

Sonix, my friend, without you there would be no CD at all. You provided the server, the support and many ideas.
Thank you. 
And thanks to the great community of Leipzig City, which filled my project with life and fun every day anew and
has been a great motivation all the time.


Cheers,
Mischa, July 2006 




