--------------------------------------------------------------------------------
ReadMe.txt for wswBrowser by Alex 'Cl1maX' Foreman
--------------------------------------------------------------------------------

Contents:
1. About
2. Installation and Setup
3. How to use
4. Current Milestones for releases
5. Contributions

--------------------------------------------------------------------------------
1. About
--------------------------------------------------------------------------------
wswBrowser is a free server browser for warsow (warsow.net) server information.
It lets the user discover information about servers from the desktop and enables
them to launch warsow directly connecting to the specified server.

It is portable, lightweight, multilingual application which should run on any OS 
with a Java 5 (1.5) JVM or higher.  (not 1.4 and below not supported.)

--------------------------------------------------------------------------------
2. Installation and Setup
--------------------------------------------------------------------------------
Firstly you need a Java 5 (or higher) JVM installed.  If you currently do not 
have one then you can get it from http://java.sun.com

Once you have Java installed you can un-compress this file anywhere on your 
file-system.  Inside the folder you will get a directory stucture like this:

<parentFolder>				-> the folder you extracted to	(eg 'c:/games/')
	|
	<wswBrowser Folder>		-> the wswBrowser folder 
		|
		|-ReadMe.txt		->	This file
		|
		|-wswBrowser.jar	->	The wswBrowser application in jar form
		|
		|-docs/				->	A docs folder holds documentation about the 
		|						program.  (Help / Changelogs etc)
		|
		|-lib/				->	resources used by wswBrowser (graphics etc)

There is one file which you have to currently modify to use wswBrowsers launch 
mechanism.  This is  lib/wswBrowser.properties.  In this text file there is a 
property called 'wswDirectory=/home/alex/warsow'.  You need to change this to 
where you installed warsow on your own machine. 
eg if warsow.exe is found at C:/Program Files/warsow/warsow.exe, then you would 
change this property to : 'wswDirectory=C:/Program Files/warsow'

PLEASE NOTE:  You currently need to use forward slashes on unix and windows 
systems.

You can run this program in a variety of ways.
Either double click the jar file if your machine is set up to launch jar files.
or 'java -jar wswBrowser.jar' In the directory with the jar file in.
I find it easy to create a bash script which changes to the correct directory 
and execs it all in one.  Then i can create a short cut on my desktop which 
launches it easily.

--------------------------------------------------------------------------------
3. How to use
--------------------------------------------------------------------------------
Once loaded you can refresh the server list with the refresh button.
Double clicking on a server or clicking the 'FIGHT!' button launches warsow and 
connects to the selected server.

The advanced server information and player information is available on the right
of the server list.

Right clicking a server gives you an option to copy the servers ip:port and also
the name if desired to the System clipboard to enable ips to be easily pasted 
into irc.  The list automatically copies the ip:port to the clipboard by middle-
clicking the mouse or using 'CTRL-C' via the keyboard.

--------------------------------------------------------------------------------
4. Current Milestones for releases
--------------------------------------------------------------------------------

Once M3 is complete a bug fix will commence ending with a full release candidate
After this I will implement releases with features requested by the warsow
community.  Find me in #warsow on quakenet if you would like any features added
or can identify any bugs :).

M3	Work in progress
	Bug fix release before Version 1
	Setup Program to automate maintainance of wwProperties file.
	Player Search and Filters					*done*
	Nicer updating of table.					*done*
	Table keeps selected server on refresh				*done*
	ServerTimeout property used.					*done*
	Server Refreshing on application launch property 		*done*
	Battle eye and Bots added to Server information			*done*
	update language translations as they are now out of date

M2	*Complete*
	Properties file for advanced specific choices.
	Multilingual Support for four languages added.
	Faster multithreaded server querying.
	Advanced Server and players screen
	Ability to place wswBrowser anywhere on filesystem
	Docs folder added for documentation
	Server information Copying to system Clipboard
	
M1	*Complete*
	Basic working server querying and game launching

--------------------------------------------------------------------------------
5. Contributions
--------------------------------------------------------------------------------
Head Programmer and Designer: Alex Foreman (Cl1maX)

Translators: KoFFie, patman, chtstorm

Graphics conversions: EvilBob

Testing: Warsow team members, EvilBob,

Also contributed : BE|Sable bug fix.

--------------------------------------------------------------------------------
End of Document
