Merge branch 'skillmenu'
[crawl.git] / crawl-ref / source / dat / database / help.txt
1 %%%%
2 pick-up
3
4                    <h>Picking up and dropping items</h>
5 <h>Item letters</h>
6 Pressing an item's letter key will select the item.
7 Entering a number before the letter will only select that quantity.
8
9 <h>Regular expressions</h>
10 You can press <w>Ctrl-F</w> to enter a word (or a regular expression).
11 All matching items will be selected.
12
13 <h>Cursor</h>
14 There are shortcuts to quickly select several items in succession:
15 <w>.</w>   selects the next item and moves the cursor down
16 <w>'</w>   moves the cursor down without changing selection
17 The cursor is usually hidden; pressing <w>.</w> or <w>'</w> makes it appear.
18
19 <h>Category shortcuts</h>
20 You can quickly select items by type by pressing:
21 <w>!</w>   potions      <w>(</w>   weapons        <w>)</w>   ammunition      <w>[</w>   armour
22 <w>/</w>   wands        <w>\</w>   rods           <w>|</w>   magical staves  <w>?</w>   scrolls
23 <w>"</w>   amulets      <w>=</w>   rings          <w>}</w>   miscellaneous   <w>:</w> or <w>+</w>   books
24 <w>%</w>   food
25 Global selects:  <w>,</w>   select all     <w>*</w>   invert all      <w>-</w>   deselect all
26 Note that for dropping, the <w>,</w> command uses the <w>drop_filter</w> option, which
27 narrows the range of items to be (de)selected. The default are useless items.
28 %%%%
29 known-menu
30
31                    <h>Known items menu</h>
32 <h>Item letters</h>
33 Pressing an item type's letter key selects that item.
34
35 <h>Selecting item types</h>
36 Items types displayed in grey use the default autopickup options set in your
37 configuration file. Selecting a type of item overrides those options
38 (indicated by <w>white</w> text), and toggles the item between the states:
39  <w>+</w>  Items of this type will be picked up automatically.
40  <w>-</w>  Items of this type will will not be picked up automatically.
41 Autopickup can also be toggled for all unknown items of a given category.
42
43 <h>Category shortcuts</h>
44 You can quickly select all item types in a given category by pressing:
45 <w>!</w>   potions      <w>?</w>   scrolls      <w>(</w>   ammunition        <w>"</w>   amulets
46 <w>=</w>   rings        <w>/</w>   wands        <w>|</w>   magical staves
47 Global selects:  <w>*</w>   invert all   <w>^</w>   reset all to default
48
49 <h>Viewing unknown and known items</h>
50 <w>\</w> and <w>-</w> toggle between the known and unknown items menus. Note
51 that none of the above features are available from the unknown items menu.
52
53 <h>Restoring autopickup defaults</h>
54 Pressing <w>Ctrl-D</w> followed by an item letter or a category shortcut
55 cancels the override and restores the selected item or items to their default
56 settings.
57
58 <h>Regular expressions</h>
59 You can press <w>Ctrl-F</w> to enter a word (or a regular expression).
60 All matching items will be selected.
61
62 <h>Cursor</h>
63 There are shortcuts to quickly select several items in succession:
64 <w>.</w>   selects the next item and moves the cursor down
65 <w>'</w>   moves the cursor down without changing selection
66 The cursor is usually hidden; pressing <w>.</w> or <w>'</w> makes it appear.
67
68 %%%%
69 stash-search.prompt
70
71 <h>Searching the stash-tracker</h>
72
73 You can search for items and dungeon features by name (or a substring of the
74 name). In the list of search results, you can select a search result by its
75 hotkey to travel to its location.
76
77 Some examples of search strings:
78 <w>cure mutation</w> find all potions of cure mutation, including potions in shops.
79 <w>royal</w>         finds every single royal jelly and heaps of royal jellies.
80 <w>shop</w>          lists all shops. Press <w>?</w> and a shop's letter for the stock.
81 <w>Lair:2</w>        find everything known to be on Lair:2.
82 <w>D:[2-4]</w>       finds everything on Dungeon levels 2-4. Regexes are allowed!
83               Note that D:[3-10] will not work as intended, since [x-y] is a
84               regex character range.
85 <w>rPois</w>         finds all items with an rPois resistance.
86 <w>rC\+\+</w>        finds all items with an rC++ resistance.
87 <w>\+3</w>           finds all items with a +3 enchantment. Note with these that
88               the + symbol had to be escaped as \+ due to regex syntax.
89 <w>Lair.*axe</w> and <w>axe && Lair</w> both show all axes in the Lair.
90
91 Some shortcuts:
92 <w>.</w>             lists everything on your current level.
93 <w>..</w>            lists all items you know.
94 <w>0</w> to <w>9</w>        lists all items at the specified waypoint.
95 <w>*</w>             lists all items at all waypoints.
96 <w>@(pattern)</w>    lists everything matching (pattern) on your current level.
97
98 You can also examine shops and items in the search results by pressing <w>?</w> and
99 then selecting the hotkey for the search result. This will give a description
100 of the item or the contents of the shop.
101
102 The stash search string is case-insensitive.
103
104 <h>Searching by item properties:</h>
105
106 You can search for spell names (such as <w>Ignite Poison</w>) to find spellbooks
107 that contain the spell.
108
109 You can search for artefact item properties (such as <w>prevents.*teleport</w>)
110 to find artefacts that have the property.
111
112 You can search by some additional item properties: <w>artefact</w> or <w>artifact</w> will
113 find identified artefacts, <w>ego</w> or <w>branded</w> will find non-artefacts with a
114 brand and unidentified items which may be branded, <w>throwable</w> will find things
115 you can throw, <w>stick</w> will find items that can be used with Sticks to Snakes,
116 and <w>dropped</w> will find items you have dropped.
117
118 Skill names (such as <w>Polearms</w> or <w>Long Blades</w>) will find all weapons that
119 train that skill. You can also look for <w>melee weapon</w> and <w>ranged weapon</w>.
120
121 You can also search by item types such as <w>book</w> or <w>manual</w> or <w>jewellery</w>.
122 For armour slots, use <w>helmet</w> (all headgear), <w>gloves</w>, <w>shield</w>, and <w>body</w>.
123 Use <w>armour && !!body</w> to list all armour pieces except for body armour.
124
125 <h>Finding Dungeon Features:</h>
126
127 You can search for dungeon features by name: all shops will be found by a
128 search for <w>shop</w> (including shops that do not have "shop" in their name);
129 other dungeon features can also be found by name: <w>fountain</w>, <w>spear trap</w>,
130 <w>altar</w>, etc. You can also search for altars by deity name: <w>Zin</w>.
131
132 <h>Non-regex operators:</h>
133
134 You can use !! to negate a search string, && for a boolean AND, || for
135 boolean OR, and <<<< >> for grouping.
136
137 For instance, to find rings (jewellery) but not ring mail you could use:
138 <w>ring && !!mail</w>
139 %%%%
140 level-map
141
142 <h>Level Map ('<w>X</w>' in the main screen):</h>
143 <w>Esc</w>        : Leave level map (also <w>Space</w> or any unused key).
144 <w>Dir.</w>       : Move the cursor.
145 <w>Shift-Dir.</w> : Move the cursor in larger steps (7 by default).
146 <w>-</w> or <w>+</w>     : Scroll level map 20 grids up or down.
147 <w>.</w>          : Start travel (also <w>Enter</w> and <w>,</w> and <w>;</w>).
148              (Moves cursor to the last travel destination if still on @.)
149 <w>[</w> or <w>]</w>     : Examine the next higher or lower level
150 <w>G</w>          : Go to another level by branch and depth
151 <w>o</w>          : Move the cursor to the next autoexplore target.
152
153 <h>Travel exclusions</h>
154 <w>e</w>          : Create a travel exclusion, change its radius, or remove it.
155 <w>E</w>          : Cycle through travel exclusions.
156 <w>Ctrl-E</w>     : Erase all travel exclusions on the level.
157
158 <h>Waypoints</h>
159 <w>Ctrl-W</w>     : Set waypoint to current position.
160 <w>W</w>          : Cycle through all waypoints on the level.
161
162 <h>Cycle through features</h>
163 <w><<</w> or <w>></w>     : Cycle through up or down stairs.
164 <w>^</w>          : Cycle through traps.
165 <w>\</w> or <w>Tab</w>   : Cycle through shops and portals.
166 <w>I</w>          : Cycle forward through all items.
167 <w>O</w>          : Cycle backward through all items.
168 <w>_</w>          : Cycle through altars.
169
170 <h>Other</h>
171 <w>v</w>          : Examine the last remembered state of the indicated tile.
172 <w>!</w>          : Annotate level.
173 <w>Ctrl-C</w>     : Clear item and monster memory.
174 <w>Ctrl-F</w>     : Forget level map.
175 <w>Ctrl-U</w>     : Restore forgotten level map.{{
176 if you.wizard() then
177     return "\n\n"
178           .. "<h>Wizard commands</h>\n"
179           .. "<w>T</w>          : Teleport to cursor."
180 end }}
181 %%%%
182 interlevel-travel.branch.prompt
183
184 <h>Interlevel Travel (choose a branch):
185  Use the shortcut letter for a branch to select the branch for travel.
186
187  Once you select a branch, you will be prompted for a depth in that
188  branch (more help is available there).
189
190  <w>Enter</w>  : Repeat last interlevel travel.
191  <w>.</w>      : Travel to a level in the current branch.
192  <w><<</w>      : Go up the nearest stairs.
193  <w>></w>      : Go down the nearest stairs.
194  <w>Ctrl-P</w> : Travel to a level in the branch above this one.
195  <w>*</w>      : Show available waypoints (if any are set).
196  <w>0</w>-<w>9</w>    : Go to the numbered waypoint.
197 %%%%
198 interlevel-travel.depth.prompt
199
200 <h>Interlevel Travel (go to a specific level in the selected branch)
201  Type in the level number you want to go to and press Enter, or use:
202  <w>Enter</w>  : Go to the default level.
203  <w>0</w>      : Go to the entrance to the current branch.
204  <w><<</w>      : Change the default to one level above the current.
205  <w>></w>      : Change default to one level below the current.
206  <w>-</w> or <w>p</w> : Change default to the branch above this one.
207  <w>$</w>      : Change default to deepest visited level in this branch.
208  <w>^</w>      : Change default to the entrance to the current branch.
209 %%%%
210 butchering
211
212 <h>Butchering<h>
213 <w>y, c</w>: Butcher/bottle the selected corpse.
214 <w>a</w>   : Butcher/bottle this corpse and all the ones following in the stack.
215       If the prompt is about bottling the blood, all bloodless corpses
216       will be skipped.
217 <w>q</w>   : Quit the prompt (don't butcher/bottle anything).
218 <w>n</w>   : Don't butcher/bottle this corpse, skip to the next one.
219       (This is the default behaviour if you answer with anything not
220        listed here.)
221
222 <h>Notes for Tiles</h>
223 If you are playing with Tiles you can butcher (or bottle) a single
224 corpse on the ground by clicking the <w>left mouse button</w> while pressing
225 <w>Shift</w>.
226 %%%%
227 skill-menu
228
229                         <h>Skill management</h>
230 You gain experience for killing monsters (and very few other activities).
231 This experience is used to train skills. The skill screen allows you to
232 select which skills to train.
233 A skill can only be trained if there's some available means of exercising it;
234 see "Training restrictions" below for details.
235
236 By pressing its letter, you can cycle if and how a skill is trained:
237 <darkgrey>- deselected</darkgrey>    Skill will not be trained.
238 + selected      Skill will be trained.
239 <w>* focused</w>       Skill will be weighted higher for training.
240
241 Pressing a capital letter selects that skill and deselects all the others.
242 This shortcut is useful when you want to train only one skill.
243
244 Training can be done in two modes, which are toggled with the <w>/</w> key.
245 - automatic:    Skills are weighted based on your use of them.
246 - manual:       Experience is spread evenly across all activated skills.
247
248 How fast you train a skill is governed by the following factors:
249 - aptitude: Shown <white>white</white> in the Apt column. Higher numbers mean that less
250             experience is needed to advance a skill. Depends on species.
251 - skill manuals: Rare books giving an aptitude bonus of <lightgreen>+4</lightgreen> in one skill.
252
253 On top of that, there are some effects which directly modify a skill, for
254 example draining, having trained a related skill (crosstraining), or certain
255 god powers. Reduced skills are shown in <magenta>magenta</magenta>, and enhanced skills in <blue>blue</blue>.
256 The training percentage (in <brown>brown</brown>) shows the relative amount of experience
257 which will be used to train this skill.
258
259 Apart from (de)selecting skills, you also have the following toggles:
260 <w>/</w> :  Switch between automatic and manual training modes.
261 <w>*</w> :  Display all skills, even those you can't train yet.
262 <w>?</w> :  Allows you to read the descriptions of skills.
263 <w>_</w> :  Show or hide skill level modifications (drain, god powers, crosstraining).
264
265                         <h>Training restrictions</h>
266 Fighting, Throwing, Armour, Dodging, Stealth, Unarmed Combat, and Spellcasting
267 can always be trained. For the rest:
268 - Weapon skills require carrying a weapon of the appropriate type.
269 - Shields requires that you either be carrying a shield, or worship a deity
270       who can offer one through divine means (The Shining One).
271 - Evocations requires carrying an evocable item, or worshipping Nemelex Xobeh.
272 - Spell schools require knowing a spell of the school.
273 - Necromancy can also be trained when worshipping Kikubaaqudgha.
274 - Invocations requires worshipping a god whose abilities require it.
275 %%%%