
                      *==================*
                      | ET Manager 2.1.0 |
                      *==================*
                        Made by  Ze Blob
                        

+-------------+
| Legal stuff |
+-------------+

ET Manager is a collection of small utilities for Wolfenstein : Enemy Territory.
Copyright (C) Ze Blob

This program is free software; you can redistribute it and/or
modify it under the terms of the GNU General Public License
as published by the Free Software Foundation; either version 2
of the License, or (at your option) any later version.

This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
GNU General Public License for more details.

You should have received a copy of the GNU General Public License
along with this program; if not, write to the Free Software
Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.


+---------+
| Warning |
+---------+

The following text is a gramatical nightmare.
Read at your own risks!


+-------------------+
| Table of Contents |
+-------------------+

- Global :
   - I have the ETManager.jar. Now what?
   - I got ET Manager is running! Where should I start?
   - How do I only make the tab X come up?
   - How do I change the language that ET Manager uses?
   - How do I sort tables?

- Welcome tab :
   - What is this "Look And Feel" thing?

- Rotation Checker :
   - What kind of files can I use for my rotation file?
   - I have a rotation file on my HD. How do I use it to check the rotation?
   - Why can't I download anything?
   - If I don't have an unrar.exe how do I tell ETM not to extract the files after
     a download.
   - So I just finished downloading. Where are my maps?

- Backup Module :
   - How do I only move one file?
   - Why doesn't the "Move maps in rotation to the etmain folder" button work?

- Pk3 Explorer :
   - The program is having trouble loading the local list. How do I fix it?
   - What are the 3 options for?
   - Why can't I find the stock maps?
   - Why does the CRC-32 field display ffffffff?
   - Why is the map list showing up grey (disabled)?
   - The enlarged pictures are WAY too big! How do I close the window?
    
- Favorite Servers :
   - How do I view the details for a server?
   - Why are some properties coming up blank?
   - Why can't I see any white name players?

- Update module :
   - What are the "L&F" in the state column?
   - How do I make the updates take effect if I didn't choose to restart?
   
- Console tracker :
  - What does it do?
  - How do I make it work?
  - What are the ETM specific commands within ET?
  - Is this some big conspiracie to know how crappy I really am?

- Stats module :
  - Where do I start?
  - Why don't I get any info on people that quit or went spec before the
    end of the match?
  - What does the "XP save calculation method" option do?
  - Ya got any tips to make viewing my stats easier?

- Quick-Launch :
   - What's Quick-Launch?
   - How do I use it?
  
- Misc :
   - I sooo want to frag you! Where can I do it?
   - The mysteries of the ini.
   - Translating ET Manager.
   - Manually adding a Look and Feel.
   - Thanks and stuff.
  

+--------+
| Global |
+--------+

Q : I have the ETManager.jar. Now what?
A : Well first of all you will need the Java Runtime Environment (JRE). You can 
get it from the sun website or by using this url :

    http://java.sun.com/j2se/1.5.0/download.jsp
    
Note that most linux distribution will come with it already installed. After you're
done installing the JRE, opening the jar file normally should work. If it doesn't
then you can use the runme.bat or the runme.sh file to start the program.  Note
that the command used to start ETM is :

    java -classpath ETManager.jar etm.Main
    
You can use that, to create shortcuts or make batch files or shell scripts for
quick-launch or single module launch (both explained later).

Q : I got ET Manager running! Where should I start?
A : Well first of all, I sugest you take a quick trip to the "Backup" tab. Once
you're there you should set the "ET folder" to the folder where ET is installed
on your computer. If you intend on using the rotation checker, then I also sujest
setting your backup folder. You can use this folder, to optimize your ET load time
by dumping unused .pk3 files in there.
Once that's done, you might want to generate your pk3.dat by switching to the
Pk3 Explorer tab. Although you might not need it, it will save you the trouble
of doing it later.

Q : How do I only make the tab X come up?
A : For the Rotation Checker module : 

    java -classpath ETManager.jar etm.rotation.Main
    
For the Backup module :

    java -classpath ETManager.jar etm.backup.Main
    
For the Pk3 Explorer module :

    java -classpath ETManager.jar etm.explorer.Main
    
For the Favorite Servers module :

    java -classpath ETManager.jar etm.server.Main
    
For the Update module :

    java -classpath ETManager.jar etm.update.Main
    
Note that quick-launch is always launched alone. For more information on
quick-launch, check the quick-launch section of this FAQ.

Q : How do I change the language that ET Manager uses?
A : Open the welcome tab and select the language from the "Language" combo box
near the top.

Q : How do I sort tables?
A : Some tables like the teams information in the favorite server module can 
be sorted as of version 2.1.0. Sorting is simple enough, click on the column
header and magic happens. Here's a few extra shorcut you might like to know
about :
- Normal click : Shifts the sorting order from acsending to descending to no
sorting.
- Shift + click : Like a normal click but in reversed order.
- Ctrl + click : Select additional column for tie breaking.


+-------------+
| Welcome tab |
+-------------+

Q : What is this "Look And Feel" thing?
A : Look And Feels (LnF) are special Java packages that changes the look of a
program. There's a few default LnF that comes with every Java platform, but most
are developped by third parties. You can get a few of them in the update module.


+------------------+
| Rotation Checker |
+------------------+

Q : What kind of files can I use for my rotation file?
A : There is 2 kinds of files supported by the rotation checker. First there's
a special text file which contains a list of pk3 filenames. Or you can use
any pk3 file that contains a .campaign file.

Q : I have a rotation file on my HD. How do I use it to check the rotation?
A : First move the file in your ET Manager folder, then set the "Rotation URL"
to "/" followed by the rotation file. For exemple : 

    /myRotation.pk3
    

Q : Why can't I download anything?
A : If you're using a pk3 containing a .campaign file, then there's no way for
the rotation checker to resolve the filenames of the maps.
Also for the moment downloads are restricted to the Chicken Bucket as per
agreement with www.etmaps.de. If you can work something out with them, then I will
have no problem taking off the restriction for your server.

Q : If I don't have an unrar.exe how do I tell ETM to not extract the files after
a download.
A : Entering any invalid path, will simply ignore the extraction process.

Q : So I just finished downloading. Where are my maps?
A : Normally the pk3 files should be moved to the etmain folder except for the
etpro files which will be moved to the etpro folder. But if for one reason or 
another the files are not moved, simply go to your ET Manager folder and open the 
"downloads" folder.


+---------------+
| Backup Module |
+---------------+

Q : How do I only move one file?
A : Simply double-click on the file you want to move.

Q : Why doesn't the "Move maps in rotation to the etmain folder" button work?
A : You will first need to use the rotation checker to load a rotation file.


+--------------+
| Pk3 Explorer |
+--------------+

Q : The program is having trouble loading the local list. How do I fix it?
A : Simply delete your pk3.dat file located in your ET Manager folder and reload 
your local list in the program.

Q : What are the 3 options for?
A : They are used to make the list of pk3 files easier to browse. Here's what
each does :
 - "Group pk3s by there folders." :
 	This will organise your list by the different folders that you're pk3s are
 	located in. Meaning that pk3s located in your etmain folder will be separated
 	from the ones contained in your backup folder.
 
 - "Group pk3s by there key file." :
 	The key filename refers to either the .bsp (for maps) or the .campaign
 	(for rotations) files contained in the .pk3. Meaning that pk3s with the same
 	.bsp files will be groupped together.
 	
 - "Fuse similar groups together." :
 	To use this option, the previus option must be selected. This option will fuse 
 	groups that have similar names. For exemple, "aMap.bsp, "aMap2.bsp", 
 	"aMap_beta2.bsp" and "final_aMap.bsp" would all be groupped under the "aMap" 
 	key.

Q : Why can't I find the stock maps?
A : They are filtered out to protect the basic ET files from being moved by the 
rotation checker or the backup module.

Q : Why does the CRC-32 field display ffffffff?
A : This is because by default the program doesn't calculate the CRC. To calculate
it you must set the "calcCRC" setting in the "rotation" group to "1". Then you must
delete your pk3.dat and recompile it. Note that it can take a long time to
calculate the CRC and for the moment is pretty much useless.

Q : Why is the map list showing up grey (disabled)?
A : It's because the map details depends on the .arena files contained in your
pk3. If the program cannot locate an .arena file, then it will display the list
of .bsp files in the pk3.

Q : The enlarged pictures are WAY too big! How do I close the window?
A : Click on it or use the Alt + F4 key combination.


+------------------+
| Favorite Servers |
+------------------+

Q : How do I view the details for a server?
A : Simply double-click on the server or select the server and switch to the
information tab.

Q : Why are some properties coming up blank?
A : Not all mods uses the same variable names. So if the variable can't be found
it will be shown as empty.
      
Q : Why can't I see any white name players?
A : If a players name doesn't specify a color, by default it will be displayed in
an unbolded black. It's easier to read that way.


+---------------+
| Update Module |
+---------------+

Q : What are the "L&F" in the state column?
A : They represent "Look And Feels" download. Basicly they will change the way
the program looks.

Q : How do I make the updates take effect if I didn't choose to restart?
A : You need to run the runme.update.bat or the runme.update.sh file to
properly update the program.
    

+-----------------+
| Console Tracker |
+-----------------+

Q : What does it do?
A : The console tracker simply sits in the background and monitors your
console activities while you're playing ET. It can be used to create logs files
or to gather statistiques that can be viewed using the stats module.

Q : How do I make it work?
A : Click the "launch ET" button on the welcome tab. In the Quick-Launch dialog,
simply check the "Load tracker" option. Once that's done you can either select
the "track stats" option to track you're statistiques or the "create log" option
to create a log of you're console.
	
Q : What are the ETM specific commands within ET?
A : To make these commands work, simply drop down the console in ET and
type them in as you would for any other command. Note that you will not get
any feedback from ETM, but they should work.

- This will start a new stats session at the begining of the next map to be 
loaded :

    /etm_startStats [filename]
    
If there is already an active session, it will automaticly be stopped before 
starting a new one.

- This will stop the current stats session :

    /etm_stopStats
    
- This will start logging the console output :

    /etm_startLog [filename]

- This will stop the current console log output :

    /etm_stopLog

- This will close ETM :

	/etm_close

Q : Is this some big conspiracie to know how crappy I really am?
A : Paranoid aren't we? The stats tracker and the log maker are purely personal 
tools. Hence, ETM will not attempt to transmit this data without your explicit 
permission. I also donnot plan on adding any such things to ETM nor is it within 
the scope of this project. 
So rest easy, your secrets are safe.


+--------------+
| Stats Module |
+--------------+

Q : Where do I start?
A : First, for this module to have any use, you must gather some playing data.
To do so, you can either use the "etm.tracker.bat" or the "etm.tracker.sh",
or refer to the "Console tracker" section of this FAQ for a more detailed 
explanation.

Q : Why don't I get any info on people that quit or went spec before the
    end of the match?
A : For the moment, all the charts except for the Frag History rely on the tables
dumped by ET at the end of the round. If a player quits before hand, then ET will
not give any info for that player. Also if someone switches team mid game, it
will reset all the stats for that player except for the score.
The frag history on the other hand, relies on the frags that are dumped regularly
to the console. I plan on adding more graphs like this in future releases.

Q : What does the "XP save calculation method" option do?
A : If you are viewing data for which XP save was turned on, then you should
check this option. Basicly it will adjust the score and the skill data so that
it reflects XP save. Otherwise it will simply sum up everything and display
completly wacky results.

Q : Ya got any tips to make viewing my stats easier?
A : I sure do!

- You can rename or delete sessions, by right clicking on them.
Note that for the moment, a bug will force you to right click twice to make the
pop up menu appear.

- You can make mass selections using the right click menu on the tables.

- You can change the color associated with one of the table entries by double
clicking on the color.

- Each graphs has built-in tool tips to make viewing your stats easier.

- The more space the graphs have to draw, the more precise they will become.
So it's not a bad idea to maximize your ETM window while viewing the Frag history
or the Scatter charts.

- Your map selection does not have to be contiguous. Meaning that you can easily
tailor the charts so that you look good, no matter what. ;)
  
  
+--------------+
| Quick-Launch |
+--------------+

Q : What's Quick-Launch?
A : Quick-Launch is a module in ET Manager that runs from the command lines. It
will do a few quick checks and then proceed to starting ET and connect you to
a given server. So basicly, it's a no hassle way to connect to a server while
always making sure that you are up to date.

Q : How do I use it?
A : Click the "Launch ET..." button on the welcome tab to make the quick-launch
dialog appear. In this dialog you can customize how you want ET to be launched.
Once you're done you can click on the "Generate" button near the bottom to 
generate the command line you can use to make a shortcut.

Note that I'm not going to bother detailling all the arguments. If you hate the
dialog, you can figure out the command line with a little trial and error. It's
not all that hard.


+------+
| Misc |
+------+

Q : I sooo want to frag you! Where can I do it?
A : On the Chicken Bucket's server. Shouldn't be hard to find since all the
default setting on ETM are set to the Chicken Bucket.



The Mysteries of the ini
------------------------

The ETManager.ini file contains the list of your settings. You can modify it as 
much as you like but you should know that it is only loaded once at startup. So 
ETM must be restarted for any changes to take effect. Also to reset any of the
settings, simply delete it. ETM will reload it's initial state at startup.

The ini follows this format :

    [group]
    key=value

Where :
   
   - Group : Is the name of the group that the settings belongs to.
   - Key : Is the name of the setting.
   - Value : Is the setting itself. You should only edit this.
   
Here's a list of a few settings that can be usefull to know about :


[global]

waitLaunch : If set to "1" then when launching ET, ETM will not close itself
until ET is closed. By default this is set to "0" for Windows users and to "1"
for Mac and Linux.


[rotation]

checkStartup : If set to "1", then the rotation tab will be refreshed when
switching from another tab.

calcCRC : If set to "1", then the CRC-32 will be calculated while loading the
local list.

clearRar : If set to "1", then after a download, any .rar files in the download
folder will be deleted.

clearXtra : If set to "1", then after a download, any file that isn't a .rar will 
be deleted.


[server]

checkStartup : If set to "1", then the server list will be refreshed when
switching from another tab.

queryTimeout : This setting represents the timeout period for a server query in
miliseconds.

waitBadServer : If set to "1", ETM will take a brief pause after a server query
fails.


[update]

checkStartup : If set to "1", then the update module will check for a new version
of ETM at startup.

[quicklaunch]

tkLoadTimeout : determines the number of seconds ETM will wait for ET before
giving up.



Translating ET Manager
----------------------

The translation files are situated in the ETManager.jar file (which can be 
opened with any archiving tools that supports the zip format) under the lang 
folder. When editing the file, you'll need to use a program that supports the
UTF format. For windows users, that means you should use wordpad instead of
notepad.

The format is pretty much the same as the ETManager.ini files, which is :

    [module]
    key=string\0
    #comments
	
The string is what you should be messing around with but before you start 
there are a few special characters that you should know of :

- \0 	: Every string must finish by one of these.
- \n	: To create an end of line. You can also just tap enter.
- \\	: If you need an "\" in your string, then use this.

If anything else follows the "\", then the "\" will be ignored and the rest will be
read normally.

You can also add comments in the lang file by adding a # at the begining of a line.
When a # is read at the begining of a line, the rest of that line will be ignored.
Comments can appear anywhere (even in the middle of a string) so you can use them
for whatever purpose you may like.

Now that you're done, you probably want to test it. Simply create a new folder
called "lang" in the folder where the ETManager.jar is located and place you're
translation there. Next time you start the program, the translation should appear 
in the language combo box on the welcome tab.

That's it! Now all you have to do is post your translation on the forum and I'll
add it to the next release.



Manually adding a Look and Feel
-------------------------------

This section will explain how to manually set or add a new Look And Feel (LnF). 
To do this you first have to understand how the ini file works. All the LnF 
related settings are located under the "lnf" group.

lnfCount        : This represent the number of custom LookAndFeel
lnf#Name		: The name of the LnF number #
lnf#Class       : The class name of the LnF number #
lnf#Jar         : The jar location of the LnF number #
LookAndFeel     : The index of the selected LookAndFeel. Can also be equal
                  to "Java" or "System" to access the default LnF.
                  
Here's an exemple with the default settings :

[global]
LookAndFeel=System
lnfCount=2
lnf1Name=Metal
lnf1Class=<...>
lnf2Name=Motif
lnf2Class=<...>    
           
              
Adding a new LnF :

  1. Start by raising the lnfCount by 1 :

    lnfCount=3
	
	
  2. Add a lnf#Name line and give your LnF a name :

    lnf3Name=MyLookAndFeel
	
	
  3. Add a lnf#Jar line and put the path to your jar file there :

    lnf3Jar=c:\program files\ETManager\LnF\MyLookAndFeel.jar
	
	
  4. Add a new lnf#Class line and put the path to your LookAndFeel class.
     You should be able to find this on the website of the LnF that you've
     downloaded.

    lnf3Class=org.potato.swing.lookandfeel.MyLookAndFeel


  5. See below.


Setting the new LnF using the LookAndFeel setting :

  - Set it to "System" if you want to use the default LookAndFeel for your OS.
    
    LookAndFeel=System
	
	
  - Set it to "Java" if you want to use the normal Java LookAndFeel.

    LookAndFeel=Java
	
	
  - Set it to a number to use one of the custom LookAndFeel.
	
    LookAndFeel=3



Thanks and stuff
----------------

This program was inspired by Klojo's CB Rotation Checker.

Uber thanks to Rashan for providing a website with COLORS!
Thanks to Rashan for testing this on linux.
Thanks to www.etmaps.de for powering the map downloads.

Thanks to the Chicken Bucket for being the best server EVER!
So make sure to visit www.chickenbucket.com
