lib/help/editor.txt

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