OSDN Git Service

Added autoconf/automake bootstrap script to EXTRA_DIST.
[hengbandforosx/hengbandosx.git] / autopick_eng.txt
1 # autopick.txt for Hengband
2 #
3 # The last part of this file is an example of 'pickpref.prf'. 
4 # You can copy this file to lib\user\ or ~/.angband/Hengband/ 
5 # to use as preference of auto-picker.
6 # (UNIX user must copy to ~/.angband/Hengband/. Others must 
7 # copy to lib\user\ .)
8 #
9 #    =====   How to use auto-picker/destroyer   ========
10 #    
11 #     Press the _ in a game to enter editor mode for preference of
12 #     auto-picker/destroyer.  Basic usage of the editor is almost same
13 #     as vi, and also have emacs like commands.  Most commands is
14 #     always displayed on the first line and the right half of the
15 #     screen.
16 #
17 #     Important commands 
18 #      'a', 'i' or ^Q :  Enter insert mode from command mode
19 #      ESC  or ^Q     :  Return to command mode from insert mode
20 #      'q'            :  Quit the editor (command mode only)
21 #      'hjkl2468'     :  Move cursor (command mode only)
22 #      ^B ^N ^P ^F    :  Move cursor (always)
23 #      ^I  : Choose an item from inventry/equipment, then insert its name
24 #      ^S  : Rotates action (pick up / destroy / leave on floor)
25 #      ^U  : Rotates identify state (identified / unidentified / ...)
26 #      ^L  : Insert name of the last auto-destroyed item.
27 #      '/' : Search string, or search an item specified by ^I or ^L.
28 #      'n' : Search next
29 #      'N' : Search previous
30 #
31 #      The preference will be saved in a file named
32 #      "pickpref-<<name>>.prf" in your user directory; This will be
33 #      ~/.angband/Hengband/ for UNIX, or hengband\lib\user\ for other
34 #      operating systems.  You may edit this file using any text
35 #      editor, and may use the '$' command within the game to reread
36 #      this file.  When you don't use the in-game editor, you may use
37 #      "pickpref.prf" as preference file.
38 #
39 #      When there are both files, the game will read the file
40 #      "pickpref-<<current character name>>.prf" first and then read
41 #      the file "pickpref.prf".  The first-read file takes priority.
42 #
43 #      Notes:
44 #      Maximum number of active lines is 1009.
45 #      A line with a header '#' is a comment.
46 #
47 #
48 #    Editing the file
49 #    ---------
50 #
51 #    Command letter:
52 #           Each line determines the actions taken when you step over
53 #      a kind of object.  Starting a line with '!' indicates that you
54 #      wish to destroy this kind of object.  Starting a line with '~'
55 #      indicates that you wish to leave this kind of object on the
56 #      floor.  Starting a line with ';' indicates that you wish to
57 #      force the game to ask you if you want to pick the item up or
58 #      not.  Otherwise, your character will automatically attempt to
59 #      pick up the object.
60 #           There is an additional command letter '('.  It indicates that 
61 #      you don't wish this item to be displayed in full map. see below.
62 #
63 #      Notes:
64 #      If you want to disable the effect of the '!' indicator temporally, 
65 #      use 'always_pickup' option.
66 #
67 #
68 #    Keywords:
69 #           After the command letter may come one or more keywords.  They are:
70 #
71 #      all               : All items match.
72 #      collecting        : Matches if you already have that same item.
73 #      unaware           : Items with unknown effects match.
74 #      unidentified      : Unidentified items match.
75 #      identified        : Identified items match.
76 #      *identified*      : *Identified* items match.
77 #      dice boosted      : Weapons with boosted damage dice match.
78 #      more than N dice  : Weapons with dice (dd * ds) better than +N match.
79 #      more bonus than N : Items which has more magical bonus than (+N) match.
80 #      worthless         : Items which you cannot sell match.
81 #      artifacts         : Artifact items match.
82 #      ego               : Ego items match.
83 #      nameless          : Non ego/non artifact items match.
84 #      wanted            : Wanted monster's corpses or skeletons match.
85 #      unique monster's  : Unique monster's corpses, skeletons or statues match.
86 #      human             : Human corpses or skeletons match.
87 #      unreadable        : Spellbooks other than those you can read match.
88 #      first realm's     : Your first magic realm's spellbooks match.
89 #      second realm's    : Your second magic realm's spellbooks match.
90 #      first             : First one of four spellbooks in each realm match.
91 #      second            : Second one of four spellbooks in each realm match.
92 #      third             : Third one of four spellbooks in each realm match.
93 #      fourth            : Fourth one of four spellbooks in each realm match.
94 #
95 #      items             : All items match. Use it with an adjective for 
96 #                          readability (i.e. "unaware items").
97 #      weapons           : All weapons including missile weapons match.
98 #      armors            : All armors match.
99 #      missiles          : Arrows, bolts, and shots match.
100 #      magical devices   : Wands, staffs, rods and scrolls match.
101 #      lights            : Light sources match.
102 #      junks             : Junk items like Shard of Pottery or etc. match.
103 #      spellbooks        : All books match.
104 #      hafted weapons    : Hafted weapons match. For priests.
105 #
106 #      You may also use keywords which match specified kinds of equipment:
107 #      weapons, armors, missiles, magical devices, lights, junks, spellbooks, 
108 #      hafted weapons, shields, bows, rings, amulets, suits, cloaks, helms, 
109 #      gloves, boots
110 #
111 #
112 #    Character strings:
113 #           After the keywords, you may write a character string. Only items 
114 #      whose name contains this character string as part of their name match. 
115 #      Upper or lower case makes no difference.
116 #           You must insert a ':' between your special keywords and character 
117 #      string, if both exist in one line.
118 #
119 #    Force start-of-line matching:
120 #      If the first character in a character string is '^', then the 
121 #      character string must match the beginning of a line.
122 #
123 #    !Mace           // Destroy Maces and Lead-Filled Maces.
124 #    !^Mace          // Destroy only Maces.
125 #
126 #
127 #    Examples:
128 #
129 #    !worthless items
130 #    Meaning:  "destroy all items that are worthless"
131 #
132 #    unaware potion
133 #    Meaning:  "pick up all unaware potions"
134 #
135 #    ~unidentified lites
136 #    Meaning:  "leave all unidentified light sources on the ground"
137 #
138 #    unidentified more than 25 dice weapons
139 #    Meaning:  "pick up all weapons with dice that total more than 25.  A 
140 #         weapon that is 2d13 qualifies, a weapon that is 5d5 does not."
141 #
142 #    Acquirement
143 #    Meaning:  "pick up anything that includes in its name the word 
144 #    'Acquirement'"
145 #
146 #    potion of Experience
147 #    Meaning:  "pick up anything named 'potion of experience'"
148 #
149 #    Lights:stone
150 #    Meaning:  "Pick up light sources named stone"
151 #
152 #    gloves:slaying
153 #    Meaning:  "Pick up gauntlets of slaying. Not rings of slaying."
154 #
155 #
156 #    Special Notes:
157 #    
158 #      Lines will be evaluated in order, and first matched line will be 
159 #      applied. So you can write names of specific excellent items to pick 
160 #      up, followed by a general item name with '!' to destroy useless items.
161 #    
162 #      ! Tips
163 #      !     In full map command ('M'), you can press M, N, K, or D to 
164 #      ! display locations of items for auto-pickup, leaving, auto-destroy 
165 #      ! or both auto-pickup and leaving.
166 #      !     Additional command letter '(' prevents this display.
167 #      !
168 #
169 #      If you begin the last string in a line with '#', this string will
170 #      be automatically inscribed on the item.
171 #
172 #
173 #      Strict syntax of each line is below.
174 #      
175 #      [! ~ ; (]
176 #      [[all] [collecting]
177 #       [unaware] [unidentified] [identified] [*identified*] 
178 #       [dice boosted] [more than N dice] [more bonus than N] 
179 #       [worthless] [artifact] [ego] [nameless] 
180 #       [wanted] [unique monster's] [human] [unreadable] 
181 #       [first realm's] [second realm's] [first] [second] [third] [fourth] 
182 #       [items | weapons | armors | missiles | magical devices | 
183 #        lights | junks | spellbooks | hafted weapons | shields | bows | 
184 #        rings | amulets | suits | cloaks | helms | gloves | boots] :]
185 #      [[^]part-of-item-name] [#auto-inscription-string]
186 #    
187 #    
188 #    =======  How to use Conditional Expressions  ========
189 #    
190 #      The lines of pickpref.prf can be disabled/enabled using 
191 #      conditional expressions. 
192 #      The syntax is the same as that of other preference files.
193 #    
194 #      - usage of condition expressions
195 #        ?:expr
196 #          If result of expr is "0", all lines below are disabled.
197 #          If result of expr is "1", all lines below are enabled.
198 #          Caution:It cannot be nested.
199 #    
200 #      - usage to include other file
201 #        %:filename
202 #          Read a file named 'filename' as a new pick-pref file. The file 
203 #          must be in the user directory.
204 #    
205 #      - usage of operators
206 #        [EQU arg1 arg2 ...]
207 #          If all args are same, returns "1", or else returns "0".
208 #        [IOR arg1 arg2 ...]
209 #        [AND arg1 arg2 ...]
210 #          IOR evaluates and returns all args' logical OR. AND is logical AND.
211 #        [NOT arg]
212 #          Returns "0" if arg is "1", or else returns "1"
213 #        [LEQ arg1 arg2 ...]
214 #        [GEQ arg1 arg2 ...]
215 #          Compare args as string. LEQ returns "1" if (arg1 <= arg2 <= ...) ,
216 #          GEQ returns "1" if (arg1 >= arg2 >= ...) otherwise returns "0".
217 #    
218 #      - Special variables
219 #        $RACE
220 #         Returns name of player race. One of below:
221 #          Human, Half-Elf, Elf, Hobbit, Gnome, Dwarf, Half-Orc,
222 #          Half-Troll, Amberite, High-Elf, Barbarian, Half-Ogre,
223 #          Half-Giant, Half-Titan, Cyclops, Yeek, Klackon, Kobold,
224 #          Nibelung, Dark-Elf, Draconian, Mindflayer, Imp, Golem,
225 #          Skeleton, Zombie, Vampire, Spectre, Sprite, Beastman, Ent,
226 #          Archon, Balrog, Dunadan, Shadow-Fairy, Kutar, Android,
227 #
228 #        $CLASS
229 #         Returns name of player class. One of below:
230 #          Warrior, Mage, Priest, Rogue, Ranger, Paladin,
231 #          Warrior-Mage, Chaos-Warrior, Monk, Mindcrafter, High-Mage,
232 #          Tourist, Imitator, BeastMaster, Sorcerer, Archer,
233 #          Magic-Eater, Bard, Red-Mage, Samurai, ForceTrainer,
234 #          Blue-Mage, Cavalry, Berserker, Weaponsmith, Mirror-Master,
235 #          Ninja
236 #
237 #        $PLAYER
238 #         Returns player name.
239 #        $REALM1
240 #         Returns player's first magic realm
241 #          none, Life, Sorcery, Nature, Chaos, Death, Trump, Arcane,
242 #          Craft, Daemon, Crusade, Music, Kendo
243 #        $REALM2
244 #         Returns player's second magic realm
245 #        $LEVEL
246 #         Returns player level as two-character string.
247 #          Ex. "01","09","10","50" etc.
248 #
249 #------------------------------------------------------------------
250 #
251 #    Below is an example 'pickpref.prf' file.
252 #    You can copy this file to lib\user\ or ~/.angband/Hengband/.
253 #    (UNIX user must copy to ~/.angband/Hengband/. Others must copy 
254 #    to  lib\user\ .)
255 #
256 #------------------------------------------------------------------
257
258 wanted corpse
259 wanted Skeleton
260
261 # Berserker cannot use magical devices; rods, wands, and scrolls.
262 ?:[EQU $CLASS Berserker]
263 !magical devices
264 ?:1
265
266 unaware items
267
268 #Artifact lights
269 unidentified lights:^Jewel#!!
270 unidentified lights:^levitation stone#!!
271 unidentified lights:^Palantir#!!
272 unidentified lights:^stone#@A0
273 unidentified lights:^star#!!
274 unidentified lights:^Incandescent Light
275 unidentified lights:^Phial#!!
276
277 # auto inscribe resistances (see lib/help/objects.txt#Inscriptions)
278 ~*identified* artifacts#%all
279
280 #
281 # pick all items which can stack your inventory without inscription.
282 #
283 collecting rod
284 collecting potion
285 collecting scroll
286 collecting missiles
287 (collecting items
288
289 #
290 # good items
291 #
292 ~rod of Perception#@z0!k!!
293 ~rod of speed#!k!!
294 ~rod of Healing#!k!!
295 ~rod of Enlightenment#k!!
296 ~rod of Detection#!k!!
297
298 potion of Invulnerability#!k
299 Acquirement#!k
300 potion of Experience
301 potion of Augmentation
302 *Destruction*
303 Genocide
304
305 potion of strength
306 potion of wisdom
307 potion of dexterity
308 potion of constitution
309 potion of intelligence
310 potion of Charisma
311
312 potion of life#!k
313 healing#!k
314
315 #
316 # Magic-Eaters pick up all magical device to absorb.
317 # Skeletons is material of missiles for Archers.
318 # Ninja needs lights of darkness.
319 # Vampire needs darkness.
320
321 ?:[EQU $CLASS Magic-Eater]
322 rod of 
323 staff of 
324 wand of 
325 ?:[EQU $CLASS Archer]
326 worthless skeleton
327 ?:[EQU $CLASS Ninja]
328 ~lights:darkness
329 Iron Spike#@v0
330 ?:[EQU $RACE Vampire]
331 (~scroll of darkness
332 (~staff of darkness
333 ?:1
334
335 # Destroy unless very early stage.
336 ?:[GEQ $LEVEL 10]
337 (!amulet of Adornment
338 (!potion of Apple Juice
339 (!Empty Bottle
340 (!potion of water
341 ?:1
342
343 # These worthless potions have some use at very early stage.
344 # Command letter '(' means, 'Don't display its location in full map command.'
345 ?:[LEQ $LEVEL 20]
346 (~potion of booze
347 (~potion of Slowness
348 (~potion of Sleep
349 ?:1
350
351 # complex example; destroy needless food items.
352 ?:[AND [GEQ $LEVEL 20] [IOR [EQU $REALM1 Life] [EQU $REALM2 Life] [EQU $REALM1 Nature] [EQU $REALM2 Nature] [EQU $REALM1 Craft] [EQU $REALM2 Craft]]]
353 (!Satisfy Hunger
354 (!food
355 (!Slime Mold
356 (!of Elvish Waybread
357 ?:1
358
359
360 #
361 # Destroy useless equipment at high level.
362 #
363 # Beware!!!!
364 #    The line '!nameless armors' destroy all dragon armour!
365 #    '~identified armors:dragon' will prevent this dangerous behavior.
366 #
367
368 ?:[GEQ $LEVEL 40]
369 ~identified armors:dragon
370 ~nameless armors:Elven Cloak
371 ~nameless armors:Shadow Cloak
372 ~nameless weapons:Diamond Edge
373 ~nameless weapons:Mace of Disruption
374 ~nameless weapons:Shield of Deflection
375 !nameless weapons
376 !nameless armors
377
378 ?:[GEQ $LEVEL 20]
379 !nameless weapons:) (+0,+0)
380 !nameless armors:,+0]
381 ?:1
382
383 # higher rank of your spellbooks
384 first realm's fourth Book of Kendo#!k
385 first realm's third Book of Kendo#!k
386 first realm's fourth spellbooks#@md!k
387 first realm's third spellbooks#@mc!k
388 second realm's fourth spellbooks#@mh!k
389 second realm's third spellbooks#@mg!k
390
391 # unidentified equipment
392 unidentified dice boosted weapons
393 unidentified more than 25 dice weapons
394 unidentified weapons
395 unidentified armors
396 ~unidentified missiles
397
398 # lower rank of your spellbooks
399 collecting spellbooks
400 ~first realm's second spellbooks#@mb!k
401 ~first realm's first spellbooks#@ma!k
402 ~second realm's second spellbooks#@mf!k
403 ~second realm's first spellbooks#@me!k
404
405 # other spellbooks
406
407 ?:[GEQ $LEVEL 30]
408 (!unreadable first spellbooks
409 (!unreadable second spellbooks
410 (!unreadable third spellbooks:arcane
411 (!unreadable fourth spellbooks:arcane
412 ?:1
413
414 # pick up for experience
415 ?:[IOR [EQU $CLASS Warrior] [EQU $CLASS Berserker] [AND [EQU $CLASS Paladin] [EQU $REALM1 Life]]]
416 (~unreadable third spellbooks:arcane
417 (~unreadable fourth spellbooks:arcane
418 unreadable fourth spellbooks
419 unreadable third spellbooks
420 ?:1
421 ?:[AND [EQU $CLASS Paladin] [EQU $REALM1 Death]]
422 unreadable fourth spellbooks:life
423 unreadable third spellbooks:life
424 ?:1
425
426 # pick up for money
427 ?:[LEQ $LEVEL 29]
428 (~unreadable third spellbooks:arcane
429 (~unreadable fourth spellbooks:arcane
430 unreadable fourth spellbooks
431 unreadable third spellbooks
432 ?:1
433