~ubuntu-branches/ubuntu/wily/gargoyle-free/wily-proposed

« back to all changes in this revision

Viewing changes to terps/agility/readme.dos

  • Committer: Bazaar Package Importer
  • Author(s): Sylvain Beucler
  • Date: 2009-09-11 20:09:43 UTC
  • Revision ID: james.westby@ubuntu.com-20090911200943-idgzoyupq6650zpn
Tags: upstream-2009-08-25
ImportĀ upstreamĀ versionĀ 2009-08-25

Show diffs side-by-side

added added

removed removed

Lines of Context:
 
1
AGiliTY, notes for DOS ports
 
2
----------------------------------------
 
3
 
 
4
(For a general introduction to this program, see the file README.AGI)
 
5
 
 
6
 
 
7
COMMAND LINE 
 
8
 
 
9
  To run an AGT game file, run *agil* with the game file name as an
 
10
argument; don't include any extensions. For example, to run MYGAME, enter
 
11
 
 
12
C:\AGT> AGIL MYGAME
 
13
  
 
14
  Command line options can be seen by running agil without any
 
15
arguments, but most of them were intended for debugging the
 
16
interpreter and will not be of general interest. The one exception is
 
17
the -d command, which outputs metacommand debugging information which
 
18
will be of interest to authors developing AGT games.
 
19
  
 
20
 
 
21
 
 
22
CONFIGURATION
 
23
 
 
24
  The DOS global configuration file is the file AGIL.CFG in the same
 
25
directory as the executable; it can be used to set options you want to
 
26
hold for all games run with AGiliTy. 
 
27
 
 
28
  You can provide individual configuration of a particular game by
 
29
creating or editing the game-specific configuration file, which should
 
30
be in the same directory as the game data file(s) and should be named
 
31
<game name>.CFG; e.g. MYGAME.CFG. Options specified in the
 
32
game-specific file take precedence over ones in the global
 
33
configuration file.
 
34
 
 
35
 
 
36
The DOS port supports several additional options: 
 
37
 
 
38
BIOS, which causes all output to go through the BIOS routines.
 
39
 
 
40
COLORS, which allows the interface color scheme to be
 
41
   set. The syntax is
 
42
     COLORS <normal> <highlight> <background> <reverse fore> <reverse back>
 
43
   e.g COLORS LIGHTGRAY YELLOW BLACK WHITE BLUE,  which is the default.
 
44
       The colors are black, blue, green, cyan, red, magenta, brown, 
 
45
   lightgray, darkgray, lightblue, lightgreen, lightcyan, lightred,
 
46
   lightmagenta, yellow, and white. Only the first eight can be used
 
47
   as the background colors; all sixteen can be used for the other three
 
48
   settings.  
 
49
     (The spellings COLOURS, lightgrey, and darkgrey are also recognized.)
 
50
 
 
51
COMPASS, which causes the possible exits to be listed on the status
 
52
   line.
 
53
 
 
54
NAVARROW-- Use the keys on the numeric keypad for entering
 
55
   movement commands instead of for editing. 
 
56
 
 
57
KEY <key> <text> --
 
58
  Define the text to be inserted on the line when a given function key is 
 
59
  typed.   <key> can be 'F1', 'F2', 'F3', ..., 'F12'.  (If NAVARROW is set,
 
60
  then 'HOME', 'END', 'PGUP', 'PGDN', 'UP', 'DOWN', 'LEFT', 'RIGHT',
 
61
  'INS', 'DEL', 'PLUS', and 'MINUS' can also be redefined.) The
 
62
  default definitions are listed below. A '+' at the end of the last
 
63
  word of the text will be converted to a newline. 
 
64
 
 
65
HISTORY -- This specifies the size of the command history list.
 
66
  A value of 0 indicates no limit (the interpreter will remember
 
67
  every line you typed since the beginning of the game). For DOS, the
 
68
  default is 10. E.g.
 
69
      history 0
 
70
      history 20
 
71
 
 
72
PATH -- This should contain a space-separated list of directories 
 
73
  which will be searched for AGT games.  
 
74
 
 
75
BLOCK_CURSOR -- Use a block cursor instead of the usual flashing underbar.
 
76
 
 
77
50_LINE -- Display in 50-line mode.
 
78
 
 
79
 
 
80
 
 
81
 
 
82
LINE EDITING
 
83
  The following keys can be used when typing in commands:
 
84
<Backspace>, <Delete> -- do what you would expect.
 
85
<Left Arrow>, <Right Arrow> -- Move left/right.
 
86
<Home> or <Ctrl-A> -- Move to beginning of the line.
 
87
<End> or <Ctrl-E> -- Move to end of the line.
 
88
<Up Arrow>, <Down Arrow> -- Scroll through past commands.
 
89
<Ctrl-K> -- Kill to end of line.
 
90
<Ctrl-Y> -- Yank back the last thing killed.
 
91
 
 
92
<F1>-<F12> -- These can be configured with strings of your choice;
 
93
  see the KEY option above.  By default, they are:
 
94
   F1: get     
 
95
   F2: drop
 
96
   F3: examine
 
97
   F4: read 
 
98
   F5: open
 
99
   F6: close
 
100
   F7: inventory+
 
101
   F8: look+
 
102
   F9: score+ 
 
103
   F10: help+
 
104
   F11: save+
 
105
   F12: restore+
 
106
 
 
107
If NAVARROW is set, then the keys on the numeric keypad will generate 
 
108
generate movement commands instead of being used for editing; these
 
109
can also be redefined with KEY:
 
110
  UP: n+
 
111
  DOWN: s+
 
112
  LEFT: w+
 
113
  RIGHT: e+
 
114
  HOME: nw+
 
115
  END: sw+
 
116
  PGUP: ne+
 
117
  PGDN: se+
 
118
  INS: enter+
 
119
  DEL: exit+
 
120
  PLUS: up+
 
121
  MINUS: down+
 
122
 
 
123
 
 
124
MISCELLANEOUS
 
125
  The program *agtout* prints out the contents of AGT game files,
 
126
in human readable format, writing the output to standard output.
 
127
Under DOS, you will probably want to redirect the output to a file and
 
128
then view it with an editor; e.g.
 
129
   AGTOUT MYGAME > MYGAME.LST
 
130
which will cause the output to go to MYGAME.LST.
 
131
  Running it without arguments will give a list of command line options.
 
132
 
 
133
 
 
134
  As described in README.AGI, AGT game files can be converted to the AGX
 
135
format by using AGT2AGX.EXE. Just type (for example):
 
136
 
 
137
C:\AGT> AGT2AGX MYGAME 
 
138
 
 
139
This will create the file MYGAME.AGX from the other game files
 
140
You can use the '-o' option to give the output file a different name.
 
141
For example:
 
142
 
 
143
C:\AGT> AGT2AGX MYGAME -o THEGAME
 
144
 
 
145
will cause MYGAME.DA1...MYGAME.DA6, MYGAME.TTL, etc. to be converted into
 
146
the file THEGAME.AGX
 
147
 
 
148
 
 
149
NOTES ON THE DIFFERENT DOS RELEASES
 
150
 
 
151
  There are now two binary releases for DOS: a 32-bit version and a
 
152
16-bit version.  As of 1.0, only the 32-bit version is being actively
 
153
updated.
 
154
 
 
155
  The 16-bit compiler is packaged as "agil092olddos.zip"; its only
 
156
benifit is that it will run on old (pre-386) computers that won't
 
157
run the 32-bit version. If you actually are in this situation, you
 
158
should drop me a note so that I know you exist.
 
159
 
 
160
  The 32-bit version is built with the DJGPP compiler and packaged
 
161
with the supplementary program "cwsdpmi.exe", a freeware DPMI server
 
162
which should be left in the same directory as "agil.exe".  More
 
163
information on DJGPP (including the source code to "cwsdpmi.exe") can
 
164
be found at
 
165
    http://www.delorie.com/djgpp/
 
166
 
 
167
The copyright notice for CWSDPMI.EXE follows:
 
168
 
 
169
==================================================================
 
170
CWSDPMI is Copyright (C) 1995-1997  Charles W Sandmann (sandmann@clio.rice.edu)
 
171
                               1206 Braelinn, Sugar Land, TX 77479
 
172
 
 
173
This is release 4.  The files in this binary distribution may be
 
174
redistributed under the GPL (with source) or without the source code
 
175
provided:
 
176
 
 
177
* CWSDPMI.EXE or CWSDPR0.EXE are not modified in any way except via
 
178
CWSPARAM
 
179
 
 
180
* Notice to users that they have the right to receive the source code
 
181
and/or binary updates for CWSDPMI.  Distributors should indicate a
 
182
site for the source in their documentation.
 
183
==================================================================
 
184

 
 
b'\\ No newline at end of file'