Skulltag Server Browser Readme                              Last Updated: 0.2A
================================================================================

First Run
-----------------------------

To start you must be using Java version 1.6 which can be found at
http://java.sun.com/.  If you are unsure what version of Java you are running
attempt to start the program and if you get a Main-Class error then you need to
update.

Running the program, for most people, is a simple matter of double clicking the
jar file.  However if that does not work then locate your Java binary (java.exe
for those running Windows) as execute the following command.  (Changing java
into the full path and binary name.)

java -jar browser.jar

When done it should start querying server right away.  But you are not ready to
start playing just yet.  Go to the browser menu and then click configure and
set up all of your paths.

Command Line Parameters
-----------------------------

Append the following to the command line:

-debug             Prevents the browser from querying servers upon start up,
                   prints extra information to the console, and the browser
                   not join servers.
-config <path>     Changes the location of your config file for this run.

Known Bugs
-----------------------------

- Certain players have characters before their names.  This particular bug will
  not be fixed until I create my own multi-line tool tip class.
  Update for 0.2A: The \c- and \c+ fix solved most of this but it still seems 
  to happen.

Q&A
-----------------------------

Q. I'm running Debian or one of its derivatives and a lot of the servers seem
   to be missing information.  Is this a bug?
A. I have looked into this and have found that Java (and possibly other
   programs) are not being sent the whole packet.  There is a work around.  Go
   to the configure dialog and enable "Query in two passes (not recommended)".
   When you query servers all of them will initially show up as being
   cooperative, but after the servers are found it will take a second pass
   fetching the game modes.  I have found that this does not work 100% of the
   time, but most of the time it will.

Q. Can I add more URLs to search for wads?
A. Yes, open your browser.cfg and add another "wadSearchURL".  It works by
   adding the name of the wad to the url so the URL has to be a directory of
   wads and there must the a slash at the end.

Q. The program is claiming that I need a wad that I must buy.  Where can I
   purchase such an old game.
A. If the game is Doom, Heretic, or Hexen you can purchase the games on Steam.
   http://steampowered.com/
   However, if you are like me and won't settle for a soft copy of your games,
   you will have to look around eBay and other sites.  Do not ask for someone
   to send you the files.

Q. I found a bug where can I report it.
A. Look for the bug tracker on bitowl.com.  Further instructions are located 
   there.

Change Log
================================================================================

Version 0.2A
-----------------------------
- Added: Options to copy the server's name.
- Added: Ctrl+Z will copy the server's IP to the system's clip board.
- Fixed: Pressing the button to refresh the selected server refreshed the wrong 
  server.
- Fixed: Players image would show too many people as spectating.
- Fixed: \c- and \c+ was not filtered in player names.  Also a comma was added 
  to the end of the player's list.
- Widened a few of the columns to fit Linux's default font.

Version 0.1A
-----------------------------
- Initial Release

================================================================================
Created by: Blzut3                                            http://bitowl.com/
