FROTZ v2.56
An interpreter for all Infocom and other Z-Machine games.

ATARI TOS version ported from the curses version of:
https://gitlab.com/DavidGriffith/frotz

Get the latest TOS port or raise issues at:
https://github.com/simonlaszcz/tos_frotz

NOTES
-----
* No audio.
* No blorb image/sound support.

USEFUL KEYS/COMMANDS
--------------------
ctrl-l	refresh the screen
up/down	navigate history
escape	clear input line
ctrl-z	quit. ctrl-c and ctrl-q do the same
save	save your progress
restore	load a saved game

COLOUR
------
The following colour names are understood: black, red, green, yellow, blue,
magenta, cyan and white. Black and white are always available but when the
resolution supports fewer colours they will be remapped.

OPTIONS
-------
* Some options won't work/make sense in this version.

Syntax: frotz [options] story-file [blorb file]
  -a   watch attribute setting    	 -o   watch object movement
  -A   watch attribute testing    	 -O   watch object locating
  -b <colorname> background color 	 -p   plain ASCII output only
  -c # context lines              	 -P   alter piracy opcode
  -d   disable color              	 -q   quiet (disable sound effects)
  -e   enable sound               	 -r # right margin
  -E <style> emphasis style       	 -R <path> restricted read/write
  -f <colorname> foreground color 	 -s # random number seed value
  -F   Force color mode           	 -S # transcript width
  -h # text height                	 -t   set Tandy bit
  -i   ignore fatal errors        	 -u # slots for multiple undo
  -I # interpreter number         	 -v   show version information
  -l # left margin                	 -w # text width
  -L <file> load this save file   	 -x   expand abbreviations g/x/z
  -m   enable mouse support       	 -Z # error checking (see below)

CONFIGURATION FILES
-------------------
On startup, frotz will check the program folder for the file 'frotz.rc'. If
not found it will check the current drive root for 'frotz.cfg'.

The configuration file uses a simple syntax of
<variable> <whitespace> <value>

Color names may be any of the following:
black | red | green | blue | magenta | cyan | white

ascii on | off
Use plain ASCII only. Default is "off".

background <colorname>
Set background color. Default is terminal's default background color.

color yes | no
Use color text. Default is "yes" if supported.

errormode never | once | always | fatal
Set error reporting mode.
never       Don't report any errors except for fatal ones.
once        Report only the first instance of an error.
always      Report every instance of an error.
fatal       Abort on any error, even non-fatal ones.
Default is "once".

expand_abb on | off
Expand abbreviations. Default is off. Expand the abbreviations "g", "x", and 
"z" to "again", "examine", and "wait". This switch is for use with old Infocom 
games that lack these common abbreviations which were introduced in later games.
Use it with caution. A few games might use the "g", "x", or "z" for different
purposes.

foreground <colorname>
Set foreground color. Default is terminal's default foreground color.

ignore_fatal on | off
Ignore fatal errors. If a Z-Machine interpreter encounters a zcode error such as
division-by-zero or addressing an illegal object, the proper response is to 
abort execution. This is done because the zcode program doesn't have a clear 
idea of what is going on. There are some games out there that cause fatal errors
because the authors were careless and used an interpreter that didn't properly
check for errors. This option is intended to get around such bugs, but be warned
that Strange Things may happen if fatal errors are not caught.
Default is "off"

piracy on | off
Alter the piracy opcode. Default is off. The piracy opcode was never used by
Infocom. This option is only useful for those who like to toy around with
Z-code.

randseed <integer>
Set random number seed. Default comes from the Unix epoch.

sound on | off
Turn sound effects on or off. Default is "on".

tandy on | off
Set the machine's Tandy bit. This may affect the behavior of certain Infocom 
games. For example, Zork I pretends not to have sequels, and Witness has its
language toned down. Default is "off".

undo_slots <integer>
Set number of undo slots. Default is 500.

zcode_path /path/to/zcode/files:/another/path
Set path to search for zcode game files. This is just like the $PATH
environmental variable except that you can't put environmental variables in the
path or use other shortcuts. For example, "$HOME/games/zcode" is illegal because
the shell can't interpret that $HOME variable.

context_lines <integer>
Set the number of context lines used. By default, after a ``[MORE]'' prompt, and
assuming there is enough output pending, frotz will allow all the currently
visible lines to scroll off the screen before prompting again. This switch
specifies how many lines of text frotz will hold over and display at the top of
the next screen. Default is "0".

left_margin <integer>
Set the left margin.

right_margin <integer>
Set the right margin.

text_height <integer>
Manually set text height. 

text_width <integer>
Manually set text width.

script_width <integer>
Set the transcript width. Default is 80 columns per line. 

; vim: colorcolumn=80 ts=4 sw=4 expandtab :