Angband 3.0.9b.

[angband.git] / lib / help / playing.txt

=== Playing the Game ===\r
\r
    Most of your interaction with Angband will take the form of "commands".\r
Every Angband command consists of an "underlying command" plus a variety of\r
optional or required arguments, such as a repeat count, a direction, or the\r
index of an inventory object.  Commands are normally specified by typing a\r
series of keypresses, from which the underlying command is extracted, along\r
with any encoded arguments.  You may choose how the standard "keyboard keys"\r
are mapped to the "underlying commands" by choosing one of the two standard\r
"keysets", the "original" keyset or the "roguelike" keyset.\r
\r
    The original keyset is very similar to the "underlying" command set,\r
with a few additions (such as the ability to use the numeric "directions" to\r
"walk" or the "5" key to "stay still").  The roguelike keyset provides similar\r
additions, and also allows the use of the h/j/k/l/y/u/b/n keys to "walk" (or,\r
in combination with the shift or control keys, to run or alter), which thus\r
requires a variety of key mappings to allow access to the underlying commands\r
used for walking/running/altering.  In particular, the "roguelike" keyset\r
includes many more "capital" and "control" keys, as shown below.\r
\r
    Note that any keys that are not required for access to the underlying\r
command set may be used by the user to extend the "keyset" which is being\r
used, by defining new "keymaps".  To avoid the use of any "keymaps", press\r
backslash ("\") plus the "underlying command" key.  This is normally only\r
used in "macro" definitions.  You may enter "control-keys" as a caret ("^")\r
plus the key (so "^" + "p" yields "^P").\r
\r
    Some commands allow an optional "repeat count", which allows you to tell\r
the game that you wish to do the command multiple times, unless you press a\r
key or are otherwise disturbed.  To enter a "repeat count", type '0', followed\r
by the numerical count, followed by the command.  You must type "space" before\r
entering certain commands.  Skipping the numerical count yields a count of 99.\r
An option allows certain commands (open, disarm, alter, etc) to auto-repeat.\r
\r
    Some commands will prompt for extra information, such as a direction, an\r
inventory or equipment item, a spell, a textual inscription, the symbol of a\r
monster race, a sub-command, a verification, an amount of time, a quantity,\r
a file name, or various other things.  Normally you can hit return to choose\r
the "default" response, or escape to cancel the command entirely.\r
\r
    Some commands will prompt for a spell or an inventory item.  Pressing\r
space (or '*') will give you a list of choices.  Pressing "-" (minus) selects\r
the item on the floor.  Pressing a lowercase letter selects the given item.\r
Pressing a capital letter selects the given item after verification.  Pressing\r
a numeric digit '#' selects the first item (if any) whose inscription contains\r
"@#" or "@x#", where "x" is the current "underlying command".  You may only\r
specify items which are "legal" for the command.  Whenever an item inscription\r
contains "!*" or "!x" (with "x" as above) you must verify its selection.\r
\r
    Some commands will prompt for a direction.  You may enter a "compass"\r
direction using any of the "direction keys" shown below.  Sometimes, you may\r
specify that you wish to use the current "target", by pressing "t" or "5", or\r
that you wish to select a new target, by pressing "*" (see "Target" below).\r
\r
        Original Keyset Directions       Roguelike Keyset Directions\r
\r
                 7  8  9                           y  k  u\r
                 4     6                           h     l\r
                 1  2  3                           b  j  n\r
\r
\r
    Each of the standard keysets provides some short-cuts over the "underlying\r
commands".  For example, both keysets allow you to "walk" by simply pressing\r
an "original" direction key (or a "roguelike" direction key if you are using\r
the roguelike keyset), instead of using the "walk" command plus a direction.\r
The roguelike keyset allows you to "run" or "alter" by simply holding the\r
shift or control modifier key down while pressing a "roguelike" direction key,\r
instead of using the "run" or "alter" command plus a direction.  Both keysets\r
allow the use of the "5" key to "stand still", which is most convenient when\r
using the original keyset.\r
\r
    Note that on many systems, it is possible to define "macros" to various\r
keys, or key combinations, so that it is often possible to make macros which,\r
for example, allow the use of the shift and/or control modifier keys, plus a\r
numeric keypad key, to specify the "run" or "alter" command, with the given\r
direction, regardless of any keymap definitions, by using the fact that you\r
can always, for example, use "\" + "." + "6", to specify "run east".\r
\r
\r
\r
=== Original Keyset Command Summary ===\r
\r
 a  Aim a wand                           A  Activate an artifact\r
 b  Browse a book                        B  Bash a door\r
 c  Close a door                         C  Character description\r
 d  Drop an item                         D  Disarm a trap\r
 e  Equipment list                       E  Eat some food\r
 f  Fire an item                         F  Fuel your lantern/torch\r
 g  Get objects on floor                 G  Gain new spells/prayers\r
 h  (unused)                             H  (unused)\r
 i  Inventory list                       I  Observe an item\r
 j  Jam a door                           J  (unused)\r
 k  Destroy an item                      K  (unused)\r
 l  Look around                          L  Locate player on map\r
 m  Cast a spell                         M  Full dungeon map\r
 n  (unused)                             N  (unused)\r
 o  Open a door or chest                 O  (unused)\r
 p  Pray a prayer                        P  (unused)\r
 q  Quaff a potion                       Q  Quit (commit suicide)\r
 r  Read a scroll                        R  Rest for a period\r
 s  Search for traps/doors               S  Toggle search mode\r
 t  Take off equipment                   T  Dig a tunnel\r
 u  Use a staff                          U  (unused)\r
 v  Throw an item                        V  Version info\r
 w  Wear/wield equipment                 W  (unused)\r
 x  (unused)                             X  (unused)\r
 y  (unused)                             Y  (unused)\r
 z  Zap a rod                            Z  (unused)\r
 !  Interact with system                ^A  (special - debug command)\r
 @  (unused)                            ^B  (unused)\r
 #  (unused)                            ^C  (special - break)\r
 $  (unused)                            ^D  (unused)\r
 %  (unused)                            ^E  Toggle choice window\r
 ^  (special - control key)             ^F  Repeat level feeling\r
 &  (unused)                            ^G  (unused)\r
 *  Target monster or location          ^H  (unused)\r
 (  Load screen dump                    ^I  (special - tab)\r
 )  Dump screen dump                    ^J  (special - linefeed)\r
 {  Inscribe an object                  ^K  (unused)\r
 }  Uninscribe an object                ^L  (unused)\r
 [  (unused)                            ^M  (special - return)\r
 ]  (unused)                            ^N  (unused)\r
 -  Walk (flip pickup)                  ^O  (unused)\r
 _  Enter store                         ^P  Show previous messages\r
 +  Alter grid                          ^Q  (unused)\r
 =  Set options                         ^R  Redraw the screen\r
 ;  Walk (with pickup)                  ^S  Save and don't quit\r
 :  Take notes                          ^T  (unused)\r
 '  (unused)                            ^U  (unused)\r
 "  Enter a user pref command           ^V  Repeat last command\r
 ,  Stay still (with pickup)            ^W  (special - wizard mode)\r
 <  Go up staircase                     ^X  Save and quit\r
 .  Run                                 ^Y  (unused)\r
 >  Go down staircase                   ^Z  (special - borg command)\r
 \  (special - bypass keymap)            |  (unused)\r
 `  (special - escape)                   ~  Check knowledge\r
 /  Identify symbol                      ?  Help\r
\r
\r
\r
=== Roguelike Keyset Command Summary ===\r
\r
 a  Zap a rod (Activate)                 A  Activate an artifact\r
 b  (walk - south west)                  B  (run - south west)\r
 c  Close a door                         C  Character description\r
 d  Drop an item                         D  Disarm a trap or chest\r
 e  Equipment list                       E  Eat some food\r
 f  Bash a door (force)                  F  Fuel your lantern/torch\r
 g  Get objects on floor                 G  Gain new spells/prayers\r
 h  (walk - west)                        H  (run - west)\r
 i  Inventory list                       I  Observe an item\r
 j  (walk - south)                       J  (run - south)\r
 k  (walk - north)                       K  (run - north)\r
 l  (walk - east)                        L  (run - east)\r
 m  Cast a spell                         M  Full dungeon map\r
 n  (walk - south east)                  N  (run - south east)\r
 o  Open a door or chest                 O  (unused)\r
 p  Pray a prayer                        P  Browse a book\r
 q  Quaff a potion                       Q  Quit (commit suicide)\r
 r  Read a scroll                        R  Rest for a period\r
 s  Search for traps/doors               S  Jam a door (Spike)\r
 t  Fire an item                         T  Take off equipment\r
 u  (walk - north east)                  U  (run - north east)\r
 v  Throw an item                        V  Version info\r
 w  Wear/wield equipment                 W  Locate player on map (Where)\r
 x  Look around                          X  (unused)\r
 y  (walk - north west)                  Y  (run - north west)\r
 z  Aim a wand (Zap)                     Z  Use a staff (Zap)\r
 !  Interact with system                ^A  (special - debug command)\r
 @  (unused)                            ^B  (alter - south west)\r
 #  Toggle search mode                  ^C  (special - break)\r
 $  (unused)                            ^D  Destroy item\r
 %  (unused)                            ^E  Toggle choice window\r
 ^  (special - control key)             ^F  Repeat level feeling\r
 &  (unused)                            ^G  (unused)\r
 *  Target monster or location          ^H  (alter - west)\r
 (  Load screen dump                    ^I  (special - tab)\r
 )  Dump screen dump                    ^J  (alter - south)\r
 {  Inscribe an object                  ^K  (alter - north)\r
 }  Uninscribe an object                ^L  (alter - east)\r
 [  (unused)                            ^M  (special - return)\r
 ]  (unused)                            ^N  (alter - south east)\r
 -  Walk (flip pickup)                  ^O  (unused)\r
 _  Enter store                         ^P  Show previous messages\r
 +  Alter grid                          ^Q  (unused)\r
 =  Set options                         ^R  Redraw the screen\r
 ;  Walk (with pickup)                  ^S  Save and don't quit\r
 :  Take notes                          ^T  Dig a Tunnel\r
 '  (unused)                            ^U  (alter - north east)\r
 "  Enter a user pref command           ^V  Repeat last command\r
 ,  Run                                 ^W  (special - wizard mode)\r
 <  Go up staircase                     ^X  Save and quit\r
 .  Stay still (with pickup)            ^Y  (alter - north west)\r
 >  Go down staircase                   ^Z  (special - borg command)\r
 \  (special - bypass keymap)            |  (unused)\r
 `  (special - escape)                   ~  Check knowledge\r
 /  Identify symbol                      ?  Help\r
\r
\r
\r
=== Special Keys ===\r
 \r
        Certain special keys may be intercepted by the operating system or\r
the host machine, causing unexpected results.  In general, these special keys\r
are control keys, and often, you can disable their special effects.\r
\r
        If you are playing on a UNIX or similar system, then Ctrl-C will\r
interrupt Angband.  The second and third interrupt will induce a warning\r
bell, and the fourth will induce both a warning bell and a special message,\r
since the fifth will quit the game, after killing your character.  Also,\r
Ctrl-Z will suspend the game, and return you to the original command shell,\r
until you resume the game with the "fg" command.  There is now a compilation\r
option to force the game to prevent the "double ctrl-z escape death trick".\r
The Ctrl-\ and Ctrl-D and Ctrl-S keys should not be intercepted.\r
 \r
        It is often possible to specify "control-keys" without actually\r
pressing the control key, by typing a caret ("^") followed by the key.\r
This is useful for specifying control-key commands which might be caught\r
by the operating system as explained above.\r
\r
        Pressing backslash ("\") before a command will bypass all keymaps,\r
and the next keypress will be interpreted as an "underlying command" key,\r
unless it is a caret ("^"), in which case the keypress after that will be\r
turned into a control-key and interpreted as a command in the underlying\r
angband keyset.  The backslash key is useful for creating macro actions\r
which are not affected by any keymap definitions that may be in force, for\r
example, the sequence "\" + "." + "6" will always mean "run east", even if\r
the "." key has been mapped to a different underlying command.\r
\r
        The "0" and "^" and "\" keys all have special meaning when entered\r
at the command prompt, and there is no "useful" way to specify any of them\r
as an "underlying command", which is okay, since they would have no effect.\r
\r
        For many input requests or queries, the special character ESCAPE\r
will abort the command.  The "[y/n]" prompts may be answered with "y" or\r
"n", or escape.  The "-more-" message prompts may be cleared (after reading\r
the displayed message) by pressing ESCAPE, SPACE, RETURN, LINEFEED, or by\r
any keypress, if the "quick_messages" option is turned on.\r
 \r
\r
=== Command Counts ===\r
 \r
        Some commands can be executed a fixed number of times by preceding\r
them with a count.  Counted commands will execute until the count expires,\r
until you type any character, or until something significant happens, such\r
as being attacked.  Thus, a counted command doesn't work to attack another\r
creature.  While the command is being repeated, the number of times left\r
to be repeated will flash by on the line at the bottom of the screen.\r
\r
        To give a count to a command, type 0, the repeat count, and then\r
the command.  If you want to give a movement command and you are using the\r
original command set (where the movement commands are digits), press space\r
after the count and you will be prompted for the command.\r
 \r
        Counted commands are very useful for time consuming commands, as\r
they automatically terminate on success, or if you are attacked.  You may\r
also terminate any counted command (or resting or running), by typing any\r
character.  This character is ignored, but it is safest to use a SPACE or\r
ESCAPE which are always ignored as commands in case you type the command\r
just after the count expires.\r
\r
        You can tell Angband to automatically use a repeat count of 99\r
with commands you normally want to repeat (open, disarm, tunnel, bash,\r
alter, etc) by setting the "always_repeat" option.\r
 \r
 \r
=== Selection of Objects ===\r
 \r
        Many commands will also prompt for a particular object to be used.\r
For example, the command to read a scroll will ask you which of the\r
scrolls that you are carrying that you wish to read.  In such cases, the\r
selection is made by typing a letter of the alphabet.  The prompt will\r
indicate the possible letters, and will also allow you to type the key\r
"*", which causes all of the available options to be described.  The list\r
of choices will also be shown in the Choice window, if you are using a\r
windows environment and windows are turned on.  Often you will be able to\r
press "/" to select an object from your equipment instead of your\r
inventory.  Pressing space once will have the same effect as "*", and\r
the second time will cancel the command and run the "i" or "e" command.\r
 \r
        The particular object may be selected by an upper case or a lower\r
case letter.  If lower case is used, the selection takes place\r
immediately.  If upper case is used, then the particular option is\r
described, and you are given the option of confirming or retracting that\r
choice.  Upper case selection is thus safer, but requires an extra key\r
stroke.  Also see the "!*" and "!x" inscriptions, below.\r
\r
        For many commands, you can also use "-" to select an object on the\r
floor where you are standing.  This lets you read scrolls or quaff\r
potions, for example, off the dungeon floor without picking them up.\r
\r
        If you enter a number between 0 and 9, the first item engraved\r
with "@#" where "#" is the number you entered will be selected.  For example,\r
if you have a shovel engraved with "@0" and you type "w" (for wield) and\r
then 0, you will wield the shovel.  This is very useful for macros (see\r
below), since you can use this to select an object regardless of its\r
location in your pack.  For example, Angband automatically defines a macro\r
for the key "X" to do "w0".  If you then engrave both your digging\r
instrument and your primary weapon with @0, pressing X will wield\r
whichever one is not being currently wielded (letting you quickly switch\r
between them).  Multiple numbers can be engraved on the same object; for\r
example, if a sword is engraved with @1@0, then either "w1" or "w0" will\r
wield it.  Normally, you inscribe "@1@0" on your primary weapon, and\r
"@2@0" on your digger or secondary weapon.  Note that an inscription\r
containing "@x#" will act like "@#" but only when the current "Angband\r
command" is "x".  Thus you can put "@z4" on a rod and "@u4" on a staff,\r
and then use both "z4" and "u4" as desired.\r
\r
        Note that any object containing "!x" in its inscription, where\r
"x" is the current "angband command" (or containing "!*" ever) will induce\r
"verification" whenever that object is "selected".  Thus, inscribing, say,\r
"!f!k!d" on an object will greatly reduce the odds of you "losing" it by\r
accident, and inscribing "!*" on an object will allow you to be very paranoid\r
about the object.  Note that "selling" and "dropping" both use the "d" command.\r
\r
\r
=== User Pref Files ===\r
\r
        Angband allows you to change various aspects of the game to suit\r
your tastes.  You may define keymaps (changing the way Angband maps your\r
keypresses to underlying commands), create macros (allowing you to map a\r
single keypress to a series of keypresses), modify the visuals (allowing\r
you to change the appearance of monsters, objects, or terrain features),\r
change the colors (allowing you to make a given color brighter, darker,\r
or even completely different), or set options (turning them off or on).\r
\r
        Angband stores your preferences in files called "user pref files",\r
which contain comments and "user pref commands", which are simple strings\r
describing one aspect of the system about which the user has a preference.\r
There are many ways to load a user pref file, and in fact, some of these\r
files are automatically loaded for you by the game.  All of the files are\r
kept in the "lib/user/" directory, though you may have to use one of the\r
command line arguments to redirect this directory, especially on multiuser\r
systems.  You may also enter single user pref commands directly, using the\r
special "Enter a user pref command" command, activated by "double quote".\r
You may have to use the "redraw" command (^R) after changing certain of\r
the aspects of the game, to allow Angband to adapt to your changes.\r
\r
        When the game starts up, after you have loaded an old character,\r
or created a new character, some user pref files are loaded automatically.\r
First, the "pref.prf" file is loaded.  This file contains some user pref\r
commands which will work on all platforms.  Then one of "font-xxx.prf"\r
(for normal usage) or "graf-xxx.prf" (for bitmap usage) is loaded.  These\r
files contain attr/char changes to allow the monsters, objects, and/or\r
terrain features to look "better" on your system.  Then the "pref-xxx.prf"\r
file is loaded.  This file contains pre-defined system specific stuff\r
(macros, color definitions, etc).  Then, the "user-xxx.prf" file is loaded.\r
This file contains user-defined system specific stuff.  The "user-xxx.prf"\r
file is used as the "default" user pref file in many places.  The "xxx" is\r
the "system suffix" for your system, taken from the "main-xxx.c" file which\r
was used to generate your executable.  Finally, the "Race.prf", "Class.prf",\r
and "Name.prf" files are loaded, where "Race", "Class", and "Name" are\r
replaced by the actual race, class, and name of the current character.\r
\r
        Several commands allow you to both load existing user pref files,\r
create new user pref files, append information to existing user pref files,\r
and/or interact with various of the user preferences in a more intuitive\r
way than the user pref commands allow.  The commands include "Interact with\r
macros" (@), "Interact with visuals" (%), and "Interact with colors" (&),\r
described below.\r
\r
--- User Pref Files (Macros) ---\r
\r
        The "Interact with macros" command allows you to define or remove\r
"macros", which are mappings from a single logical keypress to a sequence\r
of keypresses, allowing you to use special keys on the keyboard, such as\r
function keys or keypad keys, possibly in conjunction with modifier keys,\r
to "automate" repetitive multi-keypress commands that you use a lot.\r
\r
        Since macros represent keypress sequences, and not all keypresses\r
have a printable representation, macro triggers and actions must often be\r
"encoded" into a human readible form.  This is done using several types\r
of encoding, including "\xHH" for character number HH in hexidecimal, "\e"\r
for the "escape" code, "\n" for the "newline" code, "\r" for the "return"\r
code, "\s" for the "space" code, "\\" for backslash, "\^" for caret, and\r
"^X" for the code for any "control" key "ctrl-X".  Note that the "action"\r
of a macro will not be checked against other macro triggers (unless the\r
macro action contains a "control-backslash"), so you cannot make infinite\r
loops.  You may specify extremely long macros, but you are limited in\r
length by the underlying input mechanisms, which in general limit you\r
to about 1024 keys in both triggers and actions.\r
\r
        The special "\" command (which must be encoded in macros as "\\")\r
is very useful in macros, since it bypasses all keymaps and allows the next\r
keystroke to be considered a command in the underlying Angband command set.\r
For a list of the Angband command set, see the "command.txt" help file.\r
For example, a macro which maps Shift-KP6 to "\" + "." + "6" will induce\r
the "run east" behavior, regardless of what keyset the user has chosen, and\r
regardless of what keymaps have been defined.\r
\r
        Macros can be specified in user pref files as a pair of lines, one\r
of the form "A:<str>", which defines the encoded macro action, and one of\r
the form "P:<str>", which defines the encoded macro trigger.\r
\r
--- User Pref Files (Keymaps) ---\r
\r
        The "Interact with macros" command also allows you to define\r
"keymaps", which are vaguely related to macros.  A keymap maps a single\r
keypress to a series of keypresses, which bypass both other keymaps and\r
any macros.  Angband uses keymaps to map the original and the roguelike\r
keysets to the underlying command set, and allows the user to modify or\r
add keymaps of their own.  Note that all keymap actions must be specified\r
using underlying commands, not keypresses from the original or roguelike\r
keysets.  The original keyset is almost identical to the underlying keyset,\r
except that "numbers" are mapped to ";" plus a direction, "5" is mapped to\r
",", and a few control-keys are mapped to various things.  See "command.txt"\r
for the full set of underlying commands.  Some uses for keymaps include the\r
ability to "disable" a command by mapping it to "\x00", \r
\r
        Keymaps can be specified in user pref files as line of the form\r
"M:<T> <key> <str>", where <T> is the keyset (0/1 for original/roguelike),\r
<key> is the encoded trigger key, and <str> is the encoded keymap action.\r
\r
--- User Pref Files (Visuals) ---\r
\r
        You can use the "Interact with visuals" command to change various\r
visual information, currently including the choice of what attr/char values\r
are used to represent various monsters, objects, or terrain features.  Note\r
that in combination appropriate support in "main-xxx.c", and with the use of\r
the "use_graphics" flag, you may be able to specify that "graphic bitmaps"\r
should be used instead of normal "colored characters" for various things.\r
\r
        When interactively modifying the attr/char values for monsters,\r
objects, or terrain features, pressing "n" or "N" will change which entry\r
you are changing, pressing "a" or "A" will rotate through the available\r
attr values, and pressing "c" or "C" will rotate though the available char\r
values.  Note that attr/char values with the "high bit" set may induce the\r
display of special "graphic" pictures if the "use_graphics" flag is set,\r
and your system supports the "use_graphics" flag.\r
\r
        Note that this command can be abused in various ways, and if you\r
must do so, remember that you are only cheating yourself.\r
\r
        Keymaps can be specified in user pref files as line of the form\r
"R:<N>:<A>/<C>" or "K:<N>:<A>/<C>" or "F:<N>:<A>/<C>" or "U:<N>:<A>/<C>".\r
\r
--- User Pref Files (Colors) ---\r
\r
        The "Interact with colors" command allows you to change the actual\r
internal values used to display various colors.  This command may or may\r
not have any effect on your machine.  Advanced machines may allow you to\r
change the actual RGB values used to represent each of the 16 colors used\r
by Angband, and perhaps even allow you to define new colors which are not\r
currently used by Angband.\r
\r
        Colors can be specified in user pref files as line of the form\r
"V:<N>:<V>:<R>:<G>:<B>".\r
\r
--- User Pref Files (Options) ---\r
\r
        The "Interact with options" command allows you to turn options\r
on or off.  You may turn options off or on using the user pref commands\r
of the form "X:<option>" or "Y:<option>" respectively.\r
\r