AA:O Forward Observer

==================================================================
America's Army: Operations Forward Observer                          [12-06-2002]

BETA V 0.3.15 Release Documentation                               AAFO_Readme.txt
==================================================================
Summary:

        Community Made and Inspired Server Browser for America's Army: Operations
==================================================================
Author:		   	                             

Greg McIntosh          DivideByZero                  [email protected]
==================================================================
Lead Debugger and Idea Generator:
                                         
Jim Faulk              Vegitto
==================================================================
Website:                                                      www.MilitarySim.com
==================================================================
Beta Testers (alpha order):

Mike Matthews          [SOB]sllm             (www.sobservers.com)
Chris Dwyer            [UK1] Ninja
Rob Lindsay            ClickClickBoom
Tom Kolb               Sys-Error             (http://www.centaurtechnologies.com)
==================================================================

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

********************
News:
********************
I'm proud to announce that Forward Observer has a new official home at www.militarysim.com and I have joined its staff.  MilitarySim co-founder [Dev]Skorzeny has been generous enough to extend the offer, which includes a dedicated web page (to be updated soon), forum topic and file hosting.  AA:FO will still be mirrored at other community sites, but its home base will be at MilitarySim.  

I also want to say thank you to Delta at www.aafiles.com for his continued hosting and support.

MilitarySim's goal is to be a unifying factor for the AA:O community and to provide a focal point for information and resources.  Please show your support by spreading the word and dropping by the forums.


********************
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
AAOMaps.txt                     - AAFO list of America's Army Maps for filtering
PlayerList.txt                  - List of players online as of last server refresh

*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 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
 - Previous versions of Custom Server Lists and Buddy Lists *should* be compatible with this version of FO.  
 - If FO does not load with previous List versions, you will have to rebuild your Custom and Buddy Lists.  They are text files, so they can be opened in your default text editor.


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

--------------------
BETA 0.3.15
--------------------
[12-06-2002]

Enhancements:	
--------------------
* Replaced the "Update Server List from Web" option with an "Update Server Lists from MilitarySim.com" option.  It will download a zip containing pre-formatted server lists.  The new server list contains all 200 SCI servers and an updated UnofficialServer list.  It will be updated every day or so.

* Added a new filter option for connection type: "OC192" for the SCI servers.


--------------------
BETA 0.3.14
--------------------
[12-05-2002]

Bug Fixes:
--------------------
* Fixed "Error 91: crash when custom list is refreshed, Player list is opened and first player is selected
* Fixed bug that kept server double clicked in Player list from refreshing
* Server Intel and Player intel are now cleared after list refreshes - adding player to buddy list after list is refreshed didn't add server info correctly if the selected server in the list wasn't the one the player was on (player was on last server queried in list)


--------------------
BETA 0.3.13
--------------------
[12-03-2002]

Bug Fixes:
--------------------
* Gutted and rewrote Buddy List code.
* Added function to remove duplicates in Player List.


--------------------
BETA 0.3.11
--------------------
[11-30-2002]

Bug Fixes:
--------------------
* Fixed dissapearing buddies in buddy list.
* Removed blank button in toolbar
* Found place in code where a server data array wasn't being flushed - now less memory overhead is used


--------------------
BETA 0.3.10
--------------------
[11-30-2002]

Bug Fixes:
--------------------
* Fixed bug in Player list where Honor and Last Located weren't being saved correctly
* Fixed error generated when adding server to custom list when lists are filtered
* Upload Server List From Web disabled.  
  - This process is too cumbersome to keep.  
  - It worked well when FO first came out and there were less than 1,000 Unofficial/Authorized servers.  The list has grown to over 4,400 Unofficial/Authorized servers.  FO had to download the list from the AA website and then parse out all of the HTML tags to create a list.  
  -This process will be replaced (hopefully in the next couple of weeks) with something more efficient.



--------------------
BETA 0.3.9
--------------------
[11-29-2002]

Enhancements:	
--------------------
* Added Player List icon to toolbar
* Added Server Password functionality and icon to toolbar
* Added SCI Servers to Official Server List


--------------------
BETA 0.3.8
--------------------
[11-24-2002]

Bug Fixes:
--------------------
* Resloved: Error generated when creating a Custom List manually and leaving the IP field blank.
* Resolved: Error generated when a malformed IP address contains more than one port number.  FO will try to use the first port it sees.


--------------------
BETA 0.3.7
--------------------
[11-24-2002]

Bug Fixes:
--------------------
* Resolved: "Run time error 91, object variable or With block variable not set." when double-clicking a server list that has nothing listed.

Enhancements:	
--------------------
* Added America's Army Version 1.40 support: Server - team score, round count, mission time; Player: Honor


--------------------
BETA 0.3.6
--------------------
[11-22-2002]

Bug Fixes:
--------------------
* Resolved: "Function_UpdateLastPlayedERROR:75 Path/File access error" - caused by type in code that scans server list names.
* Map titles are now updated from Official and Custom server lists.  Beta servers can be added to the custom list and new maps will be added to the map filter option.
* Update Server List From Web: added progress bar and option to cancel out if it's taking too long.  Fixes "Not Responding" problem when updating list from web.
* Added better error handling for LoadList function - resolves crash associated with corrupt server lists


--------------------
BETA 0.3.5
--------------------
[11-21-2002]

Bug Fixes:
--------------------
* Added code to check to see if a port is available *before* binding it to one of the query sockets (duh!)
  "Resolves: Function_MultiProcessERROR: 10048 - Address in use" error


--------------------
BETA 0.3.4
--------------------
[11-19-2002]


Enhancements:	
--------------------
* Added a few extra error handlers to the multi-socket coding.
* Updating documentation for beta testing.


--------------------
BETA 0.3.3
--------------------
[11-05-2002]

Enhancements:	
--------------------
* Added "Hide Inactive Servers" filter option.

--------------------
BETA 0.3.2
--------------------
[10-23-2002]

Bug Fixes:
--------------------
* Added better error handling
* Fixed Player List sorting
* Map names now stored in file and automatically load to reflect new maps
* Fixed stop query function


Enhancements:	
--------------------
* Added Show/Hide Non-responding servers filter
* Server monitoring interval now stored in config file
* Max number of threads for server list querying is configurable between 1 and 100 (100 = default)
* Added ability to join server from player list
* Cleaned up query progress bar window

--------------------
BETA 0.3.0
--------------------
[10-20-2002]

Bug Fixes:
--------------------
* Rewrote server list checkbox code, clears up issue of not being able to run server queries from toolbar after cancelling query.
* Fixed false "Not Running Game" messages
* Optimized packet management - reduced memory consumption and packet processing
* Optimized timeout handling
* Updating Server Lists from web will no longer wipe out server playing history


Enhancements:	
--------------------
* Added multi-socketed querying - huge performance boost.  
  - Average Official Server List query time dropped from 45 seconds to 25.
  - Average Unofficial Server List - query time dropped from 40 minutes to 90 seconds!
* Added Player List - Once server lists are refreshed, a player list is built.
  - Can do full or partial matches on player name
  - Click on player name in returned results to find player in list.
  - Right click player in player list to add to buddy list
  - Able to sort player list by columns and rearrange order of columns
* Buddy list is sortable
* Added "Last Played" column
* Added XP Theme support.  Now all buttons, scroll bars, etc. will look like XP style ones.
  
--------------------
BETA 0.2.14
--------------------
[10-12-2002]

Bug Fixes:
--------------------
* Fixed compatability issues with AA:0 Version 1.3 new scoring system.  The packet variable "frags" has been replaced by "enemy", "kia" and "roe".  Modifications to the Player Intel list have been made to reflect this.
* Version 1.3.0 servers will display Name, Enemy, KIA, ROE and Ping in the Player Intel list.
* Version 1.2.1 servers will display Name, Enemy (from the "frags" packet data) and Ping.  KIA and ROE are blank because they don't exist in the version 1.2.1 code base.


--------------------
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......  :)
  UPDATE 11/05/2002: Stopped counting.......  :)

* Thanks to [Dev]Skorzeny and Bizon at www.militarysim.com for providing a new home for FO.

* Thanks to [UK1] Ninja for his continued support.

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

* 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:
********************
- ICQ integration ---> CLOSE!!!!!  (UPDATE: on hold for right now.)
- 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>
DivideByZero@militarysim.com
ICQ #53888802


Please give feedback!!!