AA:O Forward Observer CORE

==================================================================
America's Army: Operations Forward Observer                          [09-01-2002]

                           BETA V 0.2.12 Release Documentation -- AAFO_Readme.txt
==================================================================
Summary:

        Community Made and Inspired Server Browser for America's Army: Operations
==================================================================
Author:		   	                             Greg "DivideByZero" McIntosh

Lead Debugger and Idea Generator:                                         Vegitto
==================================================================

********************
Contents:
********************
* Build Info.
* Installation Instructions
* Release Notes
* Thank Yous
* Planned Enhancements
* Quasi-legal stuff
* Contact Info


********************
Build Info:
********************
VB6 				- Service Pack 5	
AAForwardObserver.exe		- the executable
AAFO.cfg			- configuration file (contents accessed by clicking the "Config" item in the Options menu.)
OfficialServerList.txt		- AAFO list for official servers*		
UnOfficialServerList.txt	- AAFO list for unofficial servers*
CustomServerList.txt		- Your custom list - once one is generated
BuddyList.txt 			- Your buddy list - once it's created

*Note: The server lists are from the America's Army website: http://americasarmy.com/account/serverlist/list.php.



********************
Installation:
********************

New Install:
 - If your PC already has the VB6 SP5 runtimes and components, you may be able to just use the CORE install 
   and unzip the AAForwardObserver.exe executable, config file and server lists into a folder and run the executable.
 - If you do not have VB6 SP5 runtimes and components, run Setup.exe in the FULL install zip file.
 - The full install will install and register the VB6 runtime library and all associated 
   ActiveX controls.  The setup will install all of the resources, ActiveX controls and.DLLs into
   the AAFO dedicated folder, NOT the system folder.

Upgrade:
 - Unzip the CORE install into your Forward Observer Folder and run AAForwardObserver.exe



********************
Release Notes:
********************

--------------------
BETA 0.2.12
--------------------
[08-30-2002]

Bug Fixes:
--------------------
* Fixed IP sorting
* Before AA is launched to join a server, Forward Observer will verify that a player slot is open.

Enhancements:	
--------------------
* Added toolbar - most major functions can be accessed from it
* Replaced top row of buttons (IP, Query and Join) with toolbar
* Modified about window
* Added countdown progress bar on toolbar for monitoring
* Made label changes for server monitoring, etc to make them consistent between the menu and toolbar.

--------------------
BETA 0.2.11
--------------------
[08-25-2002]

Bug Fixes:
--------------------
* Can't query individual servers when querying whole list(s)
* Can't sort columns when querying list(s)

--------------------
BETA 0.2.10
--------------------
[08-24-2002]

Bug Fixes:
--------------------
* Fixed Server intel list problem: couldn't see last line when the screen is maximized
* Server lists now stored in a file that uses the ÿ (Hex FF) as a delimiter.  
  - Some unofficial servers use commas in their names, so a comma-delimited file caused problems
* Removed "Add To Custom Server List" from popup menu when right-clicking a Custom Server
* Buddy Lists matching no longer case-sensitive
* Fixed runaway pings
* Fixed bug when adding to sorted custom list

Enhancements:	
--------------------
* Map list in filter window is now dynamic, so new maps should automatically be listed
* URL for Load Server List from AA website is now configurable
* Recoded the way AAFO determines if a server times out or is not hosting a game.
  - Now returns more verbose info.
  - Query speed increased
* Modified Connection filter to be "Greater Than or Equal to" selected type
* Added "Stop Monitoring Server" to right-click popup menu
* The link to the official Army Operations website server list is now configurable


--------------------
BETA 0.2.9
--------------------
[08-18-2002]

Bug Fixes:
--------------------
* Rewrote ping function, it's much more accurate and I *think* it'll fix the Error 6 overflow issue.
* Fixed crash when querying an official or unofficial list and then clicking on a server in the custom list

Enhancements:	
--------------------
* Added color scheme support in configuration window
* When lists are being refreshed, the current server turns white, so you can see what server is being queried.


--------------------
BETA 0.2.8
--------------------
[08-17-2002] 

Bug Fixes:	
--------------------
* Selecting clear button on filter window will clear list and selected values above

Enhancements:	
--------------------
* Added right click menu to server lists:  
  - refresh selected server, 
  - refresh selected server list,
  - monitor selected server,
  - join selected server,
  - add selected server to custom list

* Added right click menu to player list to add selected player to buddy list


--------------------
BETA 0.2.7
--------------------
[08-13-2002] 

Enhancements:	
--------------------
* Added ability to use all filters at once
* Filter settings are saved once they're applied and cleared when the filter list is cleared
* Filters no longer blow away server lists (oops)
* Fixed default setting display for Query Port and Firewall in Config window
* Stop monitoring server function fixed


--------------------
BETA 0.2.6
--------------------
[08-11-2002] 

Enhancements:	
--------------------
* Added server filtering (by ping, max number of players, number of players, map name and connection type)


--------------------
BETA 0.2.5
--------------------
[08-08-2002] 

Enhancements:	
--------------------
* Enhanced buddy list functionality:
  - can now get server info for located buddys and can join server buddy is on
  - clicking on buddy refreshes server they were last located on
* Window sizing rescales the list views
* Added option to Hide/Show the Server and Player Intel lists to expand the Server list panes/tabs
* Selected server remain highlighted when querying it, selection is cleared if a tab is clicked


--------------------
BETA 0.2.4
--------------------
[08-01-2002] 

Bug Fixes:	
--------------------
* Still trying to track down the Error 6 overflow bug.  If someone gets it, please email me with system specs, connection info (cable modem, dsl, dialup, ec.) and a screenshot.  I'd love to nail down this sucker for good!

Enhancements:	
--------------------
* Official, Unofficial and Custom lists are now saved automatically!
* Server columns can now be sorted by clicking on the headers.
* Server columns can now be rearranged by dragging them.
* Added buddy list support.
* The window is sizable.


--------------------
PUBLIC RELEASE #2
BETA 0.2.3
--------------------
[08-01-2002] 

Bug Fixes:	
--------------------
* Bug in code fixed to allow the display of server data from AA version 1.1.1 servers.


--------------------
PUBLIC RELEASE #1
BETA 0.2.2 
--------------------
[07-26-2002] 

Bug Fixes:	
--------------------
* Reset server counts on list tabs when refreshing server lists.

Known Issues:
--------------------
- Slower connections may experience skipping between servers during a list query, causing blank results for servers that normally would respond.  Requering the blank servers will return correct results.


--------------------
BETA 0.2.1
--------------------
[07-27-2002] 

Bug Fixes:	
--------------------
* Reset player and server counts between list querys
* Fixed crash that was generated when remove server button was clicked and no server selected
* Fixed inability to requery individual servers once the stop query button was clicked
* Added info message to user once custom server was added with Option dialogue, reset fields
* Fixed rare out of bounds error that sometimes happens when the program tries to query the max number of servers + 1.  <hmmm...>
* Modified behavior of add and remove buttons for custom server lists so only valid selections are added/subtracted


--------------------
BETA 0.2.0
--------------------
[07-26-2002]

Enhancements:	
--------------------
* Added Unofficial List support
* Added Custom List support - you can build them from scratch or add Official or Unofficial lists
* Custom Lists are saved when you exit the program
* Added ability to query selected server lists!
  NOTE: The query can get bogged down when it hits the unofficial list.  There are over 1400 Unofficial servers, most are inactive and time out (at 3 -5 seconds each, it adds up).  You can hit the "Stop Query" button at any time to stop it.
* Double-click on the listed server for an automatic query
* Query All function also gives total number of players on-line (cool statistic)
* Improved interface
* Moved Config and Update Server List from Web to Options menu 
* Gutted code to retrieve server lists from AA website - it's more robust, but the parsing is a little bit slower.

Fixes:
--------------------
* Fixed the three bugs listed below.


--------------------
BETA 0.1.0
--------------------
[07-21-2002]

Known Issues:
--------------------
- Only Official and registered servers respond to queries.  I believe that this is an AA
  issue.

- Ocassional problem with server list packet parsing:  team name sometimes reads as "ame"
  * To get around this, requery the server.
 - The server list is obtained by capturing the text from the America's Army server list on
  the official website: http://americasarmy.com/account/serverlist/list.php.  
  

********************
Thank Yous:
********************
* Thank you to my wife and kids for putting up with me while working on this program,
  so far I've spent over 50 hours on it (that's after 13 hour work days.)
  UPDATE 08/23/2002:  It's now been over 200 hours......  :)

* Thanks to The_General at www.armyoperations.com for responding to my initial posts and providing the bandwidth so you guys can get this program.  Don't forget to go to his site!

* Thanks to Ron Mercer - the_DM-Ohio from www.qtracker.com for giving me a couple of important pointers

* Thanks to all the beta testers - I appreciate your help!
  * Vegitto - Thanks for burning the midnight oil with me to hash the last minute issues out! You can beta for me ANY TIME!  :)  www.cs-kilrahti.net
  * Ez - For also staying up late and for being willing to be a ginuea pig for a couple of last minute tweaks.
  * The_General at www.armyoperations.com
  * [RIP]Hydra - check out his server utility: 
    http://www.americasarmy.com/forum/viewtopic.php?topic=7354&forum=5 for the link
  * ragingsamster
  * Mike D

* The Army Game Project for putting out such a great game!

* Thanks to all of you on the message boards and IRC for giving positive feedback.  It kept me going at 4AM!
  
* I appologize if I missed anyone (let me know if I did!)


********************
Planned Enhancements:
********************
- Next Major release: query speed ---> Getting there
- ICQ integration ---> CLOSE!!!!!
- Still looking at other possibilities.


********************
Quasi-Legal Stuff:
********************
AA Forward Observer - Copyright 2002 - Greg McIntosh <DivideByZero>

This software is provided as is without guarantees. The user assumes responsibility
for use of this software and shall not hold the author responsible for any damages 
that may be incurred from its use.

This software may only be distributed with the express written consent of its author.  
The author shall maintain distribution and ownership rights.

America's Army: Operations is copyrighted 2002 - Army Game Project


********************
Contact Information:
********************
Greg McIntosh <DivideByZero>
[email protected]   (Note: that's a number 'zero' at the end of my handle, not a letter 'o'.)
ICQ #53888802


Please give feedback!!!