Documentation improvements.
[vms-empire.git] / vms-empire.6
1 .\" $Id: vms-empire.6,v 1.4 2002/08/01 18:58:22 esr Exp esr $  - (c) Copyright 1987, 1988 Chuck Simmons */
2 .\"
3 .\"   Copyright (C) 1987, 1988 Chuck Simmons
4 .\"
5 .\" See the file COPYING, distributed with empire, for restriction
6 .\" and warranty information.
7 .\"
8 .TH Empire 6
9 .SH NAME
10 empire -- the wargame of the century
11 .SH SYNOPSIS
12 empire [-w water] [-s smooth] [-d delay] [ -S save-interval ] [ -f savefile ]
13 .SH DESCRIPTION
14 Empire is a simulation of a full-scale war between two
15 emperors, the computer and you.  Naturally, there is only
16 room for one, so the object of the game is to destroy
17 the other.  The computer plays by the same rules that you
18 do.
19 .TP 10
20 .BI \-w water\^
21 This option controls the amount of water on the map.
22 This is given as the percentage of the map which should
23 be water.  The default is 70% water.  \f2water\fP
24 must be an integer in the between 10 and 90 inclusive.
25 .TP
26 .BI \-s smooth\^
27 This controls the smoothness of the map.  A low value
28 will produce a highly chaotic map with lots of small
29 islands or lakes.  A high value will produce a map
30 with a few scattered continents.  Be forewarned that
31 a high value will cause the program to take a long
32 time to start up.  The default value is 5.
33 .TP
34 .BI \-d delay\^
35 This option controls the length of time the computer will
36 delay after printing informational messages at the top of
37 the screen.  \f2delay\fP is specified in milliseconds.  The
38 default value is 2000 which allows the user two seconds to
39 read a message.
40 .SH EXAMPLES
41 empire -w90 -s2
42 .P
43 This produces a map with many islands.
44 .P
45 empire -w50 -s0
46 .P
47 This produces a really strange map.  These values
48 are not recommended for the faint at heart.
49 .P
50 empire -w10
51 .P
52 This produces a map with lots of land and a few lakes.
53 The computer will have a hard time on this sort of map
54 as it will try and produce lots of troop transports,
55 which are fairly useless.
56 .P
57 There are two other option.
58 .TP
59 .BI \-S interval\^
60 sets the \fIsave interval\fR for the game (default is 10). Once per
61 \fIinterval\fR turns the game state will be automatically saved after
62 your move. It will be saved in any case when you change modes or
63 do various special things from command mode, such as `M' or `N'.
64 .TP
65 .BI \-f savefile
66 Set the save file name (normally empsave.dat).
67 .SH INTRODUCTION
68 Empire is a war game played between you and the user.  The world
69 on which the game takes place is a square rectangle containing cities,
70 land, and water.  Cities are used to build armies, planes, and ships
71 which can move across the world destroying enemy pieces, exploring,
72 and capturing more cities.  The objective of the game is to destroy
73 all the enemy pieces, and capture all the cities.
74 .P
75 The world is a rectangle 60 by 100 squares on a side.  The world
76 consists of sea (.), land (+), uncontrolled
77 cities (*), computer-controlled cities (X), and cities that you
78 control (O).
79 .P
80 The world is displayed on the player's screen during
81 movement.  (On terminals with small screens, only a portion of
82 the world is shown at any one time.)
83 Each piece is represented by a unique
84 character on the map.  With a few exceptions, you can
85 only have one piece on a given location.  On the map, you
86 are shown only the 8 squares adjacent to your units.
87 This information is updated before and during each of your moves.
88 The map displays the most recent information known.
89 .P
90 The game starts by assigning you one city and the
91 computer one city.  Cities can produce new pieces.  Every
92 city that you own produces more pieces for you according
93 to the cost of the desired piece.  The typical play of the
94 game is to issue the Automove command until you decide
95 to do something special.  During movement in each round,
96 the player is prompted to move each piece that does not
97 otherwise have an assigned function.
98 .P
99 Map coordinates are 4-digit numbers.  The first two
100 digits are the row, the second two digits are the
101 column.
102 .SH PIECES
103 The pieces are as follows:
104 .P
105 .TS
106 center box tab(;);
107 l | c | c | r | r | r | c.
108 Piece;You;Enemy;Moves;Hits;Str;Cost
109 _
110 Army;A;a;1;1;1;5(6)
111 Fighter;F;f;8;1;1;10(12)
112 Patrol Boat;P;p;4;1;1;15(18)
113 Destroyer;D;d;2;3;1;20(24)
114 Submarine;S;s;2;2;3;20(24)
115 Troop Transport;T;t;2;1;1;30(36)
116 Aircraft Carrier;C;c;2;8;1;30(36)
117 Battleship;B;b;2;10;2;40(48)
118 Satellite;Z;z;10;--;--;50(60)
119 .TE
120 .P
121 The second column shows the map representation for your
122 units.
123 .P
124 The third shows the representations of enemy units.
125 .P
126 Moves is the number of squares that the unit can move in a
127 single round.
128 .P
129 Hits is the amount of damage a unit can take before it
130 is destroyed.
131 .P
132 Strength is the amount of damage a unit can inflict upon an
133 enemy during each round of an attack.
134 .P
135 Cost is the number of rounds needed for a city to produce
136 the piece.
137 .P
138 The number in parenthesis is the cost for a city to
139 produce the first unit.
140 .P
141 Each piece has certain advantages associated with it that
142 can make it useful.  One of the primary strategic aspects
143 of this game is deciding which pieces will be produced
144 and in what quantities.
145 .P
146 \f3Armies\f1 can only move on land, and are the only piece that can
147 move on land.  Only armies can capture cities.
148 This means that you must produce armies in order to win the
149 game.  Armies have a 50% chance of capturing a city when they
150 attack.  (Attacking one's own city results in the army's
151 destruction.  Armies that move onto the sea will drown.
152 Armies can attack objects at sea, but even if they win, they
153 will drown.)  Armies can be carried by troop transports.
154 If an army is moved onto a troop transport, then whenever
155 the transport is moved, the army will be moved with the
156 transport.  You cannot attack any piece at sea while on a
157 transport.
158 .P
159 \f3Fighters\f1 move over both land and sea, and they move 8 squares
160 per round.  Their high speed and great mobility make fighters
161 ideal for exploring.  However, fighters must periodically land
162 at user-owned cities for refueling.  A fighter can travel 32
163 squares without refeuling.  Fighters are also shot down if they
164 attempt to fly over a city which is not owned by the user.
165 .P
166 \f3Patrol boats\f1 are fast but lightly armored.  Therefore
167 they are useful for patrolling ocean waters and exploring.
168 In an attack against a stronger boat, however, patrol boats
169 will suffer heavy casulties.
170 .P
171 \f3Destroyers\f1 are fairly heavily armored and reasonably quick
172 to produce.  Thus they are useful for destroying enemy transports
173 which may be trying to spread the enemy across the face of the
174 world.
175 .P
176 When a \f3submarine\f1 scores a hit, 3 hits are exacted instead of 1.
177 Thus submarines can inflict heavy damage in a fight against
178 heavily armored boats.  Notice that healthy submarines will
179 typically defeat healthy destroyers two-thirds of the time.
180 However, a submarine will defeat a fighter about two-thirds
181 of the time, while a destroyer will defeat a fighter three-fourths
182 of the time.
183 .P
184 \f3Troop transports\f1 are the only pieces that can carry armies.
185 A maximum of six armies can be carried by a transport.
186 On any world containing a reasonable amount of water,
187 transports will be a critical resource in winning the game.
188 Notice that the weakness of transports implies they need
189 protection from stronger ships.
190 .P
191 \f3Aircraft carriers\f1 are the only ships that can
192 carry fighters.  Carriers carry a maximum of the number
193 of hits left of fighters.  Fighters are refueled when they
194 land on a carrier.
195 .P
196 \f3Battleships\f1 are similar to destroyers except that they are
197 much stronger.
198 .P
199 \f3Satellites\f1 are only useful for reconaissance.  They can not
200 be attacked.  They are launched in a random diagonal orbit, and
201 stay up for 50 turns.  They can see one square farther than other
202 objects.
203 .P
204 All ships can move only on sea.  Ships can also dock in a
205 user-owned city.  Docked ships have damage repaired at the
206 rate of 1 hit per turn.  Ships which have suffered a lot
207 of damage will move more slowly.
208 .P
209 Because of their ability
210 to be repaired, ships with lots of hits such as Carriers and
211 Battleships have an additional advantage.
212 After suffering minor damage while destroying enemy shipping,
213 these ships can sail back to port and be quickly repaired before
214 the enemy has time to replenish her destroyed shipping.
215 .P
216 The following table gives the probability that the piece listed
217 on the side will defeat the piece listed at the top in a battle.
218 (The table assumes that both pieces are undamaged.)
219 .P
220 .TS
221 center box tab(;);
222 l | c | c | c | c | c.
223 AFPT;D;S;C;B
224 _
225 AFPT;50.0%;12.5%;25.0%;00.391%;00.0977%
226 D;87.5%;50.0%;25.0%;05.47%;00.537%
227 S;75.0%;75.0%;50.0%;31.3%;06.25%
228 C;99.6%;94.5%;68.7%;50.0%;04.61%
229 B;99.9%;99.5%;93.8%;95.4%;50.0%
230 .TE
231 .P
232 Notice, however, that when a ship has been damaged, the odds of
233 being defeated can go up quite a bit.  For example, a healthy
234 submarine has a 25% chance of defeating a battleship that has
235 had one hit of damage done to it, and a healthy submarine has
236 a 50% chance of defeating a carrier which has suffered two hits
237 of damage.
238 .SH "MOVEMENT FUNCTIONS"
239 There are a variety of movement functions.  The movement functions
240 of pieces can be specified in user mode and edit mode.
241 Cities can have movement functions set for each type of piece.
242 When a movement function for a type of pieces is set for a city,
243 then every time that type of piece appears in the city, the piece
244 will acquire that movement function.  Be forewarned that moving
245 loaded transports or loaded carriers into a city can have undesirable
246 side effects.
247 .P
248 Normally, when a movement
249 function has been specified, the piece will continue moving according to
250 that function until one of the following happen:
251 .TP 5
252 .B *
253 An enemy piece or unowned city appears next to the piece.  In this case
254 the piece will be completely awoken, unless its movement function has
255 been set to a specific destination.
256 Armies on ships and pieces inside
257 cities will not be awoken if the enemy piece is gone by the time it is
258 their turn to move.
259 .TP
260 .B *
261 You explicitly awaken the piece.
262 .TP
263 .B *
264 The piece can no longer move in accordance with its programmed function.
265 In this case, the piece will awaken \f2temporarily\fP.  You will be asked
266 to move the piece at which time you may awaken it.
267 .TP
268 .B *
269 The piece is a fighter which has just enough fuel (plus a small reserve)
270 to get to the nearest city.
271 In this case,
272 the piece will awaken completely, unless its movement function has
273 been set to a specific destination, or its movement function has been
274 set to \f2land\fP.
275 .P
276 The rationale behind this complexity is that fighters must be awoken
277 completely before they are out of range of a city
278 to prevent one from accidentally forgetting to waken the
279 fighter and then watching it fly off to its doom.  However, it is presumed
280 that when a path is set for the fighter, the fighter is not in danger of
281 running out of fuel.
282 .P
283 Pieces do not completely awaken when their function has been set to a
284 destination because it is slightly time consuming to reset the destination,
285 but very simple (one keystroke) to wake the piece.
286 .P
287 The movement functions are:
288 .TP 10
289 .B Attack
290 This function applies only to armies.  When this function is set,
291 the army will move toward the nearest enemy city, unowned city, or
292 enemy army.  This is useful when fighting off an invading enemy or
293 taking over a new continent.  When an army is set to this mode,
294 it will also explore nearby territory.  This tends to make
295 the "grope" movement mode pretty useless.
296 .TP
297 .B Awake
298 When pieces are awake, you will be asked for the direction in which
299 the piece should move on each turn.
300 .TP
301 .B Fill
302 This function applies to carriers and transports.  When this function is
303 specified, these ships sleep until they have been filled with fighters or
304 armies respectively.
305 .TP
306 .B Grope
307 This function causes a piece to explore.  The piece heads toward the nearest
308 unseen square of the map on each of its moves.  Some attempt is made to 
309 explore in an optimal fashion.
310 .TP
311 .B Land
312 This function applies to fighters and causes the fighter to head toward
313 the nearest transport or carrier.
314 .TP
315 .B Random
316 This movement function causes a piece to move at random to an adjacent
317 empty square.
318 .TP
319 .B Sentry
320 This movement function puts a piece to sleep.
321 The function of a city cannot be set to 'sleep'.
322 .TP
323 .B Transport
324 This movement function only works on armies.  The army sleeps until
325 an unfull transport passes by, at which point the army wakes up and
326 boards the transport.
327 .TP
328 .B Upgrade
329 This movement function only works with ships.  The ship will move
330 to the nearest owned city and remain there until it is repaired.
331 .TP
332 .B <dir>
333 Pieces can be set to move in a specified direction.
334 .TP
335 .B <dest>
336 Pieces can be set to move toward a specified square.  In this movement
337 mode, pieces take a shortest path toward the destination.  Pieces moving
338 in accordance with this function prefer diagonal moves that explore
339 territory.  Because of this, the movement of the piece may be
340 non-intuitive.
341 .P
342 As examples of how to use these movement functions, typically
343 when I have a new city on a continent, I set the Army function of the
344 city to \f2attack\f1.  Whenever an army is produced, it merrily goes off
345 on its way exploring the continent and moving towards unowned cities
346 or enemy armies or cities.
347 .P
348 I frequently set the ship functions for cities that are far from the
349 front to automatically move ships towards the front.
350 .P
351 When I have armies on a continent, but there is nothing to explore
352 or attack, I move the army to the shore and use the \f2transport\f1
353 function to have that army hop aboard the first passing transport.
354 .SH COMMANDS
355 There are three command modes.  The first of these is "command mode".
356 In this mode, you give commands that affect the game as a whole.
357 In the second mode, "move mode", you give commands to move your
358 pieces.  The third mode is "edit mode", and in this mode you can
359 edit the functions of your pieces and examine various portions of
360 the map.
361 .P
362 All commands are one character long.  The full mnemonic names are
363 listed below as a memorization aid.
364 The mnemonics are somewhat contrived because there are so few
365 characters in the English language.  Too bad this program isn't
366 written in Japanese, neh?
367 .P
368 In all command modes, typing "H" will print out a screen of help
369 information, and typing <ctrl-L> will redraw the screen.
370 .P
371 .SH COMMAND MODE
372 In command mode, the computer will prompt you for your orders.
373 The following commands can be given at this time:
374 .TP 10
375 .B Automove
376 Enter automove mode.  This command begins a new round of movement.
377 You will remain in move mode after each of the computer's turns.
378 (In move mode, the "O" command will return you to command mode
379 after the computer finishes its next turn.
380 .TP
381 .B City
382 Give the computer a random unowned city.  This command is useful if you
383 find that the computer is getting too easy to beat.
384 .TP
385 .B Date
386 The current round is displayed.
387 .TP
388 .B Examine
389 Examine the enemy's map.  This command is only valid after the computer
390 has resigned.
391 .TP
392 .B File
393 Print a copy of the map to the specified file.
394 .TP
395 .B Give
396 This command gives the computer a free move.
397 .TP
398 .B J
399 Enter edit mode where you can examine and change the functions
400 associated with your pieces and cities.
401 .TP
402 .B Move
403 Enter move mode for a single round.
404 .TP
405 .B N
406 Give the computer the number of free moves you specify.
407 .TP
408 .B Print
409 Display a sector on the screen.
410 .TP
411 .B Quit
412 Quit the game.
413 .TP
414 .B Restore
415 Restore the game from empsave.dat.
416 .TP
417 .B Save
418 Save the game in empsave.dat.
419 .TP
420 .B Trace
421 This command toggles a flag.  When the flag is set,
422 after each move, either yours or the computer's,
423 a picture of the world is written out to the file
424 'empmovie.dat'.  \f3Watch out!  This command produces lots of
425 output.\f1
426 .TP
427 .B Watch
428 This command allows you to watch a saved movie.
429 The movie is displayed in a condensed version so that
430 it will fit on a single screen, so the output may be
431 a little confusing.  This command is only legal if the
432 computer resigns.  If you lose the game, you cannot replay
433 a movie to learn the secrets of how the computer beat you.
434 Nor can you replay a movie to find out the current positions
435 of the computer's pieces.  When replaying a movie, it is
436 recommended that you use the \f2-d\f1 option to set the delay
437 to around 2000 milliseconds or so.  Otherwise the screen will be
438 updated too quickly for you to really grasp what is going on.
439 .TP
440 .B Zoom
441 Display a condensed version of the map on the screen.  The user map is
442 divided into small rectangles.  Each rectangle is displayed as one square
443 on the screen.  If there is a city in a rectangle, then it
444 is displayed.  Otherwise enemy pieces are displayed, then user pieces,
445 then land, then water, and then unexplored territory.  When pieces are
446 displayed, ships are preferred to fighters and armies.
447 .SH MOVE MODE
448 In move mode, the cursor will appear on the screen at the position
449 of each piece that needs to be moved.  You can then give commands
450 to move the piece.  Directions to move are specified by the
451 following keys:
452 .P
453 .fp 5 TT
454 .ft 5
455 .nf
456         QWE
457         A D
458         ZXC
459 .fi
460 .ft 1
461 .P
462 These keys move in the direction of the key from S.  The
463 characters are not echoed and only 1 character is
464 accepted, so there is no need for a <Return>.  Hit the <Space>
465 bar if you want the piece to stay put.
466 .P
467 Other commands are:
468 .TP 10
469 .B Build
470 Change the production of a city.
471 .TP
472 .B Fill
473 Set the function of a troop transport or aircraft carrier to
474 \f2fill\f1.
475 .TP
476 .B Grope
477 Set the function of a piece to \f2grope\f1.
478 .TP
479 .BI I dir
480 Set the direction for a piece to move.
481 .TP
482 .B J
483 Enter edit mode.
484 .TP
485 .B Kill
486 Wake up the piece.  If the piece is a transport or carrier,
487 pieces on board will not be awoken.
488 .TP
489 .B Land
490 Set a fighter's function to \f2land\f1.
491 .TP
492 .B Out
493 Cancel automove mode.  At the end of the round, you will
494 be placed in command mode.
495 .TP
496 .B Print
497 Redraw the screen.
498 .TP
499 .B Random
500 Set a piece's function to \f2random\f1.
501 .TP
502 .B Sentry
503 Set a piece's function to \f2sentry\f1.
504 .TP
505 .B Transport
506 Set an army's function to \f2transport\f1.
507 .TP
508 .B Upgrade
509 Set a ship's function to \f2upgrade\f1.
510 .TP
511 .BI V "piece func"
512 Set the city movement function for the specified piece
513 to the specified function.  For example, typing "VAY" would
514 set the city movement function for armies to \f2attack\f1.  Whenever
515 an army is produced in the city (or whenever a loaded transport
516 enters the city), the army's movement function
517 would be set to \f2attack\f1.
518 .TP
519 .B Y
520 Set an army's function to \f2attack\f1.
521 .TP
522 .B ?
523 Display information about the piece.  The
524 function, hits left, range, and number of items on board are
525 displayed.
526 .P
527 Attacking something is accomplished by  moving  onto  the
528 square of the unit you wish to attack.  Hits are traded
529 off at 50% probability of a hit landing on one or the
530 other units until one unit is totally destroyed.  There
531 is only 1 possible winner.
532 .P
533 You are "allowed" to do \f3fatal\f1 things like attack your
534 own cities or other pieces.  If you try to make a fatal
535 move, the computer will warn you and give you a chance to
536 change your mind.
537 .P
538 You cannot move onto the edge of the world.
539 .SH EDIT MODE
540 In edit mode, you can move around the world and examine pieces
541 or assign them new functions.
542 To move the cursor around, use the standard direction
543 keys.
544 Other commands are:
545 .TP 10
546 .B Build
547 Change the production of the city under the cursor.
548 The program will prompt for the new production, and you
549 should respond with the key corresponding to the letter of the piece
550 that you want produced.
551 .TP
552 .B Fill
553 Set a transport's or carrier's function to \f2fill\f1.
554 .TP
555 .B Grope
556 Set a piece's function to \f2grope\f1.
557 .TP
558 .BI I dir
559 Set the function of a piece (or city) to the specified direction.
560 .TP
561 .B Kill
562 Wake all pieces at the current location.  If the location is a city,
563 the fighter path will also be canceled.
564 .TP
565 .B Mark
566 Select the piece or city at the current location.  This command
567 is used with the "N" command.
568 .TP
569 .B N
570 Set the destination of the piece previously selected with the "M"
571 command to the current square.
572 .TP
573 .B Out
574 Exit edit mode.
575 .TP
576 .BI Print sector
577 Display a new sector of the map.  The map is divided into
578 ten sectors of size 20 by 70.  Sector zero is in the upper-left
579 corner of the map.  Sector four is in the lower-left corner of
580 the map.  Sector five is in the upper-right corner, and sector
581 nine is in the lower-right corner.
582 .TP
583 .B Random
584 Set a piece to move randomly.
585 .TP
586 .B Sentry
587 Put a piece to sleep.
588 .TP
589 .B Transport
590 Set an army's function to \f2transport\f1.
591 .TP
592 .B Upgrade
593 Set a ship's function to \f2upgrade\f1.
594 .TP
595 .BI V "piece func"
596 Set the city movement function for a piece.
597 .TP
598 .B Y
599 Set an army's function to \f2attack\f1.
600 .TP
601 .B ?
602 Display information about a piece or city.
603 For a city, the production, time of completion of
604 the next piece, movement functions, and the number of fighters and ships
605 in the city are displayed.
606 .P
607 Note that you cannot directly affect anything inside a city with
608 the editor.
609 .SH HINTS
610 After you have played this game for a while, you will probably
611 find that the computer is immensely easy to beat.  Here are some
612 ideas you can try that may make the game more interesting.
613 .TP 5
614 .B *
615 Give the computer one or more extra cities before starting the game.
616 .TP
617 .B *
618 Try playing the game with a low smoothness value (try using the
619 -s2 or even -s0 option).
620 .TP
621 .B *
622 When starting the game, the program will ask you what difficulty
623 level you want.  Here "difficulty level" is a misnomer.  To compute
624 a difficulty level, the program looks at each continent and counts
625 the number of cities on the continents.  A high "difficulty level"
626 gives the computer a large continent with many cities, while the
627 user gets a small continent with few cities.  A low "difficulty level"
628 has the opposite effect.  It may be the case that the computer will
629 play better when the "difficulty level" is low.  The reason for this
630 is that the computer is forced to move armies to multiple continents
631 early in the game.
632 .SH HISTORY
633 According to 
634 .UR http://www.classicempire.com/history.html
635 A Brief History of Empire
636 .UE
637 This game was written by Walter Bright sometime in the early 1970s
638 while he was a student at Caltech.  A copy leaked out of Caltech and
639 was ported to DEC's VAX/VMS from the TOPS-10/20 FORTRAN sources
640 available around fall 1979.  Support for different terminal types 
641 was added by Craig Leres.
642 .P
643 Ed James got hold of the sources at Berkeley and converted
644 portions of the code to C, mostly to use curses for the screen
645 handling.  He published his modified sources on the net in
646 December 1986.  Because this game ran on VMS machines for so
647 long, it has been known as VMS Empire.
648 .P
649 In 1987 Chuck Simmons at Amdahl
650 reverse engineered the program and wrote a
651 version completely written in C.  In doing so, he completely
652 modified the computer strategy, the commands, the piece types,
653 many of the piece attributes, and the algorithm for creating maps.
654 .SH FILES
655 .TP 10
656 \f2empsave.dat\f1
657 holds a backup of the game.  Whenever empire is run,
658 it will reload any game in this file.
659 .TP
660 \f2empmovie.dat\f1
661 holds a history of the game so that the game can be replayed as
662 a "movie".
663 .SH BUGS
664 No doubt numerous.
665 .P
666 Satellites are not completely implemented.  You should be able to
667 move to a square that contains a satellite, but the program won't
668 let you.  Enemy satellites should not cause your pieces to awaken.
669 .SH AUTHORS
670 .nf
671 Original game by Walter Bright.
672 Support for different terminal types added by Craig Leres.
673 Curses support added by Ed James.
674 C/Unix version written by Chuck Simmons
675 Colorization by Eric S. Raymond.
676 Probability table corrected by Michael Self.
677 .fi
678 .SH COPYLEFT
679 .fn
680 Copyright (C) 1987, 1988 Chuck Simmons
681
682 See the file COPYING, distributed with empire, for restriction
683 and warranty information.
684 .fi