Documentation

Version	1.14

	This document explain the user interface. It is written in a general fashion as it applies to many adventure game apllications. For specific documentation to this adventure, please read 'ReadMeAlso.rtf', if it exists.

Application

	This application may be 32-bits or 64-bits Intel.

Minimum system requirements

	MacOsX 10.4 for 32-bits version
	MacOsX 10.6 for 64-bits version

	This program was developed and tested on MacOsX 10.6.8. It runs also on versions MacOsX 10.11.6 (El Capitan), 10.12.6 (Sierra) and 10.13.2 (High Sierra). It should also run on intermediary versions.

Interpreter

	In this text, the term 'interpreter' means the part of the program that 'play' the adventure.

Text window

	The text window display the text printed by the adventure. This text cannot be modified.

	This window is alse used to enter commands to be sent to the interpreter. This text is entered after the prompt. It can be entered ans edited as explained in the Edition section below.

	Some interpreters support a status view that show the name of the location and possibly other information as the score, the number of turns or certain comments on the player experience.

	The name of the window is the name of the adventure. But if the interpreter support a status view showing the name of the location, the name of the location is appended to the name of the adventure. So the name of the window will be 'Adventure name - Location name'.

Edition

	Cut, Copy and Paste work normally if the cursor is in the entry line, that is, after the prompt. If the cursor is before:

	Cut become Copy.
	Copy act normally.
	Paste add the text to paste at the end of the entry line.

	If you double click a word in the text,
		and if the entry line is empty
			the command 'take word' is automatically sent to the Mud.
		But if the key 'alt' is also pressed,
			the command 'examine word' is automatically sent to the Mud.
		But if there is text in the entry line,
			the word is automatically inserted in the entry line, at the insertion point.

	Left and Right arrows move the cursor in the entry line.

	Up and Down arrows allow navigating in the historic of entry lines. The text in  the historic can be edited. The historic is limited to the 100 last commands.

Numerical keyboard

	The application display a virtual numerical keyboard, representing a real numerical keyboard. If you click on a virtual key, it become selected and the 'Execute' and 'Edit' buttons become activated. 'Execute' put the the text in the key in the entry line. 'Edit' let you to edit the text in the key.

	Double-clicking a key is a shortcut for the 'Execute' button. Double-clicking a key with the 'Alt' key down is a short cut for the 'Edit' button.

	Naturally, if you have an extended keyboard, you can use it directly.

	Already defined keys and pale gray keys can be edited. Dark gray keys cannot be edited. Double-click the key to edit with the key 'alt' pressed show an edit field. The backgroud color of the key become yellow. Enter the new text in the edit field and press return. If there is text, it display in the key on a white background. If there is no text, the background become pale gray.

	By default, the return character stay in the text, so that it will be automatically transmitted to the interpreter. But if the last character before return is a space, the return is removed, so that the command is put in the entry line, but not automatically transmitted to the interpreter.

	The text in the keys is persistant. It is stored in the application preferences. The 'Defaults' button restore the original keyboard.

	The numerical keyboard window stick to the active text window, simulating more or less a window drawer that do not close. It cannot be moved independantly. It move with the active text window.

	It can be hidden by the menu 'Windows->Hide keypad'
	It can after be unhidden by the menu 'Windows->Show keypad'

Save/Restore

	To save or restore a position, it is best to use the menus 'File->Save…' and 'File->Restore…' instead of the commands 'Save' and 'Restore' of the interpreter. You can easily choose the folder you want and you will not have to type long file names. If it happens that you enter 'Save' or 'Restore', you can cancel it by entering a return only.

	If you save and if a status view is present, the name of the location followed by the default extension is proposed as the file name. You can modify both. If there is no more extension, the default one will be added. If there is one, it is used.

	In the Finder, you can double-click a saved position, if it has the correct extension. The application is then automatiquely launched, if it is not yet launched. The adventure is automatically restored in that position. If the application is already launched, a new window is opened and restored.

	Files saved in 64 bits mode are identical to files saved in 32 bits mode.

Menus
	The menus are in 14 languages. The language used depend of the 'Language & Text' option of System Preferences. Translations are most those used by TextEdit, some used by Activity Monitor and others from Google Translate.

Menus ApplicationName->Preferences…

	This menu open a window showing the 3 fonts used, on for the status bar, another for the output text and the third for the input text. Clicking on a font button let you change that font from the font panel, which is opened automaticaly. Changes take effect immediately and are stored as permanent preferences. So you can experiment.

	The output text button is pressed when you first open that window. The default button let you back to the factory default fonts.

Menus ApplicationName->List historic

	This menu list the historic in the adventure window. An arrow show where you are when scanning it. Up to 11 commands can be seen.

Menus File, Edit and Windows

	Those menus work as expected.

Other Menus

	Some menus are more or less usefull. Those menus are proposed by the Apple's xCode developpement system. Some work as they should. The others may be used in a futur version.

Bugs

	Please report bugs to <pierre.tremblay99@videotron.qc.ca>

Pierre Tremblay