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