Mention in README.md the need for the iftex package and how to get it.
[ibg.git] / appendices / a.rst
1 ======================================
2  Appendix A -- How to play an IF game
3 ======================================
4
5 .. only:: html
6
7   .. image:: /images/picP.png
8      :align: left
9
10 |P|\laying IF requires just a bit of instruction.  All you have to do is
11 read the descriptions and situations that appear on the screen and then
12 tell the game what you'd like to happen next.  Imagine that you're saying
13 "I WANT TO ..."; you don't actually type those three words, but you *do*
14 type what follows, instructing the game to do something on your behalf.
15 Commands usually take the form of a simple imperative sentence, with a verb
16 and a direct object (for example, typing EXAMINE THE KETTLE will display a
17 description of the kettle, TAKE KETTLE will make it one of your belongings,
18 and so on).  If there's more than one kettle around, you can be specific
19 (TAKE RED KETTLE); otherwise, the game will ask you something like "Which
20 do you mean, the red kettle or the rusty kettle?"  Answering RED is enough
21 in a case like this.  Some commands refer to two objects, like: PUT KETTLE
22 ON TABLE.
23
24 To make them stand out on the page, we're showing the words that you type
25 in capital letters.  You can actually use upper-case or lower-case letters
26 -- it makes no difference -- and you can usually omit words like THE
27 (though TAKE A BATH and TAKE THE BATH may have different effects, as will
28 TAKE A COIN and TAKE THE COIN if there are several to choose from).
29
30 To move around, use the verb GO and one of the cardinal points: GO NORTH
31 will move you in the desired direction.  Movement happens quite a lot, so
32 you can shorten that to just NORTH, and you can even use the initial(s) of
33 the direction in which you want to travel (easier and faster to type): N,
34 S, E, W, NE, NW, SE and SW.  Also available are UP (U), DOWN (D) and,
35 occasionally, IN and OUT.  There is quite an impressive stock of standard
36 actions which can generally be relied upon to do something, even if only to
37 tell you that you're wasting your time:
38
39 .. include:: /tables/actions.rst
40
41 You don't have to play IF with a list like this open in front of you; the
42 idea is that a good game should understand whatever seems logical for you
43 to try next.  Sometimes that will be a standard action, sometimes a verb
44 like SALUTE or PHOTOGRAPH which, although less common, makes perfect sense
45 in context.
46
47 You'll discover that usually many of these actions are fairly irrelevant.
48 Try logical things first (if you have a torch, BURN may be promising, while
49 EAT probably not).  Of special interest are LOOK (or just L), to print a
50 description of the current location; EXAMINE (or X) *object*, which gives
51 you a detailed description of the object; INVENTORY (INV or I) lists the
52 objects you are carrying.  You may combine some of these verbs with
53 prepositions to expand the possibilities: LOOK THROUGH, LOOK AT, LOOK IN,
54 LOOK UNDER all perform different actions.  Remember that we're mentioning
55 only a selection of the possible verbs; if you feel that something else
56 ought to work, try it and see.
57
58 You can change the way the game offers descriptions of locations as you
59 arrive in them.  The default setting is usually BRIEF, which provides you
60 with long descriptions only the first time you enter a new location.  Some
61 people like to change this to VERBOSE, which *always* gives you long
62 location descriptions.  Here are some other special commands and
63 abbreviations you should know:
64
65 | AGAIN (G) repeats the action you've just performed.
66 | WAIT (Z) skips one turn of action while you loiter and see what happens.
67 | QUIT ends the game.
68 | SAVE saves your current position in the game.
69 | RESTORE reloads a previously saved position.
70 | RESTART starts again from the beginning.
71 | SCORE tells you the current state of progress.
72 | UNDO goes back one turn so that your most recent action never happened.
73
74 Often, there will be characters that you'll have to interact with.  Let's
75 suppose you find your cousin Maria: you may ASK (or TELL) MARIA ABOUT
76 something, GIVE (or SHOW) object TO MARIA or ASK MARIA FOR object.
77 Characters may be willing to help you, when you can indicate your wishes
78 with: MARIA, GO NORTH or MARIA, TAKE THE GUN.  If you are really fond of
79 Maria, you may want to KISS her and if she offends you beyond measure, you
80 might like to ATTACK her.
81
82 Once you've referred to an object or a character by name, you may use the
83 pronouns IT, HIM or HER to simplify the typing process.  These pronouns
84 will remain set until you refer to any other object or character.  If you
85 wish to check the current pronoun assignments, type PRONOUNS.  As a rule of
86 the thumb, try to keep your actions simple.  Most games will actually
87 understand long commands like TAKE ALL FROM THE BAG EXCEPT THE GREEN PEARL
88 THEN THROW CAMEMBERT CHEESE AT UGLY MATRON, but such things are hard to
89 type without mistakes.  Also, you'll find that other inputs don't work as
90 well: GO BACK TO THE KITCHEN or GET NEAR THE SINGING PIRATE or READ
91 NEWSPAPER OVER THE SHERIFF'S SHOULDER will all give you error messages of
92 some kind.  Understanding the conventions of command typing is fairly
93 intuitive and you'll quickly master it after a little experimentation.
94
95 .. note::
96
97    We're talking here about the core capabilities that most Inform games
98    provide (though much of this is equally applicable to other IF systems).
99    Often the designer will have extended these capabilities by defining
100    additional commands appropriate to the nature of the game; either you'll
101    be told about these, or they'll come naturally to mind during play.
102    Less frequently, some designers like to tamper with the default
103    behaviour of the parser, the interface, or with the way that commands
104    work -- maybe even disabling some of the standard ones completely.  When
105    this happens, it's common and polite practice for the game to let you
106    know.