** | ET Manager 2.0.1 | ** 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? - I only want module X and hate everything else. How do I only make the module X come up? - I'm using Linux or Mac and I can't launch ET from ET Manager. Why? - How do I change the language that ET Manager uses?
- Welcome tab : - What is this "Look And Feel" thing? - Which server will the "Connect to the server." button take me to?
- 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" work?
- Pk3 Explorer : - The program is having trouble loading the local list. How do I fix it? - I just hate scroll bars! Is there a way to make things fit better? - Pk3 List : - What are the 3 options for? - How can I browse a folder that's not in the list? - How do I remove unwanted folders? - Why is one of my folder showing up as a leaf? - Why can't I find the stock maps? - Pk3 details : - Why does the CRC-32 field display ? - How do I display details for a rotation or a map? - Why is the map list showing up grey (disabled)? - Map details : - The pictures are too small! How do I enlarge them? - Now the picture is WAY too big! How do I close the window? - How do I test a map? - The map won't launch! Why? - Favorite Servers : - Server list : - Why can't ETM reach a server? - What's the X beside my server? - How do I view the details for a server? - Server Details : - 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?
- Quick-Launch : - What's Quick-Launch? - What are the arguments? - What's the "-ip" switch? - What's the "-sv" switch? - What's the "-url" switch? - Can I get some exemples? - 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 will have to use the .bat or the .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 : I only want module X and hate everything else. How do I only make the module 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 : I'm using Linux or Mac and I can't launch ET from ET Manager. Why? A : Well before you can launch ET, you must first set the "etlaunchpath" setting in the "global" group. It should be set to the absolute path to your ET executable. Windows user don't have to worry cause this setting is set automaticly.
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.
++ | 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.
Q : Which server will the "Connect to the server." button take me to? A : By default it will connect you to the Chicken Bucket. You can change this by going in the ini file and changing the "serverip" in the "welcome" group. Simply put the ip of the server you want, and that's it.
++ | 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 :
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" 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 : I just hate scroll bars! Is there a way to make things fit better? A : The Pk3 Explorer simply won't fit in the normal ETM window size. So it's better if you maximize the window or at least enlarge it. It's also possible to resize the pk3 list using the resizing bar situated to it's right.
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 : How can I browse a folder that's not in the list? A : Simply right click on the pk3 list, then select the "Add a folder" option. You will be prompted to choose the folder you want to add. Note that any folders added here will be taken in consideration in the rotation checker.
Q : How do I remove unwanted folders? A : Simply select the folder you want to remove or any of it's children. Then left click on the pk3 list and select the "Remove folder" option. Note that the etmain and the backup folder cannot be removed.
Q : Why is one of my folder showing up as a leaf? A : This means that the folder doesn't contain any pk3 files.
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 ? 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 : How do I display details for a rotation or a map? A : Simply select the map or rotation you want to display.
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 pictures are too small! How do I enlarge them? A : Click on them.
Q : Now the picture is WAY too big! How do I close the window? A : Click on it or use the Alt + F4 key combination.
Q : How do I test a map? A : You firt need to bring up the map details for the given map. Then open the "Launch" tab near the bottom. Then click the "Launch this map" button. If you want, you can edit the arguments that ET will be started with. Just remember that "%map%" must appear somewhere and that it will be replaced by the name of the map.
Q : The map won't launch! Why? A : By default, the arguments are set to launch etpro. So if you don't have etpro installed or have not installed the full etpro package (client AND server), etpro won't be able to start a server. To fix this, you can either get the full etpro version here :
http://bani.anime.net/etpro/ or you can remove the "+fs_game etpro" argument. Note that the etpro package downloaded when connecting to an etpro server is not enough.
++ | Favorite Servers | ++
Q : Why can't ETM reach a server? A : ET relies on the UDP protocol to transmit a server status. Since UDP is an extremly unreliable protocol and since ETM only does one pass per server, chances are that a packet simply got lost. Just try to refresh your server list again. You may want to try to alter the "queryTimeout" setting in the "server" group. Augmenting the timeout period may improve chances of success.
Q : What's the X beside my server? A : It's used to remove the server. You can also select a server and press the "del" key. 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. Server Details
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. If you want me to add support for a mod, simply give me the ip adresse of a server running the mod, and I'll add support for it in the next release. 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 : Run the Updater.jar file that should have been downloaded along with the update. You can use this command line :
java -classpath Updater.jar etm.update.Updater
++ | 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 : To start it, use : java -classpath ETManager.jar etm.quicklaunch.Main [-ip:host[:port]] [-sv] [-url[:mapurl]] all in one line. The "" represents arguments that are optional.
Q : What's the "-ip" switch? A : This switch allows you to specify which server you want to connect to. The "host" argument represents the ip to the server. By default if the "-ip" switch is not present, then quick-launch will use the "serverip" setting in the "welcome" group. If the "port" argument is not present, then it will use "27960" which is the default ET port.
Q : What's the "-sv" switch? A : This switch allows you to check if a server is empty or full before attempting to connect to it. If the check fails, ETM will be launched to alert you.
Q : What's the "-url" switch? A : This switch allows you to check your rotation before connecting to the server. If you are missing a file, then ETM will be launch to alert you. The "mapurl" argument represents the url to the rotation file you want to check. If it is not present, it will use the "url1" setting in the "rotation" group. If the "-url" switch is not present, then the rotation will not be checked.
Q : Can I get some exemples? A : Sure why not. Note that the following exemples would be typed on one line. This exemple makes full use of all arguments :
java -classpath ETManager.jar etm.quicklaunch.Main -ip:127.0.0.1:27960 -sv -url:http://www.ilikepotatoes.com/maps.txt
This exemple only used minimal settings without removing any of the checks :
java -classpath ETManager.jar etm.quicklaunch.Main -ip:127.0.0.1 -sv -url This exemple only connects to a given server without doing any checks :
java -classpath ETManager.jar etm.quicklaunch.Main -ip:127.0.0.1
++ | 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.
The ini follows this format :
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 :
etlaunchpath : This setting is explained in the Global section of this readme. It should be set to the absolute path to the ET executable. Windows users don't have to worry about it because it will be set automaticly when the etpath is changed.
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.
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.
closeLaunch : If set to "1", then ETM will be closed after launching a map.
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.
checkStartup : If set to "1", then the update module will check for a new version of ETM at startup.
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 open the ETManager.jar file with an archiving tool that supports the zip format, and then go to the lang folder. Place your 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.
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
There are no comments yet. Be the first!