*************************************************************
Lords of Gyrne Field Assistant Version 2.2.0
  2000, 2001, 2002, 2003 Fabian Rueger
 
INSTALLATION INSTRUCTIONS / INSTALLATIONSANLEITUNG: 
These instructions are in both English and German.  Only the version history
 is in English only, and trails the German part of the readme.
 
Die deutschen Installationshinweise finden sie weiter unten hinter 
den englischen. Nur die technischen Entwicklungsvermerke sind in Englisch. 

-----------------------------------------------------------
Welcome to the Lords of Gyrne Field Assistant!

WHAT'S NEW?
For those who don't want to read all of this, and already know the
earlier versions:

We've fixed a number of bugs that were still there in the Field
Assistant 2.1, and have introduced the Lords of Gyrne Chat (LoGyC)! With
LoGyC, you can meet other Gyrne players in a chat room while doing your
orders. It's fun and easy, and has been tested on the Mac, Windows 98
and 2000, so there is no reason it shouldn't work with XP. Read the
version history below for the exact fixes and changes.

WHAT'S IMPORTANT?
Please note that this program must be started from a writable medium
(e.g. a hard disk) from within a directory.  Please do not install it in
a root folder (C:\) but in a subdirectory.

To run the program you will need a Gyrne map file. These map files are
JPG images with additional internal data. Note that you cannot tell from
the outside whether a JPG is a Gyrne map or a regular image. Map files
for Gyrne can always be obtained at:
http://www.gyrne.de

Upon startup, the Field Assistant requires that you load such a map.

Choose this file in the window that shows up, and once the Field
Assistant window opens, open the Preferences window (Edit
Menu->Preferences) and set this file as your standard map for this
setting. Next time you start the Field Assistant it will automatically
load that map.

In the Preferences Window you can also set standard directories
(folders) for the Field Assistant to look for Maps. Note that the Deputy
Window (Ctrl-D on Windows, Command-D on a Mac) provides contextual help
and introductions to most topics concerning the game and the Field
Assistant.

	You can also access the Preferences Window directly without having to load a
	map first by keeping the 'P'-Key pressed during program launch. You might
	need to begin pressing the key right after the double-click.

Furthermore, the program has an automatic error reporting service. If a
grave error should occur, such a window will popup with details of the
problem. You could help us by sending this report, by clicking the
appropriate button in the window. Please report each error quickly,
and only once. You can also send your own report any time by choosing
"About L.o.G. 3" in the menu. 


TROUBLESHOOTING / KNOWN ISSUES:

WINDOWS: 
"When I have music running on my PC the Field Assistant won't
start":
	The Field Assistant might not run properly when certain MP3 players
	are being simultaneously played or TV is watched via a TVcard. In that
	case you will have to choose between either music or the Field
	Assistant sounds. To have music or TV running in the background, start
	only the Field Assistant, turn off the Field Assistant sound in the
	Preferences, and then start your other software.

"Why are there 2 copies running?":
	It is possible to simultaneously start 2 Field Assistants; they might
	interfere with each other when trying to access the .INI-file or the
	music simultaneously. This is a (not very well known) Windows system
	paradigma.

MACINTOSH:

No problems known.

----------------------------------------------------------- 
Willkommen beim Lords of Gyrne Field Assistant!

WAS IST NEU?
Fr die die keine Geduld haben das hier alles zu lesen, und bereits die
 Vorgnger-Versionen kennen:

Wir haben einige Fehler behoben die noch im FA 2.1 nicht behoben waren,
und ausserdem den Lords of Gyrne Chat (LoGyC) eingefhrt! Mit LoGyC kann
man andere Gyrne-Spieler in einem Chatroom treffen whrend man den FA
aufhat. Es ist leicht zu benutzen und bereits getestet mit Windows 98,
dem Mac und Windows 2000. Es sollte also auch problemlos auf XP laufen.
Fr eine komplette Liste der nderungen siehe unten.

WAS IST WICHTIG:
Bitte beachten sie das dieses Programm von einem beschreibbaren Medium
(z.B. einer Festplatte) gestartet werden muss, also bspw. nicht von
einer CD.  Auf Windows sollte das Programm auerdem in einem
Unterverzeichnis liegen und sollte nicht direkt auf der Root-Ebene (z.B.
direkt in "C:/") liegen.

Um dieses Programm zu verwenden bentigen sie eine Gyrne-Kartendatei.
Eine solche Kartendatei ist ein JPG-Image mit besonderen internen Daten.
Bitte beachten Sie das der Unterschied zwischen einem normalen Bild
(JPG) und einer Gyrne-Kartendatei nicht von aussen erkennbar ist.
Gyrne-Kartendateien sind erhltlich von unserem website:
http://www.gyrne.de

Beim Starten verlangt der Field Assistant nach einer solchen
Karten-Datei. Whlen sie diese in dem sich ffnenden Fenster, und
sobald das Field Assistant-Hauptfenster sich ffnet, stellen sie diese
Datei erst einmal als ihre Standard-Karte fr ihre Settings im
Preferences-Fenster ein. Dieses erreichen sie durch das Men
Edit->Preferences.  Beim nchsten Starten wird der Field Assistant diese
Karte dann automatisch laden.

	Man kann beim Starten auch direkt das Preferences-Fenster aufrufen
	ohne die eingestellte Standard-Karte laden zu mssen, indem man die
	P-Taste gedrckt hlt. Dazu sollte man die Taste gedrckt halten und
	dann das Programm durch Doppelklick starten, bis das
	Preferences-Fenster erscheint. Unter Umstnden ist es ntig die
	P-Taste erst direkt nach dem Doppelklick zu drcken.

Im Preferences Fenster knnen sie auch Standard-Verzeichnisse (Folder)
fr den Field Assistant einstellen, in dem er nach Karten Ausschau
halten soll.

Die genaue Gebrauchsanweisung entnehmen sie bitte dem Handbuch. Im
brigen stellt der Field Assistant aber eine eigene kontextbezogene
Hilfe bereit, den "Deputy". Diesen knnen sie ber das Men Edit ->
Toggle Deputy, oder per Shortcut Strg-D (Ctrl-D, auf Apple Command-D),
oder ber den Zuschaltknopf "Deputy on/off" zu- und wegschalten.

Es gibt ausserdem ein automatisches Fehlermelde-Fenster, mit dem man
auftretendende Fehler sofort an alarm@gyrne.de weiterleiten kann. Es
ffnet sich automatisch wenn ein schwerer Programmfehler auftritt,
oder kann extra aufgerufen werden ber den Menpunkt "About L.o.G.3
Field Assistant". Sollten beim Versenden der Orders Probleme
auftreten, kann man durch Drcken der Taste 'V' ein ebensolches
Fenster aufrufen um die Kommunikation zwischen Server und Client
anzusehen; das Weiterleiten derselben hilft unter Umstnden beim
Problemlsen. ffnet sich ein solches Fenster von selbst, den
auftretenden Fehler bitte sofort, aber nur einmal, einschicken. Das
Fehler-Reportfenster kann natrlich nur dann einen Report versenden
wenn der Fehler das mailing selbst nicht betrifft.


PROBLEMBESEITIGUNG/BEKANNTE PROBLEME:

WINDOWS: 
"Wenn ich Musik laufen habe auf dem PC startet der Field
Assistant nicht/macht Probleme": 
	Der Field Assistant kann nicht anstndig auf die Soundroutinen von
	lteren Versionen von DirectX zugreifen wenn diese durch ein anderes
	Programm (wie einen MP3 Player) belegt sind.  In diesem Fall mssen
	sie leider zwischen Musik oder den Field Assistant Sounds whlen.  Um
	Musik im Hintergrund laufen zu lassen, mssen sie den Sound des Field
	Assistants erst in den Preferences ausschalten, und danach erst die
	Musiksoftware starten. Dieses Problem tauchte nicht auf bei Windows 98
	Systemen die DirectX Version 7 verwendeten.

"Wieso knnen zwei Kopien laufen?":
	Der Field Assistant berprft nicht ob eine weitere Kopie seiner
	selbst gerade aktiv ist; es ist also mglich, zwei Field Assistants
	gleichzeitig laufen zu lassen; dies ist ein (weitgehend unbekanntes
	aber gewolltes) Windows System-Paradigma; es kann zum Absturz fhren.

MACINTOSH:

Keine bekannten Probleme.


*****************************************************************************
 VERSION HISTORY OF THE GYRNE TYPER / FIELD ASSISTANT:
****************************************
Lords of Gyrne Field Assistant, Version 2.2.0 (Release Version):
	-> Users can now send private messages to selected players, or speak
	publicly to all.
	-> Sent messages are now text en- and decoded, so that special
	characters (eg. German umlauts) are preserved.
	-> Automatic chat logging now adds a chat time stamp to top of list to
	keep better track of recorded chats in text files.
	-> Users can now turn on or off sound in the chat options window,
	telling them of new users joining, sending a message, or leaving.
	-> By shift-clicking on a county popup menu, users can now set ALL
	county popup menus to this county, to increase the speed of entering
	data.
	-> On Win32, pressing the hide button within the chat window should
	now drop the window into the task bar.

****************************************
Lords of Gyrne Field Assistant, Version 2.2. Beta 1 (First Test Version)
	-> In Windows XP, FA should now be able to correctly open JPEGs as well
	as JPGs if Gyrne map files are designated as such.
	-> Corrected tab order of controls in FA.
	-> Introduced nicer message windows.
	-> The FA now remembers the last placement and size of the Deputy
	Window.
	-> The Preferences Sets can now be named (a feature request by Armin
	Kirstein). Just shift-click on a name of a preferences set and enter
	your name for it. For instance, if you play two players in the same
	game, you can name your sets accordingly (e.g. GRIMSIEGE 1 and GRIMSIEGE
	2) - or whatever you like.
	-> Fixed error that would occur when user would not supply a map on
	startup (thanks to Chris Reichert for the bug report).
	-> When entering the game name the Field Assistant will now
	automatically remove leading and trailing spaces to avoid trouble for
	the users when sending off their orders [poor Markus Kuhne discovered
	this].
	-> When entering the settings via the Enter these settings button, the
	Field Assistant will now automatically reset the turn counter for
	thisgame to the entered data, so that it should be more reliable next
	time; the FA will also reset the turn counter appropriately after each
	send. This should help avoiding the problem that the FA counts the
	number too high every turn.
	-> Fixed an input bug that on rare occasions could trigger the deletion
	of another order after one had given an army move command. [Thanks to
	Udo for noticing!]
	-> When the FA starts the first time, or if the Preferences have been
	deleted, the FA now pops up a window explaining that a map file is
	necessary.
	-> Added LoGyC - The Lords of Gyrne Chat! When in the Field Assistant
	and online, press Ctrl-G or choose Gyrne Chat from the Edit menu, and
	a chat window opens. You have to login with a nickname and a password of
	your choice. The Field Assistant will remember a different nickname and
	password for each preferences set. In the chat window you are now able
	to talk to other players that are also currently online. This is a major
	new feature, hence the version has been notched up to 2.2!

****************************************
Lords of Gyrne Field Assistant, Version 2.1.0 (formerly Beta 6)
	-> For deleting orders, the Backspace and Delete keys should now both
	work.
	-> PageUp and PageDwn Keys should now also switch the tabs in the
	Field Assistant, unless the orders list has the focus.
	-> The ESC key now also quits the Field Assistant from the Main
	Window.
	-> Added Pseudo-smart editing to Field Assistant: Adding an already
	existing unique or specific single order that only makes sense once
	per turn will no longer create a duplicate order. This is useful when
	double-clicking an order such as Change Tax Rate; entering the value
	will change the original order, not add another one. Orders that are
	useful in duplicates, such as buying or selling goods or building
	buildings, are unaffected.
	-> Messages should now correctly transfer into the game.

****************************************
Lords of Gyrne Field Assistant, Version 2.1. Beta 5
	-> Calling the Prefs window on startup no longer allows to cancel the
	prefs, to avoid not loading a map while starting.
	-> Hiring a spy now contains the correct for in the order text. 
	-> Spies are now designated with No. like Generals.
	-> Goldpiece sums beyond 1*10 to the power of 6 are now displayed in
	non-scientific counting.
	-> Order files are now stored with formatted strings with leading
	zeros where appropriate.
	-> Pressing the delete key when the overview box has the focus deletes
	the selected order(s).
	-> The Preferences now remember the last used mouse mode for a set in
	the map window.
	-> Fixed a bug that wrongly depressed the bevel button for password
	checking in the preferences when entering the wrong password.
	-> Updated the prices and maintenance costs in the Deputy and the
	status line formula to new rules.
	-> Added a Diplomacy topic to the deputy texts.
	-> Proof-read topic texts in Deputy for 3.1 compliance.
	-> Added a detailed strategies bonus table to Deputy.
	-> Created a topic Chronology of Events in a Game Turn in Deputy.
	-> Created a topic Vassals and lieges in Deputy.
	-> Created a topic "Espionage" in Deputy.
	-> Messages sent to other players should now be sent correctly.
	-> Compiled with RB 4.5.2. This should fix a number of small bugs.

****************************************
Lords of Gyrne Field Assistant, Version 2.1. Beta 4
	-> Re-added page panel refresh for win32 versions to avoid graphics chaos.
	-> Shortcuts on Win32 for Undo/Redo should now work (always worked on Mac).
	-> Problem with Entering Settings and 249/250 orders now fixed.
	-> All orders will now be checked for valid entry data before adding them.
	I.e., leaving empty player numbers etc. should no longer be possible. 
	-> Clicking into a number entry field now selects the entire content. This is
	not so on purpose for the message field and phone numbers, etc, and all
	preferences entries because one might mostly only want to alter and not delete
	them.
	-> On Windows, via Ctrl-T it is now possible to minimize the Main FA Window.
	To toggle map and deputy on or off you will still have to use the bevel
	buttons for them (or Ctrl-M and Ctrl-D, respectively).
	-> The Main Bevel buttons in the FA window now show tag texts on their
	content. These cannot be turned off.

****************************************
Lords of Gyrne Field Assistant, Version 2.1. Beta 3
	-> The FA now remembers the last loaded Replacement map in the map window. It
	is not loaded automatically, but upon re-pressing the Replace... button in
	the map window, the last directory is opened, and the last chosen file
	pre-selected.
	-> In addition to saving and closing its now also possible to cancel (go
	back) in the Save Orders Dialog.
	-> Fixed help tag texts in new controls (espionage and some of the special
	controls).
	->Opening Preferences Window on startup: Pressing the p key during startup
	opens the preferences. This should now also happen automatically when a bad
	map is loaded. The FA should no longer quit if you load a bad map, but instead
	open the preferences by itself.
	-> All buildings orders now check the set values first before adding them to
	the orders list.
	-> Corrected Hire/Pay Spy order text by adding a for.
	-> Improved layout (aligned controls).
	-> Removed a few refresh codes in the main window, which should remove
	graphics flickering.
	-> Added a graphics refresh in the prefs window upon opening. This might cause
	a flicker there, but should now paint all controls correctly.
	-> File path display in the Preferences should now look better.
	-> Unhandled exception should no longer occur upon opening the extra error
	window. This was a bug fixed with Realbasic 4.5.2fc1 which just came out (now
	you know what your money is spent on).
	-> Editing the Settings after entering 250 orders should now work.
	-> The status line now also tells how many orders are already given.
	-> Additional Keyboard Command: Pressing Cmd (Mac) or Ctrl (windows)-Help
	should now toggle the help tags on or off.
	-> Additional Runtime information added to error reports.

****************************************
Lords of Gyrne Field Assistant, Version 2.1. Beta 2
	-> Preferences are now stored in a way that ensures future compatibility;
	therefore older Preferences made by FAs up to version 2.1b1 (*.ini on
	windows) are useless.
	-> Added an on/off button next to the deputy to turn the help tags/balloon
	help on or off. Note that, on the Mac, it will turn the entire system balloon
	help on or off.
	-> The Build Tab button now has a more appropriate image.
	-> Improved layout.
	-> Removed a bug with the text conversion.
	
****************************************
Lords of Gyrne Field Assistant, Version 2.1. Beta 1 (First public release)

After a development cycle of 12 Alphas, the following novelties were introduced:
-> Added a custom command enter window (accessible via ctrl-shift-click on any
	order in the overview list.) Only useful when testing Server Betas.
-> The maximum order limit is now 250.
-> Added command to change telephone number
-> Added command to change privacy settings
-> Added command to quit game
-> Added command to hire spies
-> Added command to move spies (replacing older Send Spy order)
-> Added command to change operationg mode of spies.
-> Holding the shift key while starting the FA opens the Prefs window, and
	cirumvents loading a map.
-> The sound volume of the sounds can now be set for each preferences set.
-> The default game mail address is now games@gyrne.de.
-> The FA can now send with authenticated SMTP (PLAIN, LOGIN, or CRAM-MD5).
-> On the Mac, the Preferences file is now stored in the same folder as the
	Field Assistant.
-> Special characters in foreign languages should now transfer correctly.
-> All files are automatically encrypted now. Password checking can be turned
	on or off for each preferences set in the FA.
-> If everything fails, users should be able to send their orders simply by
	copying and pasting the content of an encoded gyrne-orders file into an email.
	The Server should be able to read this.

*************************************************************
PREVIOUS 2.0 VERSION HISTORY:
****************************************
Lords of Gyrne Field Assistant, Version 2.0.2 (Minor maintenance release)

-> Fixed a bug in Windows with pathnames when saving order files to disk.
-> Fixed a bug in saving and loading orders that could create problems when sending 
messages within the orders of more than 255 characters in line length with 
certain mail servers. Note that this Field Assistant should therefore
not be used with Gyrne Servers Version 3.0 Beta 7 or older.
-> Updated internal Polygon class to the Server's version.
-> All windows now display the menubar correctly. This was confusing for some 
users.


****************************************
Lords of Gyrne Field Assistant, Version 2.0.1 (First official release)

-> Changed interior socket event model to avoid possible but
unsubstantiated error potential.
-> Improved comm log tracking. 
-> Cleared minor mail command irregularities which were most likely
irrelevant.
-> Duck-tape-fixed an error in Win32 sockets that triggered problems with
feedback events after sending 1k chunk of order mails; this probably
triggered additional mail failure problems on Windows.
-> Fixed an error introduced by a bug fix for an older 1.0.x version,
which now triggered NilObject problems on Windows whenever orders were
saved directly to root.
-> Fixed cosmetic error with line delimiters in Error Report Chain
(don't laugh).
-> Increased send-mail-time-counter speed to 2 beats per second [also
improves mailing speed]. The TCP socket on Windows is now also polled at these
intervals, to secure updating of the socket's properties, which was previously
causing several forms of communication problems. This should fix it.
-> Introduced a new mouse mode in the Help window, which allows to save
the current map display view as a bitmap (Windows) or as picture (Mac)
by simply clicking into the view.
-> Added Deputy help text for this feature.

****************************************
Lords of Gyrne Field Assistant, Version 2.0 Beta 2

-> Introduced Automatic Error Report Window with integrated bug report
mailing.
-> Added automatic connection log window when mail posting failed.
-> Introduced Exception handlers in most code parts.
-> Field Assistant is now fully compatible with version 1 maps (even
flawed ones).
-> Fixed bug that miscalculated the cost of scrapping ships [thanks to
Nico].
-> On MacOS: Better memory management [not needed on Windows]. 
-> On MacOS: Increased preferred memory assignment to 30 MB RAM
[impossible on Windows].
-> Added Option-Key-on-startup to call up the preferences window before
any maps are loaded.
-> Added text for option-key-startup- option to help deputy.
-> Improved map loading feedback.
-> Replaced 'Ask me on startup' map choice with "Always ask me" to avoid
counterintuitive behavior (thanks Marcus).

****************************************
Lords of Gyrne Field Assistant, Version 2.0 Beta 1 (First test release)

-> New "About"-Window-Graphics.
-> New Task Bar Graphics.
-> New SendMail-Window Graphics.

****************************************
(Older version history has been cut to shorten this file).
