{{RTOC}}

This page documents the collection of scripts that are available from an external repository located at [https://github.com/rpherbig/dr-scripts https://github.com/rpherbig/dr-scripts], and not through the in-game <code>;repository</code> functionality.

For script-specific documentation, see the appropriate section, below. For YAML documentation, see [https://github.com/rpherbig/dr-scripts/wiki/Introduction-to-Character-Settings Introduction-to-Character-Settings].

Also there is a newbie-friendly video guide - '''How to setup Lich: https://www.youtube.com/watch?v=Ty-seLTJSi4'''

If you have some feedback or suggestions, please contact us in-game (Sheltim or Etreu) or [https://github.com/rpherbig/dr-scripts/issues open an issue on GitHub]. We look forward to hearing from you!

= Introduction to Character Settings =
Character settings are read from a YAML file.

== What is YAML? ==
YAML is a human friendly file format that we use to store settings. It stands for YAML Ain't Markup Language (the name references itself as a kind of computer science joke). It's got a website and everything (http://yaml.org/), but there are only a few things you actually need to know:

Indentation matters. Use two spaces for each level of indentation.

If you see a line like <code>train_with_spells: true</code>, that means that the <code>train_with_spells</code> setting is being assigned a value of <code>true</code>. This may also be referred to as a hash in which <code>train_with_spells</code> is mapped to <code>true</code>. Values can be true/false, numbers, text, hashes, or lists (see below).

A list (or array) is a series of values. For example, this creates a list named <code>loot_additions</code> of item nouns that you want to loot:
<pre>
loot_additions:
- card
- dira
- bolt
- arrow
- stone
</pre>

A comment is any line that starts with a <code>#</code>. They are ignored when our scripts read your settings file. Comments are entirely for your own benefit (e.g. to leave yourself a note).

Don't worry, it'll make more sense if you go look at a YAML file. Try taking a look at [https://github.com/rpherbig/dr-scripts/tree/master/profiles some of these.]

== Loading YAML Files ==
YAML files are loaded in a predefined order. <code>base.yaml</code> is loaded first, then <code>YourCharacterName-setup.yaml</code>. If any arguments are given to a script (for example, <code>;combat-trainer BacktrainWeapons</code>), then <code>YourCharacterName-BacktrainWeapons.yaml</code> will be loaded last.

If the same setting occurs in multiple YAML files, then the last version of that setting is used. For example, you could define <code>dance_threshold</code> to be 1 in <code>YourCharacterName-setup.yaml</code> and then redefine it to be 0 in <code>YourCharacterName-BacktrainWeapons.yaml</code>.

<code>base.yaml</code> provides defaults for many (but not all) of the settings. You should never modify <code>base.yaml</code> directly; instead override settings in <code>YourCharacterName-setup.yaml</code> or <code>YourCharacterName-SomethingElse.yaml</code>. If you think something should be changed in <code>base.yaml</code>, please contact us in-game or open a [https://github.com/rpherbig/dr-scripts/pulls pull request]. We welcome all feedback and suggestions.

== Debugging YAML files ==
Its helpful to use a YAML parser for diagnosing issues.
http://yaml-online-parser.appspot.com/

= Autostart =
There are '''two''' autostart scripts.

<code>;autostart</code> is part of '''lich'''.

<code>;e autostart</code> is part of '''dependency''', a lich script, which manages the start up process for scripts documented here.

Use ''dependency'' autostart (the second one) for any script on this page. This means you should use <code>;e autostart 'scriptname'</code> or <code>;e autostart('scriptname')</code> instead of <code>;autostart add scriptname</code>

If any of the scripts on this page are in <code>;autostart list</code>, you should remove them. Try the command <code>;autostart help</code> if you need help.

== Add an autostart ==
<pre>
;e autostart('script-name') will start the script called 'script-name' for all of your characters
;e autostart 'script-name'
;e autostart('script-name', false) will start the script for only this character
;e autostart 'script-name', false
</pre>
Parenthesis do not matter
== List autostart scripts ==
<pre>
;e echo(list_autostarts) will show you the files being autostarted on a given character
;e echo list_autostarts
</pre>

== Remove an autostart ==
<pre>
;e stop_autostart('script-name') will remove an autostarted file from the list
;e stop_autostart 'script-name' parenthesis do not matter
</pre>

= Scripts =
== accept-sell ==
{{Lich script
|description=Accepts an outstanding trade offer for a pouch/bundle, appraises it and sells it. Returning coins, item, and a profit report to the owner.
|usage= Call the script when you have empty hands and an outstanding trade offer.
|args={{Lich setting|name=skip|desc=Don't appraise and send profit summary to seller, faster for multiple pouches/bundles.}}^{{Lich setting|name=buy|desc=Pay for the pouch out of your own money and keep it.}}^{{Lich setting|name=dump|desc=Dump item after sale.}}
|settings=
|uservars=
|children=
}}

== addroom ==
{{Lich script
|description=Add a series of rooms to the lich map. This script will checkout the mapdb, add the new rooms, and commit the mapdb. Automap is preferred to this script.
|usage=
To use this script send it an ordered set of directions to map. If you don't provide a direction no mapping will be provided.

For example, to add a Y branch to the north:

<code>;addroom "north, northeast, southwest, northwest, southeast, south"</code>

To add a store:

<code>;addroom "go shop, out"</code>

The travel delay defaults to 0.2.
|args={{Lich setting|name=debug|desc=Turns on debugging messages.}}
|settings=
|uservars={{Lich setting|name=add_room_debug|desc=Turns on debugging messages.}}
|children=
}}

== afk ==
{{Lich script
|description=Runs in the background to provide safety while you are afk. Basic keep alive script with simple health/spirit/death monitoring. Will exit on low health, low spirit, or death.
|usage=
|args=
|settings={{Lich setting|name=health_threshold|desc=Threshold at which you will exit (the same threshold is used for health and spirit)}}
|uservars=
|children=
}}

== almanac ==
{{Lich script
|description=Uses an almanac every 10 minutes. Pauses all other scripts, stows your left hand, studies it, then unpauses everything.
|usage=
|args=
|settings=
|uservars=
|children=
}}

== appraisal ==
{{Lich script
|description=Trains the Appraisal skill by appraising your gear, zills, bundles, gem pouches, and studying the art in the Crossing art gallery. Use the <code>appraisal_training</code> setting to specify a training regimen.
|usage=Define the <code>appraisal_training</code> list in your settings file. It will train in the order listed.
* Example Settings
<pre>appraisal_training:
- gear
- zills
- art
- bundle
- pouches
full_pouch_container: backpack
</pre>
<ul>
<li>The <code>gear</code> setting appraises everything listed in <code>gear</code> (where your armor and weapons are listed).
<li>The <code>zills</code> setting appraises zills up to 250 appraisal ranks; after that you will get a warning to remove zills from your training list.
<li>The <code>art</code> setting runs the study-art script which appraises art in the Crossing art gallery.
<li>The <code>bundle</code> setting appraises a worn bundle quick.
<li>The <code>pouches</code> setting appraises gem pouches stored in the container you list as <code>full_pouch_container</code>. Up to eleven gem pouches can be appraised. This has been updated to also appraise your worn gem pouch if <code>gem_pouch_adjective</code> is defined, making the total pouches appraised twelve.
</ul>
|args=
|settings={{Lich setting|name=appraisal_training|desc=List of training options. Valid options are <code>zills</code>, <code>pouches</code>, <code>bundle</code>, <code>gear</code>, and <code>art</code>}}^{{Lich setting|name=full_gem_pouch_container|desc=The container where you store gem pouches for appraisal. This should not be the same container where you store empty ones}}
|uservars=
|children=study-art
}}

== arrows ==
{{Lich script
|description=Creates shaft, arrowheads, and arrows all in one script.
Syntax: ;arrows type lumber tools

* Examples:
;arrows drake-fang maple
;arrows drake-fang balsa yes

|args=type, lumber, tools
|settings={{Lich setting|name=type|desc=The type of arrow you would like to make. The list is
<pre>
couger-claw
boar-tusk
sabertooth
angiswaerd
hele'la
basilisk
elsralael
soot-stained
ice-adder
jagged-horn
drake-fang
</pre>
}}^{{Lich setting|name=lumber|desc=The type of lumber you would like to use. Maple is the default lumber. You can use all the lumber types at the Society store. You can also use your own as long as you have the lumber on you.}}^{{Lich setting|name=tools|desc=This setting is storing your tools at the Society. This setting is optional.}}
|uservars={{Lich setting|name=None|desc= }}
|children=go2, shape

}}

== astrology ==
{{Lich script
|description=Trains astrology via by observing a known constellation which fills the most prediction pools and performing predictions aligned to those pools. If your character is above 99th circle the script can also walk the ways to train astrology. Walking is limited to one round-trip per hour.
|usage=Start in any room where the heavens are observable or where moongate can be cast (if astral traveling).
* Example Settings:
<pre>
astrology_training:
- ways
- observe
- rtr
- weather
- events
- moons
astral_plane_training:
train_destination: crossing
train_source: shard

have_telescope: true
#Choose one, container or tie
telescope_storage:
container:
tie:

#Choose one, container, tied, or worn
divination_tool:
name:
container:
tied:
worn:

#Choose one, container or tied
divination_bones_storage:
container:
tied:

NOTE: DO NOT INCLUDE THE STUFF UNDER divination_tool or divination_bones_storage IF NOT USING!!

EXAMPLE YAML IF NOT USING:
divination_tool:
divination_bones_storage:

</pre>
|args=
|settings={{Lich setting|name=astrology_training|desc=A list of training options. The possible options are ways, observe, rtr, weather, events, and moons. Things will be trained in the order they are listed}}^{{Lich setting|name=have_telescope|desc=Set to true to indicate you have a telescope on you and it will be used to observe the heavens.}}^{{Lich setting|name=astral_plane_training|desc=Hash which contains the settings for astral training.}}^{{Lich setting|name=train_destination|desc=indicate the shard destination in lowercase(this is a town, not the shard name). This is where you will walk to for training. Options are: shard, crossing, leth, riverhaven, merkresh, fang, raven, throne, muspari, aesry, taisgath, theren, steppes}}^{{Lich setting|name=train_source|desc=indicates the shard you wish to return to after arriving at the destination shard, options are the same as in <code>train_destination</code>.}}
|uservars={{Lich setting|name=astral_plane_exp_timer|desc=This is set to the current time on your computer once you emerge from the shard indicated in <code>train_destination</code>. It's used to check how long its been since you last walked.}}
|children=bescort
}}

== athletics ==
{{Lich script
|description=Athletics training script
|args={{Lich setting|name=wyvern|desc=Climb wyverns instead of undergondola.}}^{{Lich setting|name=undergondola|desc=Climb undergondola.}}^{{Lich setting|name=xalas|desc=Climb in xalas}}
|settings={{Lich setting|name=have_climbing_rope|desc=Set this to true to use a magic climbing rope for training. This currently requires zills.}}^{{Lich setting|name=held_athletics_items|desc=A list of 1-2 items held while doing athletics to increase the difficulty. Each item adds difficulty. Uses get/stow, and the items don't need to be weapons.}}
}}

== attunement ==
{{Lich script
|description=Trains attunement via power walking or in perceiving in a single room. Power walking rooms are based on your hometown setting unless the <code>attunement_rooms</code> setting is filled out. Moon mages will not powerwalk, but use perceive mana instead. This script will cast spells listed in the <code>waggle_set</code> called 'attunement' when it starts.
|settings={{Lich setting|name=attunement_rooms|desc=A list of room id's to use for power walking. This is useful for power walking near your safe room, in non-justice areas (necromancers), or if your <code>hometown</code> does not have power walking room data.}}^{{Lich setting|name=crossing_training_stationary_skills_only|desc=Set to true to only train attunement in your current room. This setting does nothing for moon mages.}}^{{Lich setting|name=hometown|desc=Town to train attunement in; most towns have a pre-defined list of rooms to power walk in. Using <code>attunement_rooms</code> overrides this.}}^{{Lich setting|name=attunement_target_increment|desc=The desired number of mind states to increase by. Respects crossing_training_max_threshold as an upper threshold.}}
}}

== autocontingency ==
{{Lich script
|description=Moon Mages only. It can be run two different ways. First, by providing two arguments for a contingency target (anchor), and the room number that anchor will be in. Your character will run to the room in question, and cast both SEER and Contingency on the anchor. i.e. <code>autocontingency Eteu 798</code>. Contingency established, you can then go about your business.

The other method is <code>autocontingency invoke</code>. When run in this manner, typically after a hunt or a long athletics trip to the far side of Elanthia, the script will invoke the Contingency to bring you back to your point of origin.
|usage= Ensure that a waggle titled `contingency` is present in your YAML. Example below:
contingency:
Seer's Sense:
abbrev: SEER
recast: 2
mana: 15
cambrinth:
- 5
- 5
Contingency:
abbrev: CONTINGENCY
recast: 1
mana: 15
cambrinth:
- 7
- 7

The waggle does not have to include both spell entries, but SEER should only not be included if you are casting that by hand (or in another script) on your anchor target before the Contingency cast. Best practice, include both.

Example YAML usage for including autocontingency as a <code>before</code> in a hunt:
hunting_info:
- :zone:
- rats
- rats
- rats
:duration: 30
args:
- d0
- combat
before:
- go2 798
- autocontingency Etreu
after:
- autocontingency invoke
stop_on:
- Large Blunt
- Large Edged
- Small Edged
- Staves

Example YAML usage for including autocontingency as part of T2's <code>training_list</code>:
training_list:
- skill:
- Targeted Magic
start: 4
scripts:
- autocontingency Etreu 798
- buff main
- hunting-buddy
- autocontingency invoke
- safe-room
}}

== automap ==
{{Lich script
|description=Mapping assistance script
|usage=Start from an already mapped room. Records the commands you type to move around and maps new rooms as it encounters them. Will update existing paths if traveling through previously mapped areas. Run the script to start recording, then kill it when finished. Do not use your typeahead lines when this is running or you will damage the map.
|args=
|settings=
|uservars=
|children=
}}

== avtalia ==
{{Lich script
|description=Traders only. When run, it watches cambrinth defined in avtalia_array:. It maintains a running list of how much mana is in those cambrinth and allows it to be pulled by scripts like combat-trainer when mana is low.
|usage= Define a list of cambrinth as below:
avtalia_array:
- name: cambrinth bracer
cap: 32
- name: watersilk bag
cap: 108
- name: cambrinth anklet
cap: 12
- name: tattered robe
cap: 50
- name: cambrinth chains
cap: 50

Each entry must be unique, all cambrinth must be worn, you must have sufficient Arcana to charge and invoke accurately while worn, and you must not use your primary casting cambrinth you use for other spells.
|args=
|settings=avtalia_array: defines the array of worn cambrinth.
|uservars=avtalia
|children=
}}

== bankbot ==
{{Lich script
|description=Have a character act as a banker
}}

== bescort ==
{{Lich script
|description=A script for navigating certain problematic areas like swamp mazes, the wilds, and some river swims. Mostly used by other scripts. Can also be used for astral traveling.
|usage= Start this script with no arguments to see a list of supported areas and destinations.
|args=
|settings=
|uservars= ''citizenship'': Set citizenship to 'Zoluren' to skip a money check. Set to 'Ilithi' to use the north, west, south gates of Shard
|children=
}}

== buff ==
{{Lich script
|description=Casts waggle sets defined in your yaml. Casts the default: waggle set if no args are given.
|usage=
|args=
|settings=
|uservars=
|children=
}}

https://github.com/rpherbig/dr-scripts/wiki/Waggle-Sets

== burgle ==
{{Lich script
|description=[[Breaking and Entering]] - Used to train Thievery, Stealth, and depending on entry method, 1 of Athletics (rope) / Locksmithing(lockpick). '''Extremely high fines if you are caught. Be sure to read the [[Breaking and Entering]] page to understand how the system works prior to using this script.'''
|usage=Script can be started anywhere that can path the room you set in the settings.
* Example Settings:
<pre>
# Turn on Burgle inside crossing_training. Attempts to use ;burgle during Athletics, Locksmithing, Thievery, or Stealth
# Uses burgle_settings for entry method then continues to alternate methods such as climbing, picking shop stealing, etc.
train_with_burgle: true

#Plead guilty for lower fines if caught in normal justice.
guilty_plea: guilty

burgle_settings:
room: nnn # pick your own room, you should pick a room that no guard will ''ever'' enter. Picking rooms guards can come to is a failure on setup, not the script.
entry_type: lockpick # lockpick | rope | cycle | prioritylockpick | priorityrope
max_priority_mindstate: 26 # only used if priority setting for entry_type is used. Sets max midstate value before switchover to other entry_method. Default: 26
use_lockpick_ring: true # if you use a worn lockpick stacker
lockpick_container: lockpick ring # name of your lockpick stacker
max_search_count: 2 # max number of total searches to do including retries
retry: false # retry if you don't find loot. default: false
loot: keep # drop | keep | bin | pawn default: keep
loot_container: duffel bag # container to keep loot in while burglering
safe_mode: true # stop searching and try to get out as quickly as possible when hearing footsteps. Default: true
room_blacklist: # array of rooms to ignore. Case sensitive.
item_whitelist: # array of full item names (adj + noun) of items to keep no matter what. Case Sensitive.
item_whitelist: # array of **full item names** (adj + noun) of items to keep no matter what. Case Sensitive. Default: empty list
- blunt-tipped arrows # armory - non-lodging ammo
- blunt-tipped bolts # armory - non-lodging ammo
- blunt stones # armory - non-lodging ammo
- keepsake box # bedroom - limited use (35) locksmithing trainer
# - mixing bowl # kitchen - alchemy tool: 12/12 MC. 11/18 durability, 5/11 speed
# - mixing stick # kitchen - alchemy tool: 12/12 MC. 11/18 durability, 5/11 speed
# - rustic mortar # kitchen - alchemy tool: 12/12 MC. 11/18 durability, 5/11 speed
# - rustic pestle # kitchen - alchemy tool: 12/12 MC. 11/18 durability, 5/11 speed
# - mesh sieve # kitchen - alchemy tool: 12/12 MC. 11/18 durability, 5/11 speed
# - butcher's knife # kitchen - wrist worn 'belt' knife
- worn book # library - scroll stacker (15 page, 10 copies per page)
# - contract case # library - Trader Jewelry
# - dainty cowbell # library - wrist worn weatherproof instrument
# - writing quill # library - writing instrument (ledgers, etc)
# - thumb ring # library - Trader Jewelry
# - glass lens # sanctum - minion identifier
# - letter opener # sanctum - belt worn belt knife
- memory orb # sanctum - random skill absorber
# - crystal prism # sanctum - divination tool
# - celestial charts # sanctum - divination tool
# - tool case # work room - belt worn lockspick stacker - 25 ct
# - stirring rod # work room - forging tool: 12/12 MC. 11/18 durability, 5/11 speed
# - carving knife # work room - shaping tool: 12/12 MC. 11/18 durability, 5/11 speed
# - wood shaper # work room - shaping tool: 12/12 MC. 11/18 durability, 5/11 speed
# - metal rasp # work room - shaping/carving tool: 12/12 MC. 11/18 durability, 5/11 speed
# - imbuement rod # work room - enchanting tool
# - !ruby/regexp '/\S+ fabric/' # Bedroom - illustrates REGEX syntax for items
before: # array of scripts to run, similar to hunting-buddy, before the burgle (will be called right before buffing)
- yourscripthere with args here
after: # array of scripts to run, similar to hunting-buddy, after the burgle, (will be called right before script ends)
- anotherscript here
waggle_sets:
burgle:
- Plunder
- Slight
- Sight
- Silence
</pre>
|args={{Lich setting|name=start|desc=Required to run the script. Protects against accidental starting/typos.}}^{{Lich setting|name=entry|desc=Optional. Override yaml setting for entry_type. Valid options are: lockpick, rope, cycle, prioritylockpick, priorityrope.}}^{{Lich setting|name=roomid|desc=Optional. Override yaml setting for room to burgle from.}}^{{Lich setting|name=loot_type|desc=Optional. Override yaml setting what to do with loot. Items in your item_whitelist are always kept. Valid options: drop, keep, pawn bin.}}^{{Lich setting|name=hometown|desc=Optional. Override yaml hometown setting when using pawn or bin options.}}^{{Lich setting|name=follow|desc=Optional. Puts brugle into group follow mode. To be used when you've already joined someone to do a group burglary. This will buff, then hide if needed and then wait for the leader to burgle. Will attempt to leave the group if you are following once in, to prevent getting lost.}}
|settings={{Lich setting|name=burgle_settings|desc=Hash of all the burgle settings}}^{{Lich setting|name=burgle_settings:room|desc=The Room id that burgle should be done in. Guards should never come to this room, so pick carefully}}^{{Lich setting|name=burgle_settings:entry_type|desc=The type of entry - <code>rope</code> or <code>priorityrope</code> or <code>lockpick</code> or <code>prioritylockpick</code> or <code>cycle</code> You must have a heavy rope if using <code>rope</code> or <code>cycle</code>. You must have a lockpick, or a worn lockpick stacker with lockpicks on it if using <code>lockpick</code> or <code>cycle</code>. You must have both if you are using the <code>prioritylockpick</code> or <code>priorityrope</code> settings. the priority settings will use that entry method unless your mindstate is above the max value.}}^{{Lich setting|name=burgle_settings:max_priority_mindstate|desc=Tha maximum mindstate to use when using one of the priority entry settings, before switching to the other entry method.}}^{{Lich setting|name=burgle_settings:use_lockpick_ring|desc=<code>true</code> or <code>false</code>Check for a lockpick ring/stacker if using lockpick as entry_type. <code>true</code> or <code>false</code>}}^{{Lich setting|name=burgle_settings:lockpick_container|desc=The name of your lockpick ring/stacker.}}^{{Lich setting|name=burgle_settings:max_search_count|desc=Limits the number of searches you do. Setting this too high will result in arrest, and large fine. Start low and increase as needed.)}}^{{Lich setting|name=burgle_settings:retry|desc=Retry searches if you don't find loot. <code>true</code> or <code>false</code>}}^{{Lich setting|name=burgle_settings:loot|desc=What to do with loot. Supported options: <code>drop</code>, <code>keep</code>, <code>pawn</code>, <code>bin</code>. Note that you will always attempt to store loot while in the house, to avoid problems inside with items with custom drop scripts. <code>bin</code> is only supported for thieves.}}^{{Lich setting|name=burgle_settings:loot_container|desc=Where to put loot while in the house. This is required as the script will not attempt to drop loot in the house.}}^{{Lich setting|name=burgle_settings:safe_mode|desc=Stop searching and try to get out as quickly as possible when hearing footsteps. <code>true</code> or <code>false</code>}}^{{Lich setting|name=burgle_settings:room_blacklist|desc=List of room types (using Sentence Case) that you don't want to search for loot in.}}^{{Lich setting|name=burgle_settings:item_whitelist|desc=List of full item names (adj + noun) that you want to keep regardless of any other setting.}}^{{Lich setting|name=burgle_settings:before|desc=List of scripts you want to run before burglary. This is run right before the waggle set.}}^{{Lich setting|name=burgle_settings:after|desc=List of scripts you want to run after burglary. This is run right after the burglary before processing the loot.}}^{{Lich setting|name=waggle_sets['burgle']|desc=Optional. A waggle set called 'burgle' to cast right before burglary.}}
|children=jail-buddy
}}

== carve ==
{{Lich script
|description=
|usage=
|args=
|settings=
|uservars=
|children=
}}

== charge-holy-weapon ==
{{Lich script
|description= Charges holy weapon if below 200 estimated remaining uses. Usable in Crossing or Shard Chadatru temples, or in a player-specified room using a holy icon. There is a large cooldown, and if too low circle & charisma, this could be bad. Best used independently on lower circle Paladins.
|usage= Run it as a before or after within training manager, as a normal part of T2's system, or as an independent script.
|settings={{Lich setting|name=holy_weapon|desc=Main setting which holds the other settings.}}^{{Lich setting|name=holy_weapon:weapon_name|desc=Name of the holy weapon, MUST match gear setting entry exactly.}}^{{Lich setting|name=holy_weapon:icon_name|desc=Name of the icon to use for the ritual.}}^{{Lich setting|name=holy_weapon:icon_container|desc=Name of the container which holds the icon, optional.}}^{{Lich setting|name=holy_weapon:icon_room|desc=Room number to use for the icon ritual.}}
}}

== chop-wood ==
{{Lich script
|description= Chops trees in a room while watching for danger
|usage= Watches and chops out your current room, stowing or deeding anything in your tree list. Will run to a healer if injured.
|args=
|settings={{Lich setting|name=holy_weapon|desc=Holds all the holy weapon settings.}}^{{Lich setting|name=weapon_name|desc=name of holy weapon, MUST match weapon in gear, <adj> <noun>}}^{{Lich setting|name=icon_name|desc=Name of the icon to use}}^{{Lich setting|name=icon_container|desc=Container which holds the icon (optional)}}^{{Lich setting|name=icon_room|desc=Room to do the icon ritual.}}
}}

== circlecheck ==
{{Lich script
|description=Circle check tells you how far you are from your next or target circle.
|usage=
Display circle progress:
* <code>;circlecheck</code>

Display only skills needed for the next circle:
* <code>;circlecheck short</code>
* <code>;circlecheck brief</code>
* <code>;circlecheck next</code>

Display progress towards circle 35
* <code>;circlecheck 35</code>
|args={{Lich setting|name=debug|desc=Turns on debugging messages.}}^{{Lich setting|name=short|desc=Uses short output mode, aliases brief, next}}^{{Lich setting|name=target|desc=Display progress towards target circle.}}
|settings=
|uservars=
|children=
}}

== cleric-quests ==
{{Lich script
|description=Automatically does cleric quests you are eligible for. Currently does tamsine, eluned, eluned2, kertigen, hodiera, meraud, and glythtide commune quests if you are the right level.
|usage=
|args=
|settings=
|uservars=
|children=
}}

== coordinator ==
{{Lich script
|description=Training manager script
|usage=
|args=
|settings=
|uservars=
|children=
}}

== combat-trainer ==
{{Lich script
|description= Train combat skills in your current room.
|usage= Trains combat skills in your current room, maintains listed buffs, uses TM/debil as specified, trains certain non combat actions on timers. Skins, loots.
|args={{Lich setting|name=d#|desc=Dance threshold, keep N mobs alive to train defenses against, where dN is the provided argument.}}^{{Lich setting|name=r#|desc=Retreat threshold, stay at missile range when N mobs are present and use ranged combat options, where rN is the provided argument.}}^{{Lich setting|name=construct|desc=overrides empath non attack settings.}}^{{Lich setting|name=debug|desc=Enables debug mode.}}^{{Lich setting|name=custom|desc= Extra arguments will be used to load in extra yaml files. <code>;combat-trainer back</code> would load in <code>YourName-back.yaml</code>.}}
|settings={{Lich setting|name=aiming_trainables|desc=Lets you train weapons in the offhand while aiming crossbows, slings, and bows. The weapon must be usable in the offhand for attacking/throwing, swappables are supported. Large weapons require weapons prime, and other conditions need to be met, etc. It works in conjunction with the settings attack_overrides (hurl/invoke supported) and using_light_crossbow.}}^{{Lich setting|name=using_light_crossbow|desc=Lets you designate that your Crossbow is light, this enables swinging attack options with aiming_trainables.}}^{{Lich setting|name=storage_containers|desc=List of containers to make sure are open before starting hunting.}}^{{Lich setting|name=dance_threshold|desc=Same as d# argument.}}^{{Lich setting|name=retreat_threshold|desc=Same as r# argument.}}^{{Lich setting|name=dance_skill|desc=Weapon skill to have active when dancing with enemies, ideally allows parry. Note this is the SKILL not the weapon.}}^{{Lich setting|name=combat_trainer_action_count|desc=Number of attacks to make with a given weapon before cycling.}}^{{Lich setting|name=combat_trainer_target_increment|desc=Number of mind states of exp to get before cycling weapons.}}^{{Lich setting|name=weapon_training|desc=Hash of weapon skills to the weapon names that you use to train that skill. Brawling should map to an empty string. This controls what weapons are cycled through for training.}}^{{Lich setting|name=gear|desc=List of gear that will be used in this script. Armor and Weapons.}}^{{Lich setting|name=gear:name|desc=Noun of the item.}}^{{Lich setting|name=gear:is_leather|desc=true if this is repaired at the leather repair npcs.}}^{{Lich setting|name=gear:hinders_lockpicking|desc=true if should be removed for lockpicking.}}^{{Lich setting|name=gear:skip_repair|desc=true if you want to skip repairing this item.}}^{{Lich setting|name=gear:is_worn|desc=true if the item is worn such as armor, shields, wearable weapons.}}^{{Lich setting|name=gear:swappable|desc=true if this is a swappable weapon.}}^{{Lich setting|name=gear:tie_to|desc=This is the name of what this weapon is tied to, e.g toolstrap.}}^{{Lich setting|name=gear:adjective|desc=Used to differentiate items with the same name, if TAP ADJECTIVE NAME doesn't work then these settings are wrong.}}^{{Lich setting|name=gear:bound|desc=true if the item bonded for hurl/invoke.}}^{{Lich setting|name=gear_sets:standard|desc=A list of ADJ NAME for each item that should show up in INV COMBAT when you're ready for combat. If it shows up in inv combat it must be here. This gear set will be equipped at the start of combat.}}^{{Lich setting|name=summoned_weapons|desc=List of summoned weapons/moonblades.}}^{{Lich setting|name=summoned_weapons:name|desc=The skill to make a summoned weapon for.}}^{{Lich setting|name=summoned_weapons:turn|desc= true to turn the summoned weapon}}^{{Lich setting|name=summoned_weapons:pull|desc=true to pull the summoned weapon}}^{{Lich setting|name=summoned_weapons:push|desc=true to pull the summoned weapon.}}^{{Lich setting|name=summoned_weapons_element|desc=Element to summon your weapon as, defaults to stone.}}^{{Lich setting|name=summoned_weapons_ingot|desc=noun of ingot to use for rare metal summoning.}}^{{Lich setting|name=stances|desc=Used to override defense selection for a given weapon skill, normally used to prevent parrying with ranged weapons or offhand. See base.yaml for usage.}}^{{Lich setting|name=use_stealth_attacks|desc=true to attempt to hide before attacking to use ambush/poach while stealth skill is not mindlocked. This will also attempt to hide before casting Vivisection.}}^{{Lich setting|name=ambush|desc=true to use stealth attacks to train backstab. Should only use either ambush or backstab flags at one time}}^{{Lich setting|name=ambush_location|desc=Set the ambush target for better backstab training for thieves.}}^{{Lich setting|name=backstab|desc=Valid settings are 'Small Edged', 'Offhand Weapon' or both. This will attack with either backstab or backstab left for the chosen skill. Ensure you have a suitable weapon for backstabbing setup in your 'weapon_training:' section for the desired weapon skill(s). This defaults to ambush if the mob can't be backstabbed.}}^{{Lich setting|name=charged_maneuvers|desc=Hash of charged maneuvers to use for each weapon skill.}}^{{Lich setting|name=fatigue_regen_threshold|desc=Will use bob instead of an attack when fatigue drops below this.}}^{{Lich setting|name=aim_fillers|desc=list of actions to take to fill time while aiming.}}^{{Lich setting|name=aim_fillers_stealth|desc=Used in place of aim fillers if stealth experience is not capped.}}^{{Lich setting|name=dance_actions|desc=List of actions to take while dancing with enemies.}}^{{Lich setting|name=dance_actions_stealth|desc=Used in place of dance actions while stealth is not capped.}}^{{Lich setting|name=ignored_npcs|desc=List of npc names to ignore, used to keep combat from trying to count/interact with pets, familiars, and roaming npcs. This is the single noun that identifies them, bear, warrior, Brokk. Currently caps sensitive.}}^{{Lich setting|name=stance_override|desc=remove custom stance logic and simply set stance to provided string. E.g. 100 80 0}}^{{Lich setting|name=skinning|desc=Hash of skinning related settings.}}^{{Lich setting|name=skinning:skin|desc=true to skin kills.}}^{{Lich setting|name=skinning:arrange_all|desc=true if you can use the arrange ALL command.}}^{{Lich setting|name=skinning:arrange_count|desc=Number of times to arrange}}^{{Lich setting|name=skinning:arrange_types|desc=Hash of creature noun to the type of arranging to do, eg rat:part. All arranging defaults to skin.}}^{{Lich setting|name=skinning:tie_bundle|desc=true to tie your bundles up to reduce weight and item count.}}^{{Lich setting|name=lootables|desc=Base list of nouns to loot, the noun must be at the end of the object name and not part of another word. Changes to this are better made through loot_additions and loot_subtractions. Pearl would loot "a tiny yellow pearl" but not "a pearl studded coat" nor would rock cause you to loot "a large crock".}}^{{Lich setting|name=loot_additions|desc=List of nouns to add into the base loot list, a common example is box nouns.}}^{{Lich setting|name=loot_subtractions|desc=List of things to remove from your looting list, for example ammunition you don't use.}}^{{Lich setting|name=thanatology|desc=Necromancer related settings, only partially implemented.}}^{{Lich setting|name=thanatology:heal|desc=If true, use necromancer-specific healing rituals and spells.}}^{{Lich setting|name=thanatology:ritual_type|desc=Name of the ritual to perform, i.e dissect}}^{{Lich setting|name=spare_gem_pouch_container|desc=Container that holds your spare gem pouch should your equipped one become full.}}^{{Lich setting|name=gem_pouch_adjective|desc=Adjective your gem pouch responds too.}}^{{Lich setting|name=buff_spells|desc=Hash of buff spells to maintain on you while hunting, the key to the hash must match the spells name exactly e.g buff_spells:See the Wind. Will generally cast buffs in the order listed here.}}^{{Lich setting|name=buff_spells:Spell Name:abbrev|desc=Abbreviation to use for prepping the spell.}}^{{Lich setting|name=buff_spells:Spell Name:recast|desc=Remaining duration in minutes on a buff to trigger a recasting. -1 will wait until the spell falls off.}}^{{Lich setting|name=buff_spells:Spell Name:recast_every|desc=Number of seconds to wait between recasts of this spell, for spells that recast or expire messages don't make sense.}}^{{Lich setting|name=buff_spells:Spell Name:expire|desc=A string that when seen will trigger this spell to be recast}}^{{Lich setting|name=buff_spells:Spell Name:mana|desc=Amount of mana to prep the spell with.}}^{{Lich setting|name=buff_spells:Spell Name:cambrinth|desc=List of charges to put into cambrinth, will use worn cambrinth that can't be charged worn, however don't list more than two charges or strange things can happen.}}^{{Lich setting|name=buff_spells:Spell Name:prep_time|desc=Time in seconds to wait before trying to cast the spell, optional, if not present waits until full prep.}}^{{Lich setting|name=buff_spells:Spell Name:before|desc=A custom action to take immediately before casting the spell.}}^{{Lich setting|name=buff_spells:Spell Name:before:message|desc=The message to send to the game.}}^{{Lich setting|name=buff_spells:Spell Name:before:matches|desc=List of strings that are possible responses for the message.}}^{{Lich setting|name=buff_spells:Spell Name:after|desc=A custom action to take immediately after casting the spell.}}^{{Lich setting|name=buff_spells:Spell Name:after:message|desc=The message to send to the game.}}^{{Lich setting|name=buff_spells:Spell Name:after:matches|desc=List of strings that are possible responses for the message.}}^{{Lich setting|name=buff_spells:Spell Name:moon|desc=true if spell requires a moon to cast.}}^{{Lich setting|name=buff_nonspells|desc=Nonspell buffs. Each has the format "action: timer", where 'action' will be output to the game every 'timer' number seconds.}}^{{Lich setting|name=buff_nonspells:barb_buffs|desc=Specific subsection for barbarian buffs. These require no timer, instead they trigger off of expiration and activation messaging. List by buff name, i.e. "Python", capitalization required.}}^{{Lich setting|name=buff_nonspells:khri|desc=Specfic sub section for Thief Khri. These require no timer. List skill by name. Capitalization not required.}}^{{Lich setting|name=offensive_spells|desc=TM and Debil spells to use. Debil spells will be recast when a mob dies or the expiration message is seen.}}^{{Lich setting|name=offensive_spells:skill|desc=Targeted Magic or Debilitation.}}^{{Lich setting|name=offensive_spells:abbrev|desc=Abbreviation used for preparing the spell.}}^{{Lich setting|name=offensive_spells:recast_every|desc=Number of seconds to wait between recasts of this spell, for spells that recast or expire messages don't make sense.}}^{{Lich setting|name=offensive_spells:expire|desc=String that will trigger a recast of the spell when seen.}}^{{Lich setting|name=offensive_spells:mana|desc=Amount of mana to prep the spell with}}^{{Lich setting|name=offensive_spells:cambrinth|desc=List of charges to put into cambrinth, will use worn cambrinth that can't be charged worn, however don't list more than two charges or strange things can happen.}}^{{Lich setting|name=offensive_spells:prep_time|desc=Time in seconds to wait before trying to cast the spell, optional, if not present waits until full prep.}}^{{Lich setting|name=offensive_spells:before|desc=A custom action to take immediately before casting the spell.}}^{{Lich setting|name=offensive_spells:before:message|desc=The message to send to the game.}}^{{Lich setting|name=offensive_spells:before:matches|desc=List of strings that are possible responses for the message.}}^{{Lich setting|name=offensive_spells:after|desc=A custom action to take immediately after casting the spell.}}^{{Lich setting|name=offensive_spells:after:message|desc=The message to send to the game.}}^{{Lich setting|name=offensive_spells:after:matches|desc=List of strings that are possible responses for the message.}}^{{Lich setting|name=offensive_spells:tattoo_tm|desc=Will tell the system to target the invoked tattoo spell, if it's Targeted Magic.}}^{{Lich setting|name=cambrinth|desc=Cambrinth item to charge for casting.}}^{{Lich setting|name=cast_messages|desc=Casting messages, if we're missing your custom message let us know!}}^{{Lich setting|name=prep_messages|desc=Spell Prep messages, see cast_messages.}}^{{Lich setting|name=empath_healing|desc=a VH entry here will control the mana used when vit drops. List of values is prep followed by cambrinth charges.}}^{{Lich setting|name=osrel_amount|desc=Amount to infuse into OM each try.}}^{{Lich setting|name=osrel_no_harness|desc=true if you don't need to harness before infusing.}}^{{Lich setting|name=kneel_khri|desc=true if you have to kneel to activate khri.}}^{{Lich setting|name=khri_preps|desc=Khri activation messages, let us know if yours is missing.}}^{{Lich setting|name=manipulate_threshold|desc=Number of enemies before attempting to manipulate.}}^{{Lich setting|name=training_abilities|desc=Special one off trainers during combat. Hash is training type keyed to cooldown in seconds.}}^{{Lich setting|name=training_abilities:PercMana|desc=Moon mage attunement training, retreats first.}}^{{Lich setting|name=training_abilities:Perc|desc=Attunement training with perc.}}^{{Lich setting|name=training_abilities:Perc Health|desc=Empathy training with perc heal.}}^{{Lich setting|name=training_abilities:Astro|desc=Predict weather for astrology training.}}^{{Lich setting|name=training_abilities:App|desc=Train appraisal by appraising enemies. Requires Approx 100 ranks for learning.}}^{{Lich setting|name=training_abilities:App Quick|desc=See above.}}^{{Lich setting|name=training_abilities:App Careful|desc=See above.}}^{{Lich setting|name=training_abilities:Locks|desc=Train locksmithing by picking pet boxes in combat.}}^{{Lich setting|name=training_abilities:Tactics|desc=Train tactics with weave, bob, and circle.}}^{{Lich setting|name=training_abilities:Analyze|desc=Train tactics by analyzing your opponent.}}^{{Lich setting|name=training_abilities:Hunt|desc=Train perception and possibly scouting with the hunt command.}}^{{Lich setting|name=training_abilities:Pray|desc=Pray to an immortal for theurgy.}}^{{Lich setting|name=training_abilities:Meraud|desc=Maintains the Meraud Commune.}}^{{Lich setting|name=training_abilities:Scream|desc=Train bardic lore with scream conc.}}^{{Lich setting|name=training_abilities:Stealth|desc=Train stealth with hiding and stalking.}}^{{Lich setting|name=training_abilities:Ret Stealth|desc=Retreat before stealth with hiding and stalking.}}^{{Lich setting|name=training_abilities:Teach|desc=Teach hunting_buddies if there are any in the room on this timer.}}^{{Lich setting|name=training_abilities:Recall|desc=Uses 'recall' on a mob in the room, which trains Scholarship}}^{{Lich setting|name=training_abilities:Ambush Stun|desc=Uses settings stun_weapon, stun_weapon_skill and stun_skill}}^{{Lich setting|name=stun_weapon|desc=The weapon you want to use to Ambush Stun. IE club or broadsword}}^{{Lich setting|name=stun_weapon_skill|desc=The skill that stun_weapon trains or you would like to swap it to train IE Small Blunt or Large Edged}}^{{Lich setting|name=stun_skill|desc=Set to either Backstab or Debilitation for the skill to watch while using Ambush Stun}}^{{Lich setting|name=training_abilities:Khri Prowess|desc=Trains Debilitation with Khri Prowess.}}^{{Lich setting|name=fatigue_regen_action|desc=Action to take when low on fatigue.}}^{{Lich setting|name=dual_load|desc=true if you're capable of dual load}}^{{Lich setting|name=dedicated_camb_use|desc=Set to 'cyclic' or 'spell' with respect to the magical feat}}^{{Lich setting|name=cycle_armors|desc=List of armor types and corresponding items from gear to rotate for training purposes}}^{{Lich setting|name=whirlwind_trainables|desc=Barb specific section for telling the combat-trainer which weapon skills you want to train with whirlwind. It requires one-handed templates, doesn't support two handed weapons, and will use the weapon listed under weapon_training.}}^{{Lich setting|name=barb_famine_healing|desc=Barb specific section for automatic usage of Berserk Famine when low health. Has two settings listed below as well as knowledge of Berserk Famine as requirements.}}^{{Lich setting|name=barb_famine_healing:health_threshold:|desc=Famine will be used when below this threshold.}}^{{Lich setting|name=barb_famine_healing:inner_fire_threshold|desc=Will not use Berserk Famine unless above this threshold.}}^{{Lich setting|name=wield|desc=Set to true or false; If true, then it wields and sheaths your weapon. This is very useful if you have weapons in different containers. With this set to true on each weapon (e.g. :wield: true in your gear settings), it will return them back from where they came with the wield and sheath commands.}}^{{Lich setting|name=hide_type|desc=Value of "stalk" changes hide type to "slip stalk". This will perform the command "stalk" instead of "hide" which activates "slip stalk". "Slip stalk" is only available for a number of professions and must be learned. Default value: hide. Uses hide as normal.}}^{{Lich setting|name=force_unhide|desc=Value of true will always unhide after hiding via Stealth timer under training_abilities:.}}^{{Lich setting|name=dont_stalk|desc=Value of true prevents stalk usage after hiding when hiding via Stealth timer under training_abilities:. Default value is false.}}
|uservars={{Lich setting|name=combat_trainer_debug|desc=Turns on debugging messages.}}
|children=tendme
}}

== corn-maze ==
{{Lich script
|description=Runs the Hollow Eve corn maze.
|usage=Run inside the large-form corn maze, anywhere in the starting 'labyrinth' or entrance area. This does NOT work with the short/single-task versions. The script will finish any pre-existing corn-maze task, then search the maze for incidental loot. Make sure to allow ten minutes between runs for the loot to respawn.
|args={{Lich setting|name=noloot|desc=Run as normal, but only pick up free corn maze passes from the incidentals.}}^{{Lich setting|name=restart|desc=Run as normal, but skip incidental looting entirely. Useful if you already looted this run and needed to restart the script for some reason.}}^{{Lich setting|name=manual|desc=Replaces loot-corn-maze.lic. Control your run manually. Pick up and complete tasks on your own. This will sit in the background, and search and loot any incidental objects you come across automatically.}}^{{Lich setting|name=short|desc=Runs the fast 10-task challenge for the harried Halfling.}}
|settings={{Lich setting|name=maze_junk|desc=What to throw away during incidental looting. See defaults in base.yaml, and copy to your setup yaml to change them. }}^{{Lich setting|name=cornmaze_containers|desc=A list of bags to try and put incidental loot into, top ones first. If all of them are full it'll try and STOW the item, and if that fails it'll drop it. By default, no bags listed.

cornmaze_containers:
- backpack
- rucksack
- satchel
}}
}}

== craft ==
{{Lich script
|description=Crafts one item.
|args={{Lich setting|name=outfitting|desc=Knit.}}^{{Lich setting|name=forging|desc=Forge a Blacksmithing item.}}^{{Lich setting|name=engineering|desc=Shape one item.}}
|settings={{Lich setting|name=yarn_quantity|desc=How much yarn to keep on hand for knitting, defaults to 100.}}^{{Lich setting|name=craft_max_mindstate|desc=What mindstate to make running the script a noop. Defaults to 31}}
}}

== crossing-repair ==
{{Lich script
|description=Repair items in your gear list.
|usage=Originally intended to be used in [[RanikMap1|The Crossing]]. The script now works outside [[RanikMap1|The Crossing]] with hometown set to: [[RanikMap30|Riverhaven]], [[RanikMap42|Therenborough]], [[RanikMap67|Shard]], [[RanikMap99|Aesry]], [[RanikMap107|Mer'Kresh]], [[RanikMap117|Hibarnhvidar]], [[RanikMap121|Boar Clan]], [[RanikMap150|Fang Cove]], [[RanikMap47|Muspar'i]], [[RanikMap106|Hara'jaal]], [[RanikMap61|Leth Deriel]], [[RanikMap34a|Rossman's Landing]], [[RanikMap40|Langenfirth]], or [[RanikMap90|Ratha]]
|args=
|settings={{Lich setting|name=repair_withdrawal_amount|desc=Amount in coppers to withdraw to cover repairs.}}^{{Lich setting|name=gear|desc=List of gear that will be used in this script. Armor and Weapons.}}^{{Lich setting|name=gear:name|desc=Noun of the item.}}^{{Lich setting|name=gear:is_leather|desc=true if this is repaired at the leather repair npcs.}}^{{Lich setting|name=gear:hinders_lockpicking|desc=true if should be removed for lockpicking.}}^{{Lich setting|name=gear:is_worn|desc=true if the item is worn such as armor, shields, wearable weapons.}}^{{Lich setting|name=gear:swappable|desc=true if this is a swappable weapon.}}^{{Lich setting|name=gear:tie_to|desc=This is the name of what this weapon is tied to, e.g toolstrap.}}^{{Lich setting|name=gear:adjective|desc=Used to differentiate items with the same name, if TAP ADJECTIVE NAME doesn't work then these settings are wrong.}}^{{Lich setting|name=gear:bound|desc=true if the item bonded for hurl/invoke.}}
|uservars={{Lich setting|name=crossing_repair_debug|desc=Turns on debugging messages.}}
|children=
}}

== crossing-training ==
{{Lich script
|description=Trains non-combat skills. Despite the name, crossing-trainer this works in other towns using the hometown setting.
|usage= Cycles through skills training the lowest one in field experience at the time.

Skills that can be trained: Appraisal, Athletics, Astrology, Attunement, Augmentation, Warding, Utility, Debilitation, Empathy, Engineering, First Aid, Forging, Locksmithing, Mechanical Lore, Outdoorsmanship, Outfitting, Perception, Performance, Scholarship, Scouting, Sorcery, Stealth, Summoning, Theurgy, Thievery, Trading.

Additionally, the following skills can be trained only via research: Arcana, Life Magic, Holy Magic, Lunar Magic, Elemental Magic, Arcane Magic.
|args=
|settings={{Lich setting|name=train_with_burgle|desc=Set true to turn on burgle for locksmithing, thievery, stealth, and/or athletics. Needs burgle_settings:.}}^{{Lich setting|name=classes_to_teach|desc=List of subjects to teach people in your safe room}}^{{Lich setting|name=climbing_target|desc=Object to practice climbing on. Setting this causes you to climb practice during athletics training. Look in base-athletics for a list of climbing targets.}}^{{Lich setting|name=use_research|desc=Whether or not to use research when training magic skills. Requires train_with_spells to be true.}}^{{Lich setting|name=outdoor_room|desc=Used for spells requiring moons.}}^{{Lich setting|name=perform_options|desc=List in base-perform.yaml of playstyles sorted by difficulty.}}^{{Lich setting|name=storage_containers|desc=A list of containers to open before starting training.}}^{{Lich setting|name=crossing_training_requires_movement|desc=Skills which require movement as part of their training. This is used to avoid spamming the safe room with repeated entry/exit messages.}}^{{Lich setting|name=trash_nouns|desc=Nouns that can be thrown away without warning}}^{{Lich setting|name=crossing_training|desc=List of skills to train. Supported Skills - Appraisal (requires zills), Athletics, Arcana/Primary Magic(requires research enabled), Astrology, Attunement, Augmentation, Warding, Utilty, Debilitation(barb only?), Empathy, Engineering(workorders), First Aid (needs compendium), Forging (workorders or raw smithing), Locksmithing, Mechanical Lore, Outdoorsmanship, Outfitting(workorders or knitting), Perception, Performance(zills), Scholarship(blacksmithing book), Scouting(enough ranks for trails), Sorcery, Stealth (low ranks only), Summoning, Theurgy(see theurgy script), Thievery, Trading(workorders).}}^{{Lich setting|name=safe_room|desc=Room Id where you do any stationary training and listen for classes.}}^{{Lich setting|name=exit_on_skills_capped|desc=Whether or not to exit the game when all skills are locked}}^{{Lich setting|name=crossing_training_sorcery_room|desc=The room to use when training sorcery. MAKE SURE THIS ROOM IS LAWLESS by typing 'justice'.}}^{{Lich setting|name=crossing_training_sorcery|desc=Action to take when training sorcery}}^{{Lich setting|name=listen|desc=Whether or not you should attempt to listen to classes while training}}^{{Lich setting|name=train_with_spells|desc=}}^{{Lich setting|name=cyclic_training_spells|desc=Cyclic Spells to use when training.}}^{{Lich setting|name=cyclic_cycle_skills|desc=Skills to train with cyclic spells during crossing-training.}}^{{Lich setting|name=training_spells|desc=Spells to use when training magic skills. TODO: Make this its own page.}}^{{Lich setting|name=research_skills|desc=}}^{{Lich setting|name=exp_timers|desc=Cooldown timers between attempts to train a given skill}}^{{Lich setting|name=training_nonspells|desc=}}^{{Lich setting|name=kneel_khri|desc=}}^{{Lich setting|name=khri_preps|desc=If you use Khri for training, make sure their prep messages are recorded here}}^{{Lich setting|name=prep_scaling_factor|desc=This scaling factor is multiplied by your discerned max mana for a spell. The mana to be removed is rounded up, so anything < 1.0 will always result in at least one mana removed.}}^{{Lich setting|name=cambrinth_cap|desc=The maximum amount of mana your cambrinth can hold}}^{{Lich setting|name=osrel_amount|desc=}}^{{Lich setting|name=osrel_no_harness|desc=}}^{{Lich setting|name=held_cambrinth|desc=Whether or not you need to hold your cambrinth to charge it}}^{{Lich setting|name=stored_cambrinth |desc=Whether or not your cambrinth item is stored (false indicates worn)}}^{{Lich setting|name=cambrinth|desc=The noun for the cambrinth you use. Multiple cambrinth is not yet supported.}}^{{Lich setting|name=prep_messages|desc=If you cast spells for training, make sure their prep messages are recorded here}}^{{Lich setting|name=cambrinth_cap |desc=The maximum amount of mana your cambrinth can hold}}^{{Lich setting|name=forage_item|desc=}}^{{Lich setting|name=hand_armor|desc=Noun of any armor that needs to be removed when braiding}}^{{Lich setting|name=braid_item|desc=}}^{{Lich setting|name=athletics_options|desc=}}^{{Lich setting|name=trail_override|desc=}}^{{Lich setting|name=art_options|desc=}}^{{Lich setting|name=train_workorders|desc=Disciplines to train via workorders when training that skill}}^{{Lich setting|name=work_order_disciplines|desc=Disciplines to train via workorders when training Trading}}^{{Lich setting|name=tithe|desc=Whether or not to tithe (two boxes are supported), with a cooldown of 4 hours}}^{{Lich setting|name=cleaning_cloth|desc=The type of cleaning cloth to use when zills are dirty}}^{{Lich setting|name=dedicated_camb_use|desc=Set to 'cyclic' or 'spell' with respect to the magical feat}} ^{{Lich setting|name=wield|desc=Set to true or false; If true, then it wields and sheaths your weapon. This is very useful if you have weapons in different containers. With this set to true on each weapon (e.g. :wield: true in your gear settings), it will return them back from where they came with the wield and sheath commands.}}^{{Lich setting|name=dedicated_camb_use|desc=Set to 'cyclic' or 'spell' with respect to the magical feat}}
|uservars={{Lich setting|name=crossing_trainer_debug|desc=Turns on debugging messages.}}
|children=attunement, pick, sell-loot, theurgy, safe-room, workorders, sew, smith
}}

== crowns ==
{{Lich script
|description=Plays the Hollow Eve's game dice/crowns.
|usage=
|args=
|settings={{Lich setting|name=dice_bet_amount|desc=Put this in your yaml and set to some whole number, like dice_bet_amount: 10.}}^{{Lich setting|name=dice_money_on_hand|desc=How much money to withdraw from the bank.}}^{{Lich setting|name=dice_withdraw|desc=Withdraw money from the bank setting.}}^{{Lich setting|name=hollow_eve_loot_container|desc=Storage container name.}}
|uservars=
|children=
}}

== dusk-labyrinth ==
{{Lich script
|description=Searches for pets, bloodscrip, and loot in [[Drathrok%27s_Duskruin#Labyrinth|Duskruin Labyrinth]].
|usage=Configure your settings, enter the labyrinth, then start the script. The script will wait for messaging about a critter scurrying about and either try to catch it or move to another room. If no pet has been found by the 5 minute warning then it begins to search each room to collect bloodscrip and incidentals.
|args={{Lich setting|name=debug|desc=(optional) Turns on debugging messages.}}
|settings={{Lich setting|name=duskruin:labyrinth:pet_noun|desc=(required) Kind of pet searching for, such as '''monkey''' or '''rat'''.}}^{{Lich setting|name=duskruin:labyrinth:loot_container|desc=(optional) Which container to put the bloodscrip and items you find when searching. If not specified then relies on {{com|STOW}} left/right.}}^{{Lich setting|name=duskruin:labyrinth:redeem_scrip|desc=(optional) Set to '''true''' to auto redeem any found bloodscrip. Default is ''false''.}}
|uservars={{Lich setting|name=dusk_labyrinth_debug|desc=(optional) Turns on debugging messages.}}
|children=
}}

== echo ==
{{Lich script
|description=
|usage=
|args=
|settings=
|uservars=
|children=
}}

== edityaml ==
{{Lich script
|description=
|usage=
|args=
|settings=
|uservars=
|children=
}}

== empathylink ==
{{Lich script
|description=Will link to your hunting_buddies while in combat running combat-trainer. Will attempt to link with Hodierna, if known, or Unity if not.
|usage=Start the script in your autostarts or manually start with ;empathylink when you want to use. Script is meant to run in the background.
|args=
|settings={{Lich setting|name=has_hodierna|desc=Set to true in your yaml to use Hodierna link.}}^{{Lich setting|name=noheal_empathylink|desc=List of names you never want to heal even if in hunting_buddies list. This setting is in this script.}}
}}

== equipmanager ==
{{Lich script
|description=
|usage=
|args=
|settings=
|uservars={{Lich setting|name=equipmanager_debug|desc=Turns on debugging messages.}}
|children=
}}

== expreset ==
Resets your EXP window in Stormfront. This is useful for removing erroneous game output that gets 'stuck' in your exp window (usually during connection).
{{Lich script
|description=
|usage=
|args=
|settings=
|uservars=
|children=
}}

== faux-atmo ==
{{Lich script
|description=Bring your verby items to life! Turn toys and items with fun verbs into [[Atmospheric_item|atmospherics]] by periodically performing a random verb on a random item based on your settings.
|usage=Configure which items and verbs you want to periodically do then start the script. It runs in the background.
|args={{Lich setting|name=debug|desc=Enable debug mode.}}
|settings=
* Example Settings:
<pre>
# Number of minutes to wait between performing a verb on an item.
faux_atmo_interval: 15

# Set to true to randomly select an item and verb to perform.
# Set to false to round-robin select items and verbs to perform.
faux_atmo_random: true

# Items that don't have an inherent atmo effect
# but whose verbs if done periodically would.
faux_atmo_items:
- name: blue basilisk
verbs:
- pet
- pinch
- poke
- name: hooded cloak
verbs:
- rub
- pat
- wave

# Don't perform verbs on items if these scripts are running.
faux_atmo_no_use_scripts:
- combat-trainer
- go2
- get2
- bescort
- steal
- burgle

# Don't perform verbs on items if in these rooms.
faux_atmo_no_use_rooms:
- Carousel Chamber # Room with vault
- Carousel Booth # Room just before vault
- 1900 # You can specify room ids, too
</pre>
|uservars={{Lich setting|name=faux_atmo_debug|desc=Enable debug mode.}}
|children=
}}

== favor ==
{{Lich script
|description=Gets one favor by rubbing an orb repeatedly.
|usage=
It is intended to be used in [[RanikMap1|The Crossing]].

If an argument is passed to the script, that Immortal's name will be used. The default is Hodierna.
|args=
|settings=
|uservars=
|children=
}}

== fill-dirt ==
{{Lich script
|description=Fills a dirt stacker with dirt.
|usage=Run the script in any room where dirt is forageable.
|args=
|settings={{Lich setting|name=dirt_stacker|desc=Name of dirt stacker to fill. Must be worn.}}
|uservars=
|children=
}}

== find ==
{{Lich script
|description=Finds an NPC in [[RanikMap1|The Crossing]].
|usage=
|args={{Lich setting|name=npc|desc=A unique name (or noun) of the NPC to find.}}^{{Lich setting|name=follow|desc=If present, the script will follow the NPC around.}}
|settings=
|uservars=
|children=
}}

== find-darkbox ==
{{Lich script
|description=Finds and plays the Hollow Eve's game Darkbox.
|usage=
|args={{Lich setting|name=override|desc=Optional arg. Passes override to heal-remedy to use remedies instead of herbs if you already have herbs setup in your yaml.}}
|settings={{Lich setting|name=he_use_herbs_remedies|desc=Put this as true in your yaml if you want to use heal-remedy.}}^{{Lich setting|name=hollow_eve_loot_container|desc=Storage container name.}}
|uservars=
|children=
}}

== first-aid ==
{{Lich script
|description=Trains the First Aid skill by reading compendiums or textbooks More in-depth look at first-aid.lic: https://github.com/rpherbig/dr-scripts/wiki/First-Aid-Strategy
|usage=
|args=
|settings={{Lich setting|name=textbook|desc=False if using a compendium, true otherwise.}}^{{Lich setting|name=textbook_type|desc=If not using a compendium, the name of the thing to study.}}^{{Lich setting|name=compendium_type|desc=Will default to compendium but also supports burgled manuals and guides.}}
|uservars=
|children=
}}

== faskinner ==
{{Lich script
|description=Trains the First Aid skill with training items such as a small blue-belly crocodile with prominently stitched seams or a small fuzzy caracal with tufted ears and double-stitched seams.
|usage=
|args=
|settings=
* Example Settings:
<pre>
# Trainer noun should match exactly, such as crocodile or caracal
fa_skinning_trainer:

# Container where you store your trainer, if it's not worn.
fa_skinning_trainer_container:

# If you don't wear a skinning knife, this is the
# bladed weapon you want to use to skin with, such as a dagger.
fa_skinning_knife:

# If you specify 'fa_skinning_knife:' then this is
# the container where that bladed weapon is stored.
fa_skinning_knife_container:

# Options: First Aid, Skinning, Both or leave blank for whichever happens first
fa_skinning_priority:
</pre>
|uservars=
|children=
}}

== feed-cloak ==
{{Lich script
|description=Feeds [[living vine cloaks]] that you are wearing so that they stay refreshed and healthy.
|usage=Run on demand or part of a training routine to feed your cloak regularly. Does not run in the background.
|settings=
* Example Settings:
<pre>
# If your cloak can't feed in your current room
# then feed-cloak will move to this specified room id.
# If not specified, or if the cloak can't feed here either,
# then the script will move to your `safe_room`.
feed_cloak_room: 992 # Crossing, [Northeast Wilds, Outside Northeast Gate]
</pre>
}}

== forge ==
{{Lich script
|description=Forges an item. Adapted from a script by Mallitek.
|usage=
EXAMPLES:

<code>;forge weaponsmithing 2 sword steel sword</code>

<code>;forge blacksmithing 6 "shallow metal cup" bronze cup</code>

<code>;forge blacksmithing 6 scratcher bronze scratcher</code>

<code>;forge temper sword</code>
|args={{Lich setting|name=type|desc=Type of book (blacksmithing, armorsmithing, weaponsmithing)}}^{{Lich setting|name=chapter|desc=Chapter of the book}}^{{Lich setting|name=recipe|desc=the name of the recipe}}^{{Lich setting|name=metal|desc=metal type of the ingot in your bag}}^{{Lich setting|name=noun|desc=item noun to make}}
|settings=
|uservars=
|children=
}}

== gbox ==
{{Lich script
|description=Hand all boxes from a container (the first argument) to a character (the second argument).
|usage=
|args={{Lich setting|name=container|desc=The container}}^{{Lich setting|name=character|desc=The character}}
|settings=
|uservars=
|children=
}}

== glyph-of-mana ==
{{Lich script
|description=A script that will keep glyph of mana up always.
|usage=Meant to be used as a during: in combat but can be used anywhere.
<pre>
# Example usage:
hunting_info:
- :zone: cinder_beasts
args:
- d1
stop_on:
- Small Edged
:duration: 55
before:
- go2 12345
- mech-lore
- athletics
during:
- glyph-of-mana
</pre>
|args=
|settings=
|uservars=
}}

== gmoney ==
{{Lich script
|description=Hand money to the given character. The money is given 10 plat at a time, depositing first to minimize coinage (i.e. hand off plat instead of copper where possible). Useful for F2P players who cannot deposit more than 10 plat at once.
|usage=Start the script while you and the other player are standing at a bank teller.
|args={{Lich setting|name=character|desc=The character}}
|settings=
|uservars=
|children=
}}

== heal-remedy ==
{{Lich script
|description=Uses crafted remedies for healing
|usage=This script will cycle through the remedies, from base-remedies.yaml, from the most potent to least potent. The script will pause a little bit, letting the remedies work to make scars, then apply scar remedies. Will need one hand free to use.
|args={{Lich setting|name=override|desc=Override setting to force using remedies instead of herbs if herbs are already defined in your yaml.}}
}}

== healme ==
{{Lich script
|description=A self healing script for empaths
|usage=Will heal your own wounds, leaving external bleeders as desired. Uses Heal preferentially if configured and not attempting to keep bleeders. Targets wounds on potentially lethal body parts first, otherwise heals in severity order.
<pre>
#the first line is prep amount, second is a single cambrinth charge
empath_healing:
HW:
- 1
- 1
HS:
- 1
- 1
#HEAL:
#- 15
</pre>
|args={{Lich setting|name=Bleeders|desc=any body parts to leave external wounds on, quote two word body parts.}}
|settings={{Lich setting|name=prep_messages|desc=Used for spell casting matching and lives in base.yaml please submit custom prep messages as needed.}}^{{Lich setting|name=cambrinth|desc=noun for cambrinth used for casting}}^{{Lich setting|name=held_cambrinth|desc=true if you cannot charge your cambrinth worn}}^{{Lich setting|name=stored_cambrinth|desc= true if your cambrinth is stored in a container instead of worn}}^{{Lich setting|name=empath_healing:HW|desc=List of mana amounts. preps HW with the first the rest will be charged into cambrinth}}^{{Lich setting|name=empath_healing:HS|desc=List of mana preps for HS}}^{{Lich setting|name=empath_healing:HEAL|desc=List of mana preps for HEAL}}
|uservars={{Lich setting|name=healme_debug|desc=Turns on debugging messages.}}
}}

== horse-trainer ==
{{Lich script
|description=Teaches all skills to a horse.
|usage=This script will go through the list of skills and try to teach a horse. The order teaches is leadrope, saddle, animal, joust, kneel, prance, beg, spin, jump, combat, magic, war. You must be a Ranger to run this.
|args=
}}

== hunting-buddy ==
{{Lich script
|description= Trains combat skills (using combat-trainer) in defined hunting areas
|usage= Will move through a series of defined hunting spots, training at each one until specified conditions are met. Stops at the first empty room it finds in the hunting area, will search for hiding players and wait 10 seconds for them to take any actions in rooms with monsters, moving on if a player is already there.
|args=
|settings={{Lich setting|name=training_manager_hunting_priority|desc=Set to true and and you will stay in hunting spots until stop_on skills are at 32/34, set to false and you will stay until stop_on or duration is met.}}^{{Lich setting|name=hunting_zones|desc=The set of hunting areas defined in base.yaml that can be directly reached with go2.}}^{{Lich setting|name=escort_zones|desc=The set of hunting areas defined in base.yaml that requires custom pathing to reach.}}^{{Lich setting|name=hunting_info|desc=In order list of hunts.}}^{{Lich setting|name=hunting_info:zone|desc=Name of hunting zone, must match one of the two zone lists above.}}^{{Lich setting|name=hunting_info:args|desc=List of arguments to call combat-trainer with at this hunting area.}}^{{Lich setting|name=hunting_info:full_waiting_room|desc=Room to wait in while the zones are full, defaults to safe_room number if not present.}}^{{Lich setting|name=hunting_info:duration|desc=Time in minutes to hunt here if hunting_priority is false.}}^{{Lich setting|name=hunting_info:stop_on|desc=List of skills that will stop hunting when they are all at 32/34}}^{{Lich setting|name=hunting_info:boxes|desc=Sets the hunt as a box priority hunt, will stop or skip if you have box_loot_limit number of boxes if set to true}}^{{Lich setting|name=hunting_buddies|desc=List of PC's that you're ok to share a hunting room with, remember proper Capitalization.}}^{{Lich setting|name=hunting_nemesis|desc=List of PC's you do not want to hunt with, remember proper Capitalization.}}^{{Lich setting|name=empty_hunting_room_messages|desc=List of messages to use when asking if a room is empty. A random message will be used each hunt.}}^{{Lich setting|name=prehunt_buffs|desc=Room number where you can cast buffs before beginning hunt. List buffs under waggle_sets: with same heading prehunt_buffs:.}}^{{Lich setting|name=hunting_room_min_mana|desc=Minimum mana level of an acceptable hunting room.}}^{{Lich setting|name=hunting_room_strict_mana|desc=If false, it will find any empty room in the event that no empty rooms are found above the minimum mana level.}}^uservars=
|children=combat-trainer, buff
}}

== inventory-manager ==
{{Lich script
|description= Stores current "inv list" data in a YAML file for searching from any character... works across multiple accounts.
|usage= Store and access any character's "inventory list". Prints a list of character names stored, prints individual inventory, and searches all inventory for any keyword(s).
|args={{Lich setting|name=save|desc=Executes game command "inv list" and saves all items to database labeled as either worn or in container.}}^{{Lich setting|name=search|desc=Searches database for text provided. Requires an item for which to search.}}^{{Lich setting|name=list|desc=Shows all character(s) names stored within the database. Optional input of a character's name to list their inventory.}}^{{Lich setting|name=remove|desc=Removes character and associated data from database, requires a name.}}
}}

== invoke-rune ==
{{Lich script
|description= Use to cast spells from runestones. The runestones are the ones purchased from Sierack's Reagents, https://elanthipedia.play.net/Sierack%27s_Reagents, in Shard. Can add more from Enchanting or other places.
|usage= ;invoke-rune "<spell name>" example: ;invoke-rune "Clear Vision"
|args={{Lich setting|name=spell|desc=Name of the spells: "Arc Light" Althleticism Bless Calm "Clear Vision" Compost "Eagle's Cry" "Fire Shards" "Glythtide's Gift" Geyser "Protection from Evil" Refresh Shadows Zephyr. Use double quotes for spells with two or more words.}}^{{Lich setting|name=debug|desc=Puts script in debug mode.}}
|settings=
|uservars=
|children=
}}

== jail-buddy ==
{{Lich script
|description= Handles being arrested in the crossing
|usage= Keep running.
|args=
|settings=
|uservars=
|children=
}}

== join-thieves ==
{{Lich script
|description=Joins the thieves guild in Crossing.
|usage=
|args=
|settings=
|uservars=
|children=
}}

== journal ==
{{Lich script
|description=A script to use an epistemic journal. Best used as an after:
|args=
|settings=
|uservars= ''journal_noun'': Set the noun of your journal, defaults to journal
|children=
}}

== lamprey ==
{{Lich script
|description=Plays the Hollow Eve's game lamprey. Can only play this game once every 10 minutes if you get a lamprey or prize.
|usage=
|args=
|settings={{Lich setting|name=hollow_eve_loot_container|desc=Storage container name.}}
|uservars=
|children=
}}

== levelup ==
{{Lich script
|description=Walks to your guild leader and levels up as many times as you can.
|usage= <pre>;levelup</pre>
|args=
|settings=
|uservars=
|children=
}}

== locksmithing ==
{{Lich script
|description=Trains locksmithing independently or with crossing-training. Can use unlimited training boxes, daily charge training boxes, or limited use disposable training items such as corn maze pouches, liquor cabinets, or burgled keepsake boxes. Also trains [[Lich_script_repository#performance|performance]] while picking.
|usage=Can be used independently or by listing Locksmithing under crossing_training. If used with crossing_training additional feature <code>train_with_burgle: true</code> is available. The [[Lich_script_repository#burgle|burgle_settings: loot_container]] is a shared feature for ease of use with keepsake boxes.

'''Example Settings:'''
<pre>
# Do you use a worn lockpick ring for picking?
# If true then specify the name of your lockpick ring as the container.
use_lockpick_ring: true
lockpick_container: lockpick ring

# If false then the script will get a loose lockpick from the container.
#use_lockpick_ring: false
#lockpick_container: backpack

# When done picking boxes that contains coins, gems, and such,
# do you want to run the ;sell-loot script?
sell_loot: true

# Do you want to pick looted boxes from critters and such?
# If true then the ;pick script is ran using its settings.
# Refer to that script for how to set up those settings.
pick_live_boxes: true

# Do you want to pick a daily use lockbox trainer like a training box or harvest bag?
# If true then specify your trainer's name and whether it's worn or not.
have_training_box: false
picking_lockbox: training box
picking_worn_lockbox: false

# Do you want to pick consumable boxes such as limited use trainers from burgling or incidentals?
# If true then list the names of those discardable consumables here.
# IMPORTANT! Consumable boxes will be pulled from your burgle_settings: loot_container.
# IMPORTANT! Consumable boxes should be kept separate from live boxes so as not to cause issues with ;pick script.
# IMPORTANT! THESE BOXES WILL BE DROPPED. MAKE CERTAIN YOU ONLY LIST THROW-AWAY TRAINERS.
consumable_lockboxes:
- keepsake box
- box puzzle
- jewelry box

# If you use a daily use lockpick trainer,
# be sure to add it to your gear: config.
gear:
- :adjective: training
:name: box
:skip_repair: true
:container: backpack

</pre>
|args=
|settings=
|uservars=
|children=
}}

== makesteel ==
{{Lich script
|description= Makes steel ingots. The script will handle acquiring the needed materials.
|usage= <pre>;makesteel count [type] [refine]</pre>
|args= {{Lich setting|name=count|desc= (required) number of ingots to produce}}^{{Lich setting|name=type|desc=Carbon content, defaults to high. Options are: [l, m, h]}}^{{Lich setting|name=refine|desc=If provided, refine the resulting ingot}}
|settings={{Lich setting|name=hometown|desc=City in which to make the ingots, defaults to Crossing}}
|uservars=
|children=
}}

== mine ==
{{Lich script
|description= Mines a room while watching for danger
|usage= Prospects and mines out your current room, stowing or deeding anything in your vein list. Will prospect careful for more materials after exhausting the room.
|args=
|settings={{Lich setting|name=mining_buddy_vein_list|desc=List of metals and rocks that you wish to mine.}}^{{Lich setting|name=mine_implement|desc=Shovel or pick.}}^{{Lich setting|name=mine_use_packet|desc=Set to true to carry and use a deed packet, otherwise stow found minerals}}
|uservars=
|children=safe-room
}}

== mining-buddy ==
{{Lich script
|description= Perform a single pass through the mines
|usage= Will navigate through all listed mines, prospecting and stopping to mine anywhere it finds a resources it watches for. Can alternatively mine out each room it comes to, or merely look for resource rich rooms if you lack the skill to see resources. Will keep 1 plat on hand for repairs and buying deed packets. Will heal on injuries due to failed danger checks, or exit if buried.
|args=
|settings={{Lich setting|name=mining_buddy_rooms|desc=Defined in base.yaml, links mine names to a list of rooms}}^{{Lich setting|name=mines_to_mine|desc=List of mine names to mine, matches up against mining_buddy_rooms.}}^{{Lich setting|name=mining_skip_populated|desc=Set to true will NOT prospect and mine in rooms with other players.}}^{{Lich setting|name=mining_buddy_mine_every_room|desc=Set to true will prospect and mine out each room regardless of minerals.}}^{{Lich setting|name=mining_buddy_vein_list|desc=List of metals and rocks that you wish to mine.}}^{{Lich setting|name=mine_implement|desc=Shovel or pick.}}^{{Lich setting|name=mine_use_packet|desc=Set to true to carry and use a deed packet, otherwise stow found minerals}}
|uservars={{Lich setting|name=mining_debug|desc=Turns on debugging messages.}}
|children=mine,safe-room
}}

== mining-manager ==
{{Lich script
|description=repeatedly mines in defined mining areas (using mining-buddy)
|usage=
|args=
|settings=
|uservars=
|children=
}}

== mm ==
{{Lich script
|description=A general purpose moon mage utility script
|usage= Run the script without any arguments to see usage
|args= {{Lich setting|name=locate <name>|desc=Locates the given name and reports the room number if the locate was successful}}^{{Lich setting|name=rift <name>|desc=Locates and rifts the given name to your current room. Checks if the moons are up. Uses the same settings as <code>;mm locate</code>}}
|settings= {{Lich setting|name=waggle_sets['locate']|desc=Optional. A waggle set called 'locate' with only the locate spell in it. Uses the data in DISCERN locate otherwise.}}^{{Lich setting|name=waggle_sets['rs']|desc=Optional. A waggle set called 'rs' with only the locate Riftal Summons spell in it. Uses the data in DISCERN RS otherwise.}}
|uservars=
|children=
}}

== moonwatch ==
{{Lich script
|description=populates UserVars.moons with data related to the moons
|usage=
Moonwatch will populate UserVars with the following data:
<code>
UserVars.moons = {
'katamba' => { 'pretty' => 'Katamba is up for 35 minutes', 'rise' => nil, 'set' =>35 },
'yavash' => { 'pretty' => 'Yavash will rise in 150 minutes', 'rise' => 150, 'set' => nil },
'xibar' => { 'pretty' => 'Xibar is up for 5 minutes', 'rise' => -1, 'set' => 5 }
'visible' => ['katamba', 'xibar']
}
</code>

We suggest using an alias such as:

<code>;alias add moon = ;eq respond("#{UserVars.moons['katamba']['pretty']} : #{UserVars.moons['yavash']['pretty']} : #{UserVars.moons['xibar']['pretty']}")</code>

You can {{com|PERCEIVE}} an individual moon to reset its data or [[Moon_Mage_attunement#Power Perception|PERCEIVE MOONS]] to reset all if this is a first start (or you've been offline for a while and the data seems wrong).
|args={{Lich setting|name=debug|desc=Turns on debugging messages.}}
|settings=
|uservars={{Lich setting|name=moon_debug|desc=Turns on debugging messages.}}
|children=
}}

== multi ==
{{Lich script
|description=Executes a series of actions or scripts multiple times.
|usage=Run on-demand or as part of 'before' or 'after' steps of other scripts or as customized actions to perform with T2.

'''Example Usage:'''
<pre>
# This will cause you to sit then kneel then stand then repeat that sequence one time.
;multi 2,sit,kneel,stand

# This toggles autosneak flag before/after burgling.
burgle_settings:
before:
- multi 1,flag autosneak off
after:
- multi 1,flag autosneak on
...

# This example combines doing actions and running scripts.
# To run a script, prefix its name with a colon.
# It also passes arguments to the script (each argument separated by a space).
;multi 5,get sword from my backpack,:myForgingScript sword,put sword in my carryall
</pre>
|args=
|settings=
|uservars=
|children=
}}

== newbie-gear ==
{{Lich script
|description=Crafts a set of gear for a new character.
|usage=
|args={{Lich setting|name=storage|desc=The container in which to store finished items}}
|settings=
|uservars=
|children=
}}

== oshu_manor ==
{{Lich script
|description=Navigates you through the Oshu Manor. Used to hunt [[Seordhevor kartais]]. Note there is an underscore in this script's name, not a dash.
|usage=
|args=
|settings=
|uservars=
|children=
}}

== paladin-quests ==
{{Lich script
|description=Completes the paladin Glyph quests for you.
|args={{Lich setting|name=warding|desc=Complete the Glyph of Warding Quest.}}{{Lich setting|name=bonding|desc=Complete the Glyph of Bonding Quest.}}{{Lich setting|name=light|desc=Complete the Glyph of Light Quest.}}{{Lich setting|name=mana|desc=Complete the Glyph of Mana Quest.}}{{Lich setting|name=ease|desc=Complete the Glyph of Ease Quest.}}{{Lich setting|name=renewal|desc=Complete the Glyph of Renewal Quest.}}
|settings=
|uservars=
|children=
}}

== pattern-hues ==
{{Lich script
|description=Casts Warrior Mage Pattern Hues cantrip at set intervals.
|usage= The script will cast pattern hues cantrip based on settings in yaml. If no custom settings set, will cast a random color. Examples: ;pattern-hues now will cast now and exit. ;pattern-hues in you before, after, t2, manually, or in a personal startup script will change cast the cantrip on your interval and with settings. Leave pattern and hue empty if you want to pick from all the available options. Put what you only want the color to go to for random. Custom is for those lucky enough to have their own color (Dartellum has a custom color). Or, put the exact color you want in gesture, such as bright emerald.
|args= {{Lich setting|name=now|desc=Cast now.}}{{Lich setting|name=debug|desc=Output variable values.}}
|settings={{Lich setting|name=Pattern Hues yaml settings: gesture is either random, custom, or a specific setting.}}
pattern_hues:
duration: 600
gesture: custom
pattern_hues_styles:
pattern:
- bright
- hazy
- gleaming
- lucent
hue:
- soot black
- emerald
- bone white
- snowflake white
- yellow
- charcoal black
- sky blue

|uservars=
|children=
}}

== pay-debt ==
{{Lich script
|description=Pays your debt. Optionally retrieves your sack of belongings from the guard house.
|usage=
|args=
|settings=
|uservars=
|children=
}}

== performance ==
{{Lich script
|description=Script to train performance. Defaults to worn instrument but accepts an instrument setting
|usage=
|args=
|settings={{Lich setting|name=instrument|desc=Optional. The instrument you would like to use. Defaults to worn instrument if none selected}}
|uservars=
|children=
}}

== performance-monitor ==
{{Lich script
|description=Logs combat-related events such as damage, roundtime, etc. for later parsing.
|usage=
|args=
|settings=
|uservars=
|children=
}}

== pick ==
{{Lich script
|description=Disarms, harvests, and unlocks boxes
|usage=The script will look for suitable disposal sources in the room, or drop refuse on the ground. Refills lockpicking ring after finished.
|args={{Lich setting|name=pets|desc=Disarm boxes and place them in the pet box container}}^{{Lich setting|name=count|desc=How many pet boxes to make }}^{{Lich setting|name=refill|desc=Refill your lockpick ring}}
|settings={{Lich setting|name=stop_pick_on_mindlock|desc=true to stop after the current box when your mind is full.}}^{{Lich setting|name=use_lockpick_ring|desc=Do you wear a lockpick ring?}}^{{Lich setting|name=skip_lockpick_ring_refill|desc=Set this to TRUE in order to skip buying lockpicks after mind-locked. This is important if you have crafted lockpicks on the ring, since you can't use lockpicks of differing qualities on the same ring.}}^{{Lich setting|name=lockpick_type|desc=Type of lockpick to stock on ring.}}^{{Lich setting|name=harvest_traps|desc=true to harvest traps while disarming.}}^{{Lich setting|name=picking_box_source|desc=The bag that unopened boxes are stored in.}}^{{Lich setting|name=picking_box_storage|desc=The bag to put boxes into that are too difficult to disarm.}}^{{Lich setting|name=picking_pet_box_source|desc=The bag that disarmed pet boxes are stored in.}}^{{Lich setting|name=lockpick_dismantle|desc=If you have a custom dismantle type to use, put it here.}}^{{Lich setting|name=lockpick_buffs:spells:abbrev|desc=abbreviation of a buff to put up before picking.}}^{{Lich setting|name=lockpick_buffs:spells:mana|desc=amount of mana to use for prep.}}^{{Lich setting|name=lockpick_buffs:spells:cambrinth|desc=List of cambrinth charges, see crossing-training for cambrinth related settings.}}^{{Lich setting|name=lockpick_buffs:khri|desc=List of khri to turn on before lockpicking.}}^{{Lich setting|name=lockpick_room_id|desc=Select a specific room number to open boxes to avoid blowing up your neighbors}}
|uservars={{Lich setting|name=lockpick_debug|desc=Turns on debugging messages.}}
|children=
}}

== release_cyclic ==
{{Lich script
|description=Releases all cyclic spells.
}}

== ranger-companion ==
{{Lich script
|description=Summons a companion and feeds it milk or corn if it's a baby, handles raising a baby pet to young age. Meant to be used as a during: in combat but works anywhere as long as you are stationary.
}}

== researcher ==
{{Lich script
|description=Does research on a single subject.
|usage=Specify the subject as an argument, e.g. ;researcher augmentation
|args=missing
|settings=missing
|uservars=missing
|children=missing
}}

== register ==
{{Lich script
|description=A script for searching your deed register.
|usage=The script will search your deed register for the specified crafting material.

Example: <code>;register damite</code>
--- Lich: register active.
;Output of reading register not shown here to save space.
Results:
45 -- a deed for a damite ingot (48V 91Q - pure Damite --Binu)
46 -- a deed for a damite ingot (10V 86Q - pure Damite --Binu)
[register]>stow right
You put your register in your hunting pack.
--- Lich: register has exited.

|args={{Lich setting|name=query|desc=The material you want to search for. Can also be information you entered in the deed note.}}
|settings={{Lich setting|name=crafting_container|desc=The name of the container where you store your deed register.}}
|uservars=
|children=
}}

== remedy ==
{{Lich script
|description=A script for crafting remedies using alchemy.

remedy <book type> <chapter> <recipe name> <herb1> <herb2> <catalyst> <container> <noun>

Book type: What alchemy type is this item. [remedies]

Chapter: containing the item.

Recipe name: Name of the recipe, wrap in double quotes if this is multiple words.

Herb1: Prepared herb, wrap in double quotes if this is multiple words..

herb2: Prepared herb, wrap in double quotes if this is multiple words. Put none for none.

catalyst: Type of catalyst.

container: Type of container for creating.

noun: End product [cream, salve, wash, balm, ungent, potion, tonic, ointment, elixir, poultices, draught]

remedy <continue> <herb2> <catalyst> <container> <noun>

continue

herb2: Prepared herb, wrap in double quotes if this is multiple words. Put none for none.

catalyst: Type of catalyst.

container: Type of container for creating.

noun: End product [cream, salve, wash, balm, ungent, potion, tonic, ointment, elixir, poultices, draught]

}}

== repeat ==
{{Lich script
|description=A script for repeating a sequence of up to 10 commands. Does not take scripts.
|usage=>;repeat "get my rock" "drop my rock"
}}

== restock ==
{{Lich script
|description=A script for restocking your supply of stackable and nonstackable items.
|usage= Will parse your YAML for a restock set and make the appropriate purchases to maintain your desired quantity. This is called at the start of hunting-buddy as the preferred mechanism to maintain ammunition counts.
|args=
|settings={{Lich setting|name=restock|desc=list of item names or hashes. A name will be searched in base-consumables based on your hometown setting. It will go and purchase the appropriate version of that item found in that hometown. For example, lising "arrow" will purchase boar-tusk arrows in Crossing, but if your in Shard will purchase long arrows. Any of the values pulled from base-consumables can be overridden by providing by appropriate key-value-pair under the item name within your YAML. Not all cities have every type of item (for example only the Crossing sells rocks or sling/ammo). As such, you can explicitly define your own items within the YAML by setting the item name, with the following key-value-pairs: name, room, price, size (how many obtained in a single purchase transaction), stackable (t/f), and quantity (how many you want to maintain on hand at a given time). Here are some examples:
<pre>
# This will purchase arrows from your hometown using all defaults; including quantity (which is 30)
restock:
arrow

# This is the same as above, but with a custom quantity
restock:
arrow:
quantity: 45

# this is a completely custom item not contained in base-consumables. It will not change based on hometown.
restock:
super_cool_thing:
name: cool thing
room: 1337
price: 10
size: 3
stackable: true
quantity: 4

# Here are a list of generic items in base-consumables:
arrow
bolt
tk_ammo
rock

# Restock now supports custom Hometowns. This will be super useful if you use Shard as a hometown and need rocks from Hib. You can have as many as you want, but be reminded that we must support the hometown in base-towns.yaml. The hometowns will be visited in order from first to last, listed top to bottom.

hometown: Shard

restock:
arrow:
quantity: 50
bolt:
quantity: 50
rock:
hometown: Hibarnhvidar
name: smooth rocks
room: 12172
price: 45
size: 30
stackable: true
quantity: 50

# restock can probably handle items with "charges" (i.e ritual foci) if they disappear/consumed once all charges are gone.
</pre>}}
|uservars=
}}

== rezz ==
{{Lich script
|description=A script to rezz corpses
|usage=The script will either raise the person you specify, or if you don't specify someone it will raise all of the corpses in the room. You should add a rezz: waggle set so that it doesn't use default values for rejuv and rezz.
|args={{Lich setting|name=player|desc=The person you want to raise. Optional argument}}
|settings={{Lich setting|name=osrel_no_harness|desc=true to infuse directly, false to harness first.}}

Waggle set to add. Customize the mana and cambrinth values to your skill level:

waggle_sets:
rezz:
Resurrection:
abbrev: rezz
mana: 17
Rejuvenation:
abbrev: rejuv
mana: 10
cambrinth:
- 15
}}

== roomnumbers ==
{{Lich script
|description=Adapted from a script by Geldan for Gemstone. Appends the Lich room ID# to your in-game room look. Example:

<pre>[Whistling Wood, Barrows]
A mound of earth looks curiously out of place beneath the twisted and warped branches of the dead trees. Barren of all but the hardiest of grasses, the mound has several small
holes in its side. You also see an Adan'f blood warrior, a chipped and weather-beaten sign, an Adan'f blood warrior and an Adan'f blood warrior.
Obvious paths: southeast, southwest, northwest.
Room Number: 9471
</pre>
|usage=
|args=
|settings=
|uservars=
|children=
}}

== safe-room ==
{{Lich script
|description= Heals at a PC or NPC empath and shares items between characters by taking and dropping them in a safe room
|usage= Gets 4 gold (for autopath), goes to the auto empath and waits until healed. Alternatively can go to a specific set of rooms and wait for 45 seconds for a player empath to heal you. You can list several PC empaths. The script will go to the nearest one from your current location. PC Empaths will heal themselves using healme, Necromancers will not attempt to go to an empath. Can be configured to stop by a room and pick up or drop given item nouns.
|args=
|settings={{Lich setting|name=safe_room_tip_threshold|desc=Amount of copper to carry for npc healing, or if you have more than this amount donate to player empath.}}^{{Lich setting|name=safe_room_id|desc=Id of room for player empath healer or item exchanges.}}^{{Lich setting|name=saferoom_health_threshold|desc=Skips saferoom healing unless the 'force' argument is used. This is a number that represents your wound severity. The calculation of your wound score is Sum(wound level^2 * number of wounds at that level).}}^{{Lich setting|name=safe_room_empath|desc=Name of PC empath healer.}}^{{Lich setting|name=safe_room_empaths|desc=A list of PC empaths with their name and room ID}}^{{Lich setting|name=safe_room_tip_amount|desc=Amount in coppers to donate player empath.}}^{{Lich setting|name=safe_room|desc=Id of room to heal self at as empath.}}^{{Lich setting|name=safe_room_give|desc=List of nouns to drop at safe_room_id, CAUTION will drop all items of this noun there, don't use for anything valuable.}}^{{Lich setting|name=safe_room_take|desc=List of nouns to pick up in safe_room_id.}}^{{Lich setting|name=force_healer_town|desc=Override your hometown: setting to use an auto empath in a different town.}}^{{Lich setting|name=heal_with_divine_charm|desc=true/false - Attempt to use a divine charm that new characters start with to heal, instead of an auto-path.}}
|uservars=
|children=healme
}}

== sanowret-crystal ==
{{Lich script
|description=Runs in the background, gazing or exhaling your sanowret crystal to train [[Arcana]]. Checks for concentration and current mindstate to run only when necessary. Supports worn crystals or stored in a container.
|usage=This script can be run in passive mode or on-demand, and is well suited as part of your autostarts.

Run once on-demand: <code>;sanowret-crystal run=true</code>

Run in the background: <code>;sanowret-crystal</code>

Auto start: <code>;autostart add sanowret-crystal</code>

|args={{Lich setting|name=run|desc=If present, only run the script once (instead of in passive mode).}}
|settings=In your YAML, configure the adjective of your sanowret crystal and list any scripts or rooms where you don't want the script to run, such as when burgling or in a room that prevents magical device usage.

Example:

sanowret_adjective: sanowret
sanowret_no_use_scripts: # Don't try to use crystal while these scripts are active.
- sew
- carve
- tinker
- forge
- remedy
- shape
- enchant
- outdoorsmanship
- combat-trainer
- buff
- burgle
- go2
sanowret_no_use_rooms: # Don't try to use crystal while in these rooms.
- Carousel Chamber # Room with vault
- Carousel Booth # Room just before vault
- 1900 # You can specify room ids, too (Crossing bank window)

}}

== scroll-search ==
{{Lich script
|description= Searches through the given container for any and all spell scroll and displays them in a more readable way. Also allows for the player to grab a specific scroll or transfer scrolls between containers. This script allows you to search multiple containers and tracks the scrolls in each.
|usage= Player specifies the container to search and the script looks through the container for any nouns matching scroll_nouns specified in base-items.yaml
|args={{Lich setting|name=search <container>|desc=Searches the given container}}^{{Lich setting|name=display|desc=Displays the scrolls in all searched containers. Must have already searched or the list will be empty!}}
|settings={{Lich setting|name=scroll_nouns|desc=List of scroll nouns to search container for.}}
|uservars={{Lich setting|name=owned_scrolls|desc=Hashset of the scroll name and the container it resides in.}}^{{Lich setting|name=scroll_counter|desc=Global counter for the amount of scrolls owned.}}^{{Lich setting|name=scroll_search_debug|desc=Turns on debug messaging for scroll-search.lic script.}}
|children=
}}

== sell-loot ==
{{Lich script
|description= Sells gems and bundles; then deposits coin. Defaults to keeping 3 silver on hand (the maximum amount that cannot be stolen by a Thief).
|usage= Will sell bundles and any gems in untied gem pouches. Optionally will make sure you have a spare gem pouch. It is intended to be used in [[RanikMap1|The Crossing]].

EXAMPLES:
* <code>;sell-loot</code> # Uses the default: keeps 3 silver
* <code>;sell-loot 12</code> # Uses one argument: keeps 12 silver, which is withdrawn as 1 gold and 2 silver
* <code>;sell-loot 4 g</code> # Uses two arguments: keeps 4 gold
|args={{Lich setting|name=Withdraw|desc=Amount of coin to withdraw after depositing all. 3 silver, 5 gold, etc.}}
|settings={{Lich setting|name=sell_loot_money_on_hand|desc=Same as the Withdraw argument, overridden by the argument if both exist.}}^{{Lich setting|name=sell_loot_pouch|desc=Set true to sell any gems in a worn pouch.}}^{{Lich setting|name=sell_loot_bundle|desc=Set to true to sell a worn bundle.}}^{{Lich setting|name=sell_loot_traps|desc=Sell harvested traps from boxes that are in your 'component_container'.}}^{{Lich setting|name=spare_gem_pouch_container|desc=The container to store a spare gem pouch in, should NOT be the container a pouch stows to.}}^{{Lich setting|name=gem_pouch_adjective|desc=Adjective you use to request gem pouches, you should be able to tap ADJ pouch to tap your current pouch.}}^{{Lich setting|name=sell_loot_skip_bank|desc=If true, skip bank parts of the script (currency exchange, deposit, withdrawal).}}^{{Lich setting|name=sell_loot_skip_exchange|desc=If true, skip currency exchange.}}^{{Lich setting|name=bankbot_name|desc=The name of the bankbot with whom you would like to deposit coin.}}^{{Lich setting|name=bankbot_deposit_threshold|desc=An amount of copper to keep on hand. Excess will be deposited with the bankbot. Your in-game bank will always be deposited into before the bankbot.}}^{{Lich setting|name=bankbot_room_id|desc=The room ID of the bankbot.}}
|uservars=
|children=
}}

== sell-pouches ==
{{Lich script
|description=Sell gem pouches for trading experience
|usage=This script is called by crossing-training when you have 'Trading' listed as a training skill and 'sell_pouches_for_trading' set to true. You can also call it to sell a pouch.
|settings={{Lich setting|name=hometown|desc=Your hometown. This is used to determine which gemshop you will sell your pouches to}}^{{Lich setting|name=sale_pouches_container|desc=Container where your pouches for sale are stored}}^{{Lich setting|name=waggle_set named 'sell-pouches'|desc=Casts these spells before selling a pouch. This is where you would include spell data for casting Finesse}}

}}

== setupaliases ==
{{Lich script
|description=Adds a useful selection of aliases to the global list:
* <code>as</code> - accepts a trade offer and then stows the item
* <code>gs</code> - gets the given item and then stows the item
* <code>cc</code> - runs ;circlecheck to show your leveling status. it can take args, like cc 200
* <code>ct</code> - toggles crossing-training on or off
* <code>tm</code> - toggles training-manager on or off
* <code>fr</code> - find room, searches for a room description matching provided text
* <code>ids</code> - echos the current mapped connections from the room you're standing in
* <code>lr</code> - echos the full data of the room you're standing in
* <code>lfr</code> - echos the full data of the room a remote room number, pass the number to it
* <code>ls</code> - shows all items in the current room you are in that are stealable that are not in base-stealing
* <code>cb</code> and <code>rec</code> - these work as a pair, for recording room numbers (like setting up a hunting area); run <code>cb</code> to start, then <code>rec</code> in each room you want to record
* <code>hz</code> - list all hunting zones alphabetically
* <code>ez</code> - list all escort hunting zones alphabetically
* <code>fz</code> - search hunting zones and get room numbers, e.g. <code>fz wark</code> returns a list of room numbers for warklins
|usage=
|args=
|settings=
|uservars=
|children=
}}

== sew ==
{{Lich script
|description=
|usage=
|args=
|settings=
|uservars=
|children=
}}

== shape ==
{{Lich script
|description=
|usage=
|args=
|settings=
|uservars=
|children=
}}

== skill-recorder ==
{{Lich script
|description=
|usage=
|args=
|settings=
|uservars=
|children=
}}

== slackbot ==
{{Lich script
|description= If the status-monitor script detects an problem, it will use this script to send you a Direct Message on Slack.
|usage= This script should not be run directly. Instead, status-monitor will run it if the slack_username setting is present. On first time setup you will communicate with a lichbot to get a slack token. The token lets you send messages to your username via the bot. You will currently not receive any notification on setup.
|args=
|settings={{Lich setting|name=slack_username|desc=Your Slack username. It should be all lowercase.}}
|uservars={{Lich setting|name=slack_token|desc=The token used to authenticate to a Slack team.}}
|children=
}}

== smartlisten ==
{{Lich script
|description=If someone teaches you an approved class you'll start listening.
|usage=The default list of approved classes is all non-necromancer skills and no sorcery or thievery. Guild-specific skills are approved if you are of that guild. Some specific classes are also removed based on your guild (e.g. remove Arcana for Barbarians).
|args=
|settings=
|uservars=
|children=
}}

== smarttransfer ==
{{Lich script
|description=safely transfer wounds from the target, avoiding useless injuries in fatal areas
|usage=
|args={{Lich setting|name=bleed|desc=If present, leave external bleeders.}}
|settings=
|uservars=
|children=
}}

== smash-pumpkins ==
{{Lich script
|description=Travel to the pumpkin vat, buy one, go one room away to smash and repeat until too injured. Then return to the safe room.
|usage=
|args=
|settings={{Lich setting|name=hollow_eve_loot_container|desc=Storage container name.}}
|uservars=
|children=
}}

== smelt ==
{{Lich script
|description=Smelt the contents of a crucible. Assumes that material has already been placed into the crucible.
|usage=
|args=
|settings=
|uservars=
|children=
}}

== smelt-deeds ==
{{Lich script
|description=combines deeds of like metals to save inventory space
|usage=
|args=
|settings=
|uservars=
|children=
}}

== smith ==
{{Lich script
|description=
|usage=
|args=
|settings=
|uservars=
|children=
}}

== smoke ==
{{Lich script
|description=smokes an item
|usage=
You can run the script two ways, one from command line and the other from a YAML.

Command line:

;smoke <image> <cigar noun> <container things are in> <lighter's noun (MUST be a lighter)>

You can also run it from a YAML setting:

;smoke <cigar noun>

|args=Command Line:

<image> <cigar noun> <container things are in> <lighter's noun (MUST be a lighter)>

YAML:

<cigar noun> (When running from YAML)

|settings=
<pre>
smoke:
cigar_container: humidor
smoke_image:
lighter:
type: flint
container: humidor
blade: dagger
</pre>
|uservars=
|children=
}}

== sorcery ==
{{Lich script
|description=
|usage=
|args=
|settings=
|uservars=
|children=
}}

== spin ==
{{Lich script
|description=This script is intended to be used in [[RanikMap1|The Crossing]].
|usage=
|args=
|settings=
|uservars=
|children=
}}

== stabbity ==
{{Lich script
|description=Stabbity is designed for thieves, and relies on backstab and thrown weapons to kill things quickly. It's useful in invasions and events.
|usage=
When run without a mode specified (e.g. <code>;stabbity</code>), stabbity will wield your weapon and hide, killing any mob in the room. If no mobs are present, it will wait in hiding for one to arrive.

'''Example Configuration'''
<pre>stabbity:
eliminate: true
weapons:
preferred: glaes pasabas
alternate: judge's gavel
thrown: throwing club
use_alternate_on:
- archer
- soldier
- dryad
- oshu
- frostweaver
- guardian
use_thrown_on:
- hawk
- gryphon</pre>
|args=
{{Lich setting|name=mode|desc=Optional, can be one of:^
* ''equip'': Wields your preferred weapon.^
* ''cleanup'': Sheathes your preferred weapon.^
* ''single'': Kills all mobs in the current room and exits. Does not wait for mob to arrive.^
* ''arena'': Used to run the Dusk Ruin arena.}}^
{{Lich setting|name=noloot|desc=Do not loot mobs when killed.}}
|settings=
{{Lich setting|name=stabbity:eliminate|desc=True/False. Only used during arena. Will use krhi eliminate at the beginning of rounds 5/10/15/20/25. '''Only include if you are a thief with khri eliminate.'''}}^
{{Lich setting|name=stabbity:weapons:preferred|desc=The name of the weapon you wish to backstab with.}}^
{{Lich setting|name=stabbity:weapons:alternate|desc=The name of the weapon you wish to use for mobs defined in use_alternate_on.}}^
{{Lich setting|name=stabbity:weapons:thrown|desc=The name of the weapon you wish to use for mobs defined in use_thrown_on. If this is left off, then it will never try thrown (useful for characters with passive abilities that can force flying thins to land - ex khri terrify).}}^
{{Lich setting|name=stabbity:use_alternate_on|desc=List of mobs on which to use your alternate weapon.}}^
{{Lich setting|name=stabbity:use_thrown_on|desc=List of mobs on which to use your thrown weapon.}}
|uservars={{Lich setting|name=stabbity_debug|desc=Turns on debugging messages.}}
|children=
}}

== stack-scrolls ==
{{Lich script
|description=Scroll stacker manager script that stores and retrieves scrolls using stackers.
}}

== status-monitor ==

{{Lich script
|description=Informs user of high-frequency game output and characters current health via a small window. Useful for keeping tabs on multiple characters.
|usage=Trust status monitor then run it.
|args={{Lich setting|name=debug|desc=Turns on debugging messages.}}
|settings=
|uservars=
|children=
}}

== steal ==
{{Lich script
|description=
|usage=
|args=
|settings=^{{Lich setting|name=hide_to_steal|desc=set to false if you do not wish to hide to steal.}}^{{Lich setting|name=bin_stolen|desc=set to true for Thieves who wish to bin stolen goods.}}^{{Lich setting|name=stealing_bag|desc=storage bag for stolen goods if bin_stolen: true}}^{{Lich setting|name=slow_bin_speed|desc=set to true to bin items slower. Resolves type-ahead issue for Genie users.}}^{{Lich setting|name=steal_past_mindlock|desc=set to true if you wish to continue stealing after Thievery is locked.}}^{{Lich setting|name=dont_steal_list|desc=list items by id# identified in '''base-stealing.yaml''' to skip these items when stealing.}}^{{Lich setting|name=stealing_buffs|desc=list of buffs to use before starting stealing run.}}^{{Lich setting|name=stealing_high_acceptable_count|desc=.}}^{{Lich setting|name=stealing_low_acceptable_count|desc=.}}^{{Lich setting|name=npc_stealing_attempt_count|desc=Numeric amount of stealing attempts on NPCs (minstrel, veteran, etc.)}}^{{Lich setting|name=stealing_options|desc=list of stealable items in base-stealing.yaml}}^
|uservars=
|children=
}}

== study-art ==
{{Lich script
|description=Walks through the Crossing art gallery and appraises each piece on display. Trains scholarship and appraisal.
|usage=Just run it. e.g. <code>;study-art</code>
|args=
|settings=
|uservars=
|children=
}}

== summoning ==
{{Lich script
|description=Trains summoning via summoning and breaking a magical weapon. Summons admittance to build up charges to summon a weapon. [[Warrior Mages]] must have already {{com|align}}ed to an element.
|settings={{Lich setting|name=summoning_target_increment|desc=The desired number of mind states to increase by. Respects crossing_training_max_threshold as an upper threshold.}}
}}

== tarantula ==
{{Lich script
|description=Manages the automated usage of the biomechanical tarantula, a gift handed out for patrons of Hollow Eve 432.
|usage=Run <code>;tarantula</code> after adjusting YAML settings as desired. Can be added to startup. The script watches for skills near max-mindstate to sacrifice for their bonus, with different behavior depending on if you're in combat or not.
|args=
|settings=^{{Lich setting|name=tarantula_startup_delay|desc=Number of seconds to wait after first starting before it will eat skills. Useful when tarantula is added to autostarts, so that it doesn't eat skills on first login, before login drain.}}^
{{Lich setting|name=tarantula_noun|desc=Change if you've had a tarantula alteration or if you bought the harvester spider at 2020 Corn Maze. Use both the adjective and noun.}}^
{{Lich setting|name=tarantula_debug|desc=Set true if you wish to see debug messages}}^
{{Lich setting|name=tarantula_excluded_skills|desc=A list of skills never to sacrifice to the tarantula.}}^
{{Lich setting|name=tarantula_no_use_scripts|desc=A list of scripts defined by you, during which the tarantula will not activate.}}^
{{Lich setting|name=tarantula|desc=A list of skills, organized by skillset and by whether you want them sacrificed in and/or out of combat as defined by whether combat-trainer is running. These are the prioritized choices, however ;tarantula will choose other full skills in that sphere if none of its prioritized skills are available, unless they are listed in <code>tarantula_excluded_skills</code>

<pre>
tarantula:
Armor:
combat:
- Chain Armor
- Brigandine
- Plate Armor
- Light Armor
- Defending
Weapon:
combat:
- Melee Mastery
- Missile Mastery
Magic:
combat:
- Utility
non_combat:
- Lunar Magic
- Warding
- Augmentation
- Utility
Survival:
combat:
- Evasion
- Skinning
non_combat:
- Outdoorsmanship
Lore:
non_combat:
- Appraisal
- Performance
- Scholarship

An example of exclusions added to a yaml:

tarantula_excluded_skills:
- Large Edged
- Brawling
- Evasion
- Parry
- Shield
- Athletics
- Crossbow
- Slings
- Light Thrown
- Bow

</pre>

}}^
|uservars={{Lich setting|name=tarantula_last_use|desc=The last time the tarantula was sacrificed to.}}^{{Lich setting|name=tarantula_last_skillset|desc=The last sphere sacrificed to, since the tarantula can't be used on the same sphere twice in a row.}}
|children=
}}

== tendme ==
{{Lich script
|description=Automatic wound tender for self. On start, checks {{com|health}} for bleeding wounds and tends them, then watches for messages to unbind or retend wounds.
|usage=
|args={{Lich setting|name=train|desc=If present, unwrap and rebind wounds for optimum learning.}}
|settings=
|uservars=
|children=
}}

== tendother ==
{{Lich script
|description=Automatic wound tender for another player. On start, looks for bleeding wounds and tends them, then watches for messages to unbind or retend wounds.
|usage=
|args={{Lich setting|name=player|desc=Name of the player to tend.}}
|settings=
|uservars=
|children=
}}

== textsubs ==
{{Lich script
|description=Provides in-game text substitution capabilities; comes with many defaults (e.g. appraisal and combat messages).
|usage=
Example of adding a sub: <code><nowiki>TextSubs.add('^(\s+)no (puncture|slice|impact|fire|cold|electric) damage','\1no (0/27) \2 damage')</nowiki></code>

Clear out all stored subs with <code>TextSubs.clear()</code>
|args=
|settings=
|uservars=
|children=
}}

== theurgy ==
{{Lich script
|description=train theurgy by working up devotion and doing communes
|usage= Recommended - Eluned (holy water)
|args=
|settings={{Lich setting|name=theurgy_supply_container|desc=Container for storing wine, flint, and incense.}}^{{Lich setting|name=water_holder|desc=Vessel that you store holy water in.}}^{{Lich setting|name=flint_lighter|desc=Blade for lighting flint.}}^{{Lich setting|name=immortal_aspect|desc=for bead carving/meditation (must be aspect of god you last got a favor from).}}^{{Lich setting|name=theurgy_prayer_mat_room|desc=Room in which to use your prayer mat. Requires an object defined with an `id: roomid` format, ex.
<nowiki>
theurgy_prayer_mat_room:
id: 1234</nowiki>
}}
|uservars=
|children=
}}

== titlecheck ==
{{Lich script
|description=Checks for new titles since the last time you ran the script.
|usage=Run the script and provide a set of titles to check (e.g. ;titlecheck moonmage). On the first run for that title set, all titles will be reported as new. Running the script afterwards will report only new titles.
|args=title_set
|settings=
|uservars=titles
|children=
}}

== trade ==
{{Lich script
|description=Do caravan trading in Zoluren
}}

== train ==
{{Lich script
|description=Train the given attributes. It is intended to be used in [[RanikMap1|The Crossing]].
|usage=
Arguments are the name of the attribute to train, with an optional number of trainings (Defaults to 1):
* <code>;train</code>
No arguments: nothing happens
* <code>;train st</code>
"st" is ambiguious between stamina and strength: nothing happens
* <code>;train sta w2</code>
Trains stamina once and wisdom twice
|args=
|settings=
|uservars=
|children=
}}

== training-manager ==
{{Lich script
|description= High level script for managing combat and non combat training
|usage= Will alternate training in the crossing and hunting with a focus on either in or out of combat as specified. Heals and repairs after combat.
|args=
|settings={{Lich setting|name=training_manager_hunting_priority|desc=Set to true will cause it to focus on combat training at the expense of out of combat.}}^{{Lich setting|name=training_manager_priority_skills|desc=List of combat skills to monitor when it should go hunting again, only used if hunting_priority is set true.}}^{{Lich setting|name=training_manager_town_duration|desc=Number of minutes to limit town training to before going hunting. This works when hunting priority is true or false}}^{{Lich setting|name=mine_while_training|desc=Set to true will cause town training to start with a mining loop.}}^{{Lich setting|name=favor_goal|desc=Number of favors to work towards, if this is set will work on favors while training.}}^{{Lich setting|name=favor_god|desc=Desired immortal to request favor orb for Must be set for favor gathering to work properly.}}^{{Lich setting|name=repair_timer|desc=Time in seconds between each run of crossing-repair. Default is 10 minutes, or 600 seconds.}}^{{Lich setting|name=repair_withdrawal_amount|desc=Amount of currency to withdrawal for each repair. Default amount is 10,000.}}^{{Lich setting|name=skip_repair|desc=True/false setting. Use true to skip all crossing-repair functionality. Default is false.}}
|uservars=
|children=mining-buddy,sell-loot,hunting-buddy,crossing-training,safe-room,crossing-repair
}}

== transfer-items ==
{{Lich script
|description=Transfers all items from one container to another. It may need to be run multiple times if you have a lot of stuff. If you use an adjective you must type it completely in double quotes, e.g. "hide sack", not "h sack".
|usage=
* Transfer all items from <source> to <destination>
;transfer-items <source> <destination>
;transfer-items backpack haversack

* Transfer only items that respond to <noun> from <source> to <destination>
;transfer-items <source> <destination> <noun>
;transfer-items backpack quiver arrows
|args={{Lich setting|name=source|desc=Source container.}}^{{Lich setting|name=destination|desc=Destination container.}}^{{Lich setting|name=noun|desc=If specified, only items with this noun will be transferred.}}
|settings=
|uservars=
|children=
}}

== truffenyi-commune-quest ==
{{Lich script
|description=Runs in the background to do all actions required during the truffenyi commune quest, praying to the gods presented in the visions and dropping any food items that appear in your hands. This should be run somewhere safe, without other scripts running because they can interfere. Start after drinking the vial created from your mini altar twice.
|usage=
|args=
|settings=
|uservars=
|children=
}}

== validate ==
{{Lich script
|description=Checks character yamls for common mistakes.
|usage=
|args=
|settings=
|uservars=
|children=
}}

== walkingastro ==
{{Lich script
|description=Runs as a background script whose aim is to keep your prediction pools filling and the Astrology Skill moving.
|usage=On a 215 second timer, while not in combat (or while a series of other scripts are running), it will grab your telescope and if day observe the Sun, if night observe the Heart constellation. If your survival prediction pool fills, the script will instead align and predict against a survival skill. The aim of the script is to keep Astrology moving while you are out and about with your character, without having to rely on the ;astrology script.

Note, walkingastro will wait and not fire while the following scripts are running: 'steal', 'combat-trainer', 'pick', 'craft', 'shape', 'sew','bescort', 'remedy', 'forge', 'carve', 'performance', 'theurgy', 'hlctheurgy', 'astrology', 'astrology2', 'study-art', 'mech-lore', 'first-aid'.

Finally, this script assumes that you have a telescope (see Astrology for telescope support settings) and that Piercing Gaze is up.

It is highly recommended that you add PG to your list of in/out of combat buff spells.
|args=
|settings=
|uservars=
|children=
}}

== wand-watcher ==
{{Lich script
|description=Activates wands automatically based on cooldown timer
|usage=Best added to character autostart.

You need to be intelligent about how cooldown / count interact. If you only have 1 and the cooldown is 60 minutes, don't set a value less than 60 minutes.

* Example Settings:
<pre>
wands:
# magic wand: #Adj + Noun of the wand. Must be unique [Mandatory]
# activation message: Foo Bar #Spell activation message [Mandatory]
# activation verb: tap #Verb used to activate the wand [Optional - defaults to 'tap']
# container: backpack #Container where the wand(s) are stored [Mandatory]
# cooldown: 32 #minutes between activation attempts [Optional - defaults to 30]
# count: 2 #number of wands you have [Optional - defaults to 2]
bloodwood branch:
activation message: The world around you seems to slow as the spell grips your mind.
activation verb: tap
container: rucksack
cooldown: 32
count: 2
ironwood wand:
activation message: A glistening net of coiling tendrils interlaces itself across your muscles
activation verb: rub
container: haversack
cooldown: 34
count: 2

# Don't try to grab any wands while these scripts are running.
wand_watcher_no_use_scripts:
- burgle
- go2

# Don't try to grab any wands while in these rooms (generally anti-magic rooms), can use roomnumber, title or regex that matches the title.
wand_watcher_no_use_rooms:
- 1900 # Crossing bank teller - included with regex below but shown for example
- Knife Clan, Triage # Dokt - silenced room
- !ruby/regexp '/^(?:First )?Provincial Bank,/' # Crossing Bank - mapped, but 1 regex- -> 3 rooms
- !ruby/regexp '/Carousel (?:Booth|r)$/' # Vaults - unmapped silenced / nomagic

# Wait n seconds on startup before doing anything [Optional - defaults to 10 s]
wand_watcher_startup_delay: 10
# Wait n seconds between checks for reusing wands [Optional - defaults to 60 s]
wand_watcher_passive_delay: 60

</pre>
|args=
|settings=See example for explanation.
|uservars={{Lich setting|name=wand_watcher_timers|desc=Persistent storage for next use time for all wands.}}
|children=
}}

== weave-cloth ==
{{Lich script
|description=This script is intended to be used in [[RanikMap1|The Crossing]].
|usage=
|args=
|settings=
|uservars=
|children=
}}

== workorders ==
{{Lich script
|description=completes a workorder for the given discipline. Supplemental information: https://github.com/rpherbig/dr-scripts/wiki/Crafting-Setup
|usage=
|args={{Lich setting|name=type|desc=Type of workorder to do, blacksmithing, tailoring, shaping.}}
|settings={{Lich setting|name=crafting_container|desc=Bag that materials, tools, and books are stored in.}}^{{Lich setting|name=workorder_diff|desc=difficulty of workorder to request.}}^{{Lich setting|name=crafting_recipes|desc=List of crafting recipes in base-crafting.yaml.}}^{{Lich setting|name=forging_tools|desc=List of tools used in forging.}}^{{Lich setting|name=forging_belt|desc=Set up this has if you have a toolbelt for this craft.}}^{{Lich setting|name=forging_belt:name|desc=Unique name of belt.}}^{{Lich setting|name=forging_belt:items|desc=List of items held on the belt.}}^{{Lich setting|name=knitting_tools|desc=List of tools used in knitting.}}^{{Lich setting|name=outfitting_belt|desc=Set up this has if you have a toolbelt for this craft.}}^{{Lich setting|name=outfitting_belt:name|desc=Unique name of belt.}}^{{Lich setting|name=outfitting_belt:items|desc=List of items held on the belt.}}^{{Lich setting|name=shaping_tools|desc=List of tools used in shaping.}}^{{Lich setting|name=engineering_belt|desc=Set up this has if you have a toolbelt for this craft.}}^{{Lich setting|name=engineering_belt:name|desc=Unique name of belt.}}^{{Lich setting|name=engineering_belt:items|desc=List of items held on the belt.}}^{{Lich setting|name=carving_tools|desc=List of tools used in carving.}}^{{Lich setting|name=workorder_min_items|desc=Minimum number of items in the workorder required to accept.}}^{{Lich setting|name=workorder_max_items|desc=Maximum number of items in the workorder required to accept.}}^{{Lich setting|name=workorders_repair|desc= Whether you want to repair your crafting tools after completing workorders or not. For those with tools setup under gear, set to false in your yaml.}}
workorders_repair: true

#CARAVAN SETTINGS
# container holding caravan contracts for ;trade

|uservars=
|children=smith, shape, sew
}}

{{cat|Lich scripts}}

Lich script repository

2020-12-12T04:01:23Z

POPWEASEL:

{{RTOC}}

This page documents the collection of scripts that are available from an external repository located at [https://github.com/rpherbig/dr-scripts https://github.com/rpherbig/dr-scripts], and not through the in-game <code>;repository</code> functionality.

For script-specific documentation, see the appropriate section, below. For YAML documentation, see [https://github.com/rpherbig/dr-scripts/wiki/Introduction-to-Character-Settings Introduction-to-Character-Settings].

Also there is a newbie-friendly video guide - '''How to setup Lich: https://www.youtube.com/watch?v=Ty-seLTJSi4'''

If you have some feedback or suggestions, please contact us in-game (Sheltim or Etreu) or [https://github.com/rpherbig/dr-scripts/issues open an issue on GitHub]. We look forward to hearing from you!

= Introduction to Character Settings =
Character settings are read from a YAML file.

== What is YAML? ==
YAML is a human friendly file format that we use to store settings. It stands for YAML Ain't Markup Language (the name references itself as a kind of computer science joke). It's got a website and everything (http://yaml.org/), but there are only a few things you actually need to know:

Indentation matters. Use two spaces for each level of indentation.

If you see a line like <code>train_with_spells: true</code>, that means that the <code>train_with_spells</code> setting is being assigned a value of <code>true</code>. This may also be referred to as a hash in which <code>train_with_spells</code> is mapped to <code>true</code>. Values can be true/false, numbers, text, hashes, or lists (see below).

A list (or array) is a series of values. For example, this creates a list named <code>loot_additions</code> of item nouns that you want to loot:
<pre>
loot_additions:
- card
- dira
- bolt
- arrow
- stone
</pre>

A comment is any line that starts with a <code>#</code>. They are ignored when our scripts read your settings file. Comments are entirely for your own benefit (e.g. to leave yourself a note).

Don't worry, it'll make more sense if you go look at a YAML file. Try taking a look at [https://github.com/rpherbig/dr-scripts/tree/master/profiles some of these.]

== Loading YAML Files ==
YAML files are loaded in a predefined order. <code>base.yaml</code> is loaded first, then <code>YourCharacterName-setup.yaml</code>. If any arguments are given to a script (for example, <code>;combat-trainer BacktrainWeapons</code>), then <code>YourCharacterName-BacktrainWeapons.yaml</code> will be loaded last.

If the same setting occurs in multiple YAML files, then the last version of that setting is used. For example, you could define <code>dance_threshold</code> to be 1 in <code>YourCharacterName-setup.yaml</code> and then redefine it to be 0 in <code>YourCharacterName-BacktrainWeapons.yaml</code>.

<code>base.yaml</code> provides defaults for many (but not all) of the settings. You should never modify <code>base.yaml</code> directly; instead override settings in <code>YourCharacterName-setup.yaml</code> or <code>YourCharacterName-SomethingElse.yaml</code>. If you think something should be changed in <code>base.yaml</code>, please contact us in-game or open a [https://github.com/rpherbig/dr-scripts/pulls pull request]. We welcome all feedback and suggestions.

== Debugging YAML files ==
Its helpful to use a YAML parser for diagnosing issues.
http://yaml-online-parser.appspot.com/

= Autostart =
There are '''two''' autostart scripts.

<code>;autostart</code> is part of '''lich'''.

<code>;e autostart</code> is part of '''dependency''', a lich script, which manages the start up process for scripts documented here.

Use ''dependency'' autostart (the second one) for any script on this page. This means you should use <code>;e autostart 'scriptname'</code> or <code>;e autostart('scriptname')</code> instead of <code>;autostart add scriptname</code>

If any of the scripts on this page are in <code>;autostart list</code>, you should remove them. Try the command <code>;autostart help</code> if you need help.

== Add an autostart ==
<pre>
;e autostart('script-name') will start the script called 'script-name' for all of your characters
;e autostart 'script-name'
;e autostart('script-name', false) will start the script for only this character
;e autostart 'script-name', false
</pre>
Parenthesis do not matter
== List autostart scripts ==
<pre>
;e echo(list_autostarts) will show you the files being autostarted on a given character
;e echo list_autostarts
</pre>

== Remove an autostart ==
<pre>
;e stop_autostart('script-name') will remove an autostarted file from the list
;e stop_autostart 'script-name' parenthesis do not matter
</pre>

= Scripts =
== accept-sell ==
{{Lich script
|description=Accepts an outstanding trade offer for a pouch/bundle, appraises it and sells it. Returning coins, item, and a profit report to the owner.
|usage= Call the script when you have empty hands and an outstanding trade offer.
|args={{Lich setting|name=skip|desc=Don't appraise and send profit summary to seller, faster for multiple pouches/bundles.}}^{{Lich setting|name=buy|desc=Pay for the pouch out of your own money and keep it.}}^{{Lich setting|name=dump|desc=Dump item after sale.}}
|settings=
|uservars=
|children=
}}

== addroom ==
{{Lich script
|description=Add a series of rooms to the lich map. This script will checkout the mapdb, add the new rooms, and commit the mapdb. Automap is preferred to this script.
|usage=
To use this script send it an ordered set of directions to map. If you don't provide a direction no mapping will be provided.

For example, to add a Y branch to the north:

<code>;addroom "north, northeast, southwest, northwest, southeast, south"</code>

To add a store:

<code>;addroom "go shop, out"</code>

The travel delay defaults to 0.2.
|args={{Lich setting|name=debug|desc=Turns on debugging messages.}}
|settings=
|uservars={{Lich setting|name=add_room_debug|desc=Turns on debugging messages.}}
|children=
}}

== afk ==
{{Lich script
|description=Runs in the background to provide safety while you are afk. Basic keep alive script with simple health/spirit/death monitoring. Will exit on low health, low spirit, or death.
|usage=
|args=
|settings={{Lich setting|name=health_threshold|desc=Threshold at which you will exit (the same threshold is used for health and spirit)}}
|uservars=
|children=
}}

== almanac ==
{{Lich script
|description=Uses an almanac every 10 minutes. Pauses all other scripts, stows your left hand, studies it, then unpauses everything.
|usage=
|args=
|settings=
|uservars=
|children=
}}

== appraisal ==
{{Lich script
|description=Trains the Appraisal skill by appraising your gear, zills, bundles, gem pouches, and studying the art in the Crossing art gallery. Use the <code>appraisal_training</code> setting to specify a training regimen.
|usage=Define the <code>appraisal_training</code> list in your settings file. It will train in the order listed.
* Example Settings
<pre>appraisal_training:
- gear
- zills
- art
- bundle
- pouches
full_pouch_container: backpack
</pre>
<ul>
<li>The <code>gear</code> setting appraises everything listed in <code>gear</code> (where your armor and weapons are listed).
<li>The <code>zills</code> setting appraises zills up to 250 appraisal ranks; after that you will get a warning to remove zills from your training list.
<li>The <code>art</code> setting runs the study-art script which appraises art in the Crossing art gallery.
<li>The <code>bundle</code> setting appraises a worn bundle quick.
<li>The <code>pouches</code> setting appraises gem pouches stored in the container you list as <code>full_pouch_container</code>. Up to eleven gem pouches can be appraised. This has been updated to also appraise your worn gem pouch if <code>gem_pouch_adjective</code> is defined, making the total pouches appraised twelve.
</ul>
|args=
|settings={{Lich setting|name=appraisal_training|desc=List of training options. Valid options are <code>zills</code>, <code>pouches</code>, <code>bundle</code>, <code>gear</code>, and <code>art</code>}}^{{Lich setting|name=full_gem_pouch_container|desc=The container where you store gem pouches for appraisal. This should not be the same container where you store empty ones}}
|uservars=
|children=study-art
}}

== arrows ==
{{Lich script
|description=Creates shaft, arrowheads, and arrows all in one script.
Syntax: ;arrows type lumber tools

* Examples:
;arrows drake-fang maple
;arrows drake-fang balsa yes

|args=type, lumber, tools
|settings={{Lich setting|name=type|desc=The type of arrow you would like to make. The list is
<pre>
couger-claw
boar-tusk
sabertooth
angiswaerd
hele'la
basilisk
elsralael
soot-stained
ice-adder
jagged-horn
drake-fang
</pre>
}}^{{Lich setting|name=lumber|desc=The type of lumber you would like to use. Maple is the default lumber. You can use all the lumber types at the Society store. You can also use your own as long as you have the lumber on you.}}^{{Lich setting|name=tools|desc=This setting is storing your tools at the Society. This setting is optional.}}
|uservars={{Lich setting|name=None|desc= }}
|children=go2, shape

}}

== astrology ==
{{Lich script
|description=Trains astrology via by observing a known constellation which fills the most prediction pools and performing predictions aligned to those pools. If your character is above 99th circle the script can also walk the ways to train astrology. Walking is limited to one round-trip per hour.
|usage=Start in any room where the heavens are observable or where moongate can be cast (if astral traveling).
* Example Settings:
<pre>
astrology_training:
- ways
- observe
- rtr
- weather
- events
- moons
astral_plane_training:
train_destination: crossing
train_source: shard

have_telescope: true
#Choose one, container or tie
telescope_storage:
container:
tie:

#Choose one, container, tied, or worn
divination_tool:
name:
container:
tied:
worn:

#Choose one, container or tied
divination_bones_storage:
container:
tied:

NOTE: DO NOT INCLUDE THE STUFF UNDER divination_tool or divination_bones_storage IF NOT USING!!

EXAMPLE YAML IF NOT USING:
divination_tool:
divination_bones_storage:

</pre>
|args=
|settings={{Lich setting|name=astrology_training|desc=A list of training options. The possible options are ways, observe, rtr, weather, events, and moons. Things will be trained in the order they are listed}}^{{Lich setting|name=have_telescope|desc=Set to true to indicate you have a telescope on you and it will be used to observe the heavens.}}^{{Lich setting|name=astral_plane_training|desc=Hash which contains the settings for astral training.}}^{{Lich setting|name=train_destination|desc=indicate the shard destination in lowercase(this is a town, not the shard name). This is where you will walk to for training. Options are: shard, crossing, leth, riverhaven, merkresh, fang, raven, throne, muspari, aesry, taisgath, theren, steppes}}^{{Lich setting|name=train_source|desc=indicates the shard you wish to return to after arriving at the destination shard, options are the same as in <code>train_destination</code>.}}
|uservars={{Lich setting|name=astral_plane_exp_timer|desc=This is set to the current time on your computer once you emerge from the shard indicated in <code>train_destination</code>. It's used to check how long its been since you last walked.}}
|children=bescort
}}

== athletics ==
{{Lich script
|description=Athletics training script
|args={{Lich setting|name=wyvern|desc=Climb wyverns instead of undergondola.}}^{{Lich setting|name=undergondola|desc=Climb undergondola.}}^{{Lich setting|name=xalas|desc=Climb in xalas}}
|settings={{Lich setting|name=have_climbing_rope|desc=Set this to true to use a magic climbing rope for training. This currently requires zills.}}^{{Lich setting|name=held_athletics_items|desc=A list of 1-2 items held while doing athletics to increase the difficulty. Each item adds difficulty. Uses get/stow, and the items don't need to be weapons.}}
}}

== attunement ==
{{Lich script
|description=Trains attunement via power walking or in perceiving in a single room. Power walking rooms are based on your hometown setting unless the <code>attunement_rooms</code> setting is filled out. Moon mages will not powerwalk, but use perceive mana instead. This script will cast spells listed in the <code>waggle_set</code> called 'attunement' when it starts.
|settings={{Lich setting|name=attunement_rooms|desc=A list of room id's to use for power walking. This is useful for power walking near your safe room, in non-justice areas (necromancers), or if your <code>hometown</code> does not have power walking room data.}}^{{Lich setting|name=crossing_training_stationary_skills_only|desc=Set to true to only train attunement in your current room. This setting does nothing for moon mages.}}^{{Lich setting|name=hometown|desc=Town to train attunement in; most towns have a pre-defined list of rooms to power walk in. Using <code>attunement_rooms</code> overrides this.}}^{{Lich setting|name=attunement_target_increment|desc=The desired number of mind states to increase by. Respects crossing_training_max_threshold as an upper threshold.}}
}}

== autocontingency ==
{{Lich script
|description=Moon Mages only. It can be run two different ways. First, by providing two arguments for a contingency target (anchor), and the room number that anchor will be in. Your character will run to the room in question, and cast both SEER and Contingency on the anchor. i.e. <code>autocontingency Eteu 798</code>. Contingency established, you can then go about your business.

The other method is <code>autocontingency invoke</code>. When run in this manner, typically after a hunt or a long athletics trip to the far side of Elanthia, the script will invoke the Contingency to bring you back to your point of origin.
|usage= Ensure that a waggle titled `contingency` is present in your YAML. Example below:
contingency:
Seer's Sense:
abbrev: SEER
recast: 2
mana: 15
cambrinth:
- 5
- 5
Contingency:
abbrev: CONTINGENCY
recast: 1
mana: 15
cambrinth:
- 7
- 7

The waggle does not have to include both spell entries, but SEER should only not be included if you are casting that by hand (or in another script) on your anchor target before the Contingency cast. Best practice, include both.

Example YAML usage for including autocontingency as a <code>before</code> in a hunt:
hunting_info:
- :zone:
- rats
- rats
- rats
:duration: 30
args:
- d0
- combat
before:
- go2 798
- autocontingency Etreu
after:
- autocontingency invoke
stop_on:
- Large Blunt
- Large Edged
- Small Edged
- Staves

Example YAML usage for including autocontingency as part of T2's <code>training_list</code>:
training_list:
- skill:
- Targeted Magic
start: 4
scripts:
- autocontingency Etreu 798
- buff main
- hunting-buddy
- autocontingency invoke
- safe-room
}}

== automap ==
{{Lich script
|description=Mapping assistance script
|usage=Start from an already mapped room. Records the commands you type to move around and maps new rooms as it encounters them. Will update existing paths if traveling through previously mapped areas. Run the script to start recording, then kill it when finished. Do not use your typeahead lines when this is running or you will damage the map.
|args=
|settings=
|uservars=
|children=
}}

== avtalia ==
{{Lich script
|description=Traders only. When run, it watches cambrinth defined in avtalia_array:. It maintains a running list of how much mana is in those cambrinth and allows it to be pulled by scripts like combat-trainer when mana is low.
|usage= Define a list of cambrinth as below:
avtalia_array:
- name: cambrinth bracer
cap: 32
- name: watersilk bag
cap: 108
- name: cambrinth anklet
cap: 12
- name: tattered robe
cap: 50
- name: cambrinth chains
cap: 50

Each entry must be unique, all cambrinth must be worn, you must have sufficient Arcana to charge and invoke accurately while worn, and you must not use your primary casting cambrinth you use for other spells.
|args=
|settings=avtalia_array: defines the array of worn cambrinth.
|uservars=avtalia
|children=
}}

== bankbot ==
{{Lich script
|description=Have a character act as a banker
}}

== bescort ==
{{Lich script
|description=A script for navigating certain problematic areas like swamp mazes, the wilds, and some river swims. Mostly used by other scripts. Can also be used for astral traveling.
|usage= Start this script with no arguments to see a list of supported areas and destinations.
|args=
|settings=
|uservars= ''citizenship'': Set citizenship to 'Zoluren' to skip a money check. Set to 'Ilithi' to use the north, west, south gates of Shard
|children=
}}

== buff ==
{{Lich script
|description=Casts waggle sets defined in your yaml. Casts the default: waggle set if no args are given.
|usage=
|args=
|settings=
|uservars=
|children=
}}

https://github.com/rpherbig/dr-scripts/wiki/Waggle-Sets

== burgle ==
{{Lich script
|description=[[Breaking and Entering]] - Used to train Thievery, Stealth, and depending on entry method, 1 of Athletics (rope) / Locksmithing(lockpick). '''Extremely high fines if you are caught. Be sure to read the [[Breaking and Entering]] page to understand how the system works prior to using this script.'''
|usage=Script can be started anywhere that can path the room you set in the settings.
* Example Settings:
<pre>
# Turn on Burgle inside crossing_training. Attempts to use ;burgle during Athletics, Locksmithing, Thievery, or Stealth
# Uses burgle_settings for entry method then continues to alternate methods such as climbing, picking shop stealing, etc.
train_with_burgle: true

#Plead guilty for lower fines if caught in normal justice.
guilty_plea: guilty

burgle_settings:
room: nnn # pick your own room, you should pick a room that no guard will ''ever'' enter. Picking rooms guards can come to is a failure on setup, not the script.
entry_type: lockpick # lockpick | rope | cycle | prioritylockpick | priorityrope
max_priority_mindstate: 26 # only used if priority setting for entry_type is used. Sets max midstate value before switchover to other entry_method. Default: 26
use_lockpick_ring: true # if you use a worn lockpick stacker
lockpick_container: lockpick ring # name of your lockpick stacker
max_search_count: 2 # max number of total searches to do including retries
retry: false # retry if you don't find loot. default: false
loot: keep # drop | keep | bin | pawn default: keep
loot_container: duffel bag # container to keep loot in while burglering
safe_mode: true # stop searching and try to get out as quickly as possible when hearing footsteps. Default: true
room_blacklist: # array of rooms to ignore. Case sensitive.
item_whitelist: # array of full item names (adj + noun) of items to keep no matter what. Case Sensitive.
item_whitelist: # array of **full item names** (adj + noun) of items to keep no matter what. Case Sensitive. Default: empty list
- blunt-tipped arrows # armory - non-lodging ammo
- blunt-tipped bolts # armory - non-lodging ammo
- blunt stones # armory - non-lodging ammo
- keepsake box # bedroom - limited use (35) locksmithing trainer
# - mixing bowl # kitchen - alchemy tool: 12/12 MC. 11/18 durability, 5/11 speed
# - mixing stick # kitchen - alchemy tool: 12/12 MC. 11/18 durability, 5/11 speed
# - rustic mortar # kitchen - alchemy tool: 12/12 MC. 11/18 durability, 5/11 speed
# - rustic pestle # kitchen - alchemy tool: 12/12 MC. 11/18 durability, 5/11 speed
# - mesh sieve # kitchen - alchemy tool: 12/12 MC. 11/18 durability, 5/11 speed
# - butcher's knife # kitchen - wrist worn 'belt' knife
- worn book # library - scroll stacker (15 page, 10 copies per page)
# - contract case # library - Trader Jewelry
# - dainty cowbell # library - wrist worn weatherproof instrument
# - writing quill # library - writing instrument (ledgers, etc)
# - thumb ring # library - Trader Jewelry
# - glass lens # sanctum - minion identifier
# - letter opener # sanctum - belt worn belt knife
- memory orb # sanctum - random skill absorber
# - crystal prism # sanctum - divination tool
# - celestial charts # sanctum - divination tool
# - tool case # work room - belt worn lockspick stacker - 25 ct
# - stirring rod # work room - forging tool: 12/12 MC. 11/18 durability, 5/11 speed
# - carving knife # work room - shaping tool: 12/12 MC. 11/18 durability, 5/11 speed
# - wood shaper # work room - shaping tool: 12/12 MC. 11/18 durability, 5/11 speed
# - metal rasp # work room - shaping/carving tool: 12/12 MC. 11/18 durability, 5/11 speed
# - imbuement rod # work room - enchanting tool
# - !ruby/regexp '/\S+ fabric/' # Bedroom - illustrates REGEX syntax for items
before: # array of scripts to run, similar to hunting-buddy, before the burgle (will be called right before buffing)
- yourscripthere with args here
after: # array of scripts to run, similar to hunting-buddy, after the burgle, (will be called right before script ends)
- anotherscript here
waggle_sets:
burgle:
- Plunder
- Slight
- Sight
- Silence
</pre>
|args={{Lich setting|name=start|desc=Required to run the script. Protects against accidental starting/typos.}}^{{Lich setting|name=entry|desc=Optional. Override yaml setting for entry_type. Valid options are: lockpick, rope, cycle, prioritylockpick, priorityrope.}}^{{Lich setting|name=roomid|desc=Optional. Override yaml setting for room to burgle from.}}^{{Lich setting|name=loot_type|desc=Optional. Override yaml setting what to do with loot. Items in your item_whitelist are always kept. Valid options: drop, keep, pawn bin.}}^{{Lich setting|name=hometown|desc=Optional. Override yaml hometown setting when using pawn or bin options.}}^{{Lich setting|name=follow|desc=Optional. Puts brugle into group follow mode. To be used when you've already joined someone to do a group burglary. This will buff, then hide if needed and then wait for the leader to burgle. Will attempt to leave the group if you are following once in, to prevent getting lost.}}
|settings={{Lich setting|name=burgle_settings|desc=Hash of all the burgle settings}}^{{Lich setting|name=burgle_settings:room|desc=The Room id that burgle should be done in. Guards should never come to this room, so pick carefully}}^{{Lich setting|name=burgle_settings:entry_type|desc=The type of entry - <code>rope</code> or <code>priorityrope</code> or <code>lockpick</code> or <code>prioritylockpick</code> or <code>cycle</code> You must have a heavy rope if using <code>rope</code> or <code>cycle</code>. You must have a lockpick, or a worn lockpick stacker with lockpicks on it if using <code>lockpick</code> or <code>cycle</code>. You must have both if you are using the <code>prioritylockpick</code> or <code>priorityrope</code> settings. the priority settings will use that entry method unless your mindstate is above the max value.}}^{{Lich setting|name=burgle_settings:max_priority_mindstate|desc=Tha maximum mindstate to use when using one of the priority entry settings, before switching to the other entry method.}}^{{Lich setting|name=burgle_settings:use_lockpick_ring|desc=<code>true</code> or <code>false</code>Check for a lockpick ring/stacker if using lockpick as entry_type. <code>true</code> or <code>false</code>}}^{{Lich setting|name=burgle_settings:lockpick_container|desc=The name of your lockpick ring/stacker.}}^{{Lich setting|name=burgle_settings:max_search_count|desc=Limits the number of searches you do. Setting this too high will result in arrest, and large fine. Start low and increase as needed.)}}^{{Lich setting|name=burgle_settings:retry|desc=Retry searches if you don't find loot. <code>true</code> or <code>false</code>}}^{{Lich setting|name=burgle_settings:loot|desc=What to do with loot. Supported options: <code>drop</code>, <code>keep</code>, <code>pawn</code>, <code>bin</code>. Note that you will always attempt to store loot while in the house, to avoid problems inside with items with custom drop scripts. <code>bin</code> is only supported for thieves.}}^{{Lich setting|name=burgle_settings:loot_container|desc=Where to put loot while in the house. This is required as the script will not attempt to drop loot in the house.}}^{{Lich setting|name=burgle_settings:safe_mode|desc=Stop searching and try to get out as quickly as possible when hearing footsteps. <code>true</code> or <code>false</code>}}^{{Lich setting|name=burgle_settings:room_blacklist|desc=List of room types (using Sentence Case) that you don't want to search for loot in.}}^{{Lich setting|name=burgle_settings:item_whitelist|desc=List of full item names (adj + noun) that you want to keep regardless of any other setting.}}^{{Lich setting|name=burgle_settings:before|desc=List of scripts you want to run before burglary. This is run right before the waggle set.}}^{{Lich setting|name=burgle_settings:after|desc=List of scripts you want to run after burglary. This is run right after the burglary before processing the loot.}}^{{Lich setting|name=waggle_sets['burgle']|desc=Optional. A waggle set called 'burgle' to cast right before burglary.}}
|children=jail-buddy
}}

== carve ==
{{Lich script
|description=
|usage=
|args=
|settings=
|uservars=
|children=
}}

== charge-holy-weapon ==
{{Lich script
|description= Charges holy weapon if below 200 estimated remaining uses. Usable in Crossing or Shard Chadatru temples, or in a player-specified room using a holy icon. There is a large cooldown, and if too low circle & charisma, this could be bad. Best used independently on lower circle Paladins.
|usage= Run it as a before or after within training manager, as a normal part of T2's system, or as an independent script.
|settings={{Lich setting|name=holy_weapon|desc=Main setting which holds the other settings.}}^{{Lich setting|name=holy_weapon:weapon_name|desc=Name of the holy weapon, MUST match gear setting entry exactly.}}^{{Lich setting|name=holy_weapon:icon_name|desc=Name of the icon to use for the ritual.}}^{{Lich setting|name=holy_weapon:icon_container|desc=Name of the container which holds the icon, optional.}}^{{Lich setting|name=holy_weapon:icon_room|desc=Room number to use for the icon ritual.}}
}}

== chop-wood ==
{{Lich script
|description= Chops trees in a room while watching for danger
|usage= Watches and chops out your current room, stowing or deeding anything in your tree list. Will run to a healer if injured.
|args=
|settings={{Lich setting|name=holy_weapon|desc=Holds all the holy weapon settings.}}^{{Lich setting|name=weapon_name|desc=name of holy weapon, MUST match weapon in gear, <adj> <noun>}}^{{Lich setting|name=icon_name|desc=Name of the icon to use}}^{{Lich setting|name=icon_container|desc=Container which holds the icon (optional)}}^{{Lich setting|name=icon_room|desc=Room to do the icon ritual.}}
}}

== circlecheck ==
{{Lich script
|description=Circle check tells you how far you are from your next or target circle.
|usage=
Display circle progress:
* <code>;circlecheck</code>

Display only skills needed for the next circle:
* <code>;circlecheck short</code>
* <code>;circlecheck brief</code>
* <code>;circlecheck next</code>

Display progress towards circle 35
* <code>;circlecheck 35</code>
|args={{Lich setting|name=debug|desc=Turns on debugging messages.}}^{{Lich setting|name=short|desc=Uses short output mode, aliases brief, next}}^{{Lich setting|name=target|desc=Display progress towards target circle.}}
|settings=
|uservars=
|children=
}}

== cleric-quests ==
{{Lich script
|description=Automatically does cleric quests you are eligible for. Currently does tamsine, eluned, eluned2, kertigen, hodiera, meraud, and glythtide commune quests if you are the right level.
|usage=
|args=
|settings=
|uservars=
|children=
}}

== coordinator ==
{{Lich script
|description=Training manager script
|usage=
|args=
|settings=
|uservars=
|children=
}}

== combat-trainer ==
{{Lich script
|description= Train combat skills in your current room.
|usage= Trains combat skills in your current room, maintains listed buffs, uses TM/debil as specified, trains certain non combat actions on timers. Skins, loots.
|args={{Lich setting|name=d#|desc=Dance threshold, keep N mobs alive to train defenses against, where dN is the provided argument.}}^{{Lich setting|name=r#|desc=Retreat threshold, stay at missile range when N mobs are present and use ranged combat options, where rN is the provided argument.}}^{{Lich setting|name=construct|desc=overrides empath non attack settings.}}^{{Lich setting|name=debug|desc=Enables debug mode.}}^{{Lich setting|name=custom|desc= Extra arguments will be used to load in extra yaml files. <code>;combat-trainer back</code> would load in <code>YourName-back.yaml</code>.}}
|settings={{Lich setting|name=aiming_trainables|desc=Lets you train weapons in the offhand while aiming crossbows, slings, and bows. The weapon must be usable in the offhand for attacking/throwing, swappables are supported. Large weapons require weapons prime, and other conditions need to be met, etc. It works in conjunction with the settings attack_overrides (hurl/invoke supported) and using_light_crossbow.}}^{{Lich setting|name=using_light_crossbow|desc=Lets you designate that your Crossbow is light, this enables swinging attack options with aiming_trainables.}}^{{Lich setting|name=storage_containers|desc=List of containers to make sure are open before starting hunting.}}^{{Lich setting|name=dance_threshold|desc=Same as d# argument.}}^{{Lich setting|name=retreat_threshold|desc=Same as r# argument.}}^{{Lich setting|name=dance_skill|desc=Weapon skill to have active when dancing with enemies, ideally allows parry. Note this is the SKILL not the weapon.}}^{{Lich setting|name=combat_trainer_action_count|desc=Number of attacks to make with a given weapon before cycling.}}^{{Lich setting|name=combat_trainer_target_increment|desc=Number of mind states of exp to get before cycling weapons.}}^{{Lich setting|name=weapon_training|desc=Hash of weapon skills to the weapon names that you use to train that skill. Brawling should map to an empty string. This controls what weapons are cycled through for training.}}^{{Lich setting|name=gear|desc=List of gear that will be used in this script. Armor and Weapons.}}^{{Lich setting|name=gear:name|desc=Noun of the item.}}^{{Lich setting|name=gear:is_leather|desc=true if this is repaired at the leather repair npcs.}}^{{Lich setting|name=gear:hinders_lockpicking|desc=true if should be removed for lockpicking.}}^{{Lich setting|name=gear:skip_repair|desc=true if you want to skip repairing this item.}}^{{Lich setting|name=gear:is_worn|desc=true if the item is worn such as armor, shields, wearable weapons.}}^{{Lich setting|name=gear:swappable|desc=true if this is a swappable weapon.}}^{{Lich setting|name=gear:tie_to|desc=This is the name of what this weapon is tied to, e.g toolstrap.}}^{{Lich setting|name=gear:adjective|desc=Used to differentiate items with the same name, if TAP ADJECTIVE NAME doesn't work then these settings are wrong.}}^{{Lich setting|name=gear:bound|desc=true if the item bonded for hurl/invoke.}}^{{Lich setting|name=gear_sets:standard|desc=A list of ADJ NAME for each item that should show up in INV COMBAT when you're ready for combat. If it shows up in inv combat it must be here. This gear set will be equipped at the start of combat.}}^{{Lich setting|name=summoned_weapons|desc=List of summoned weapons/moonblades.}}^{{Lich setting|name=summoned_weapons:name|desc=The skill to make a summoned weapon for.}}^{{Lich setting|name=summoned_weapons:turn|desc= true to turn the summoned weapon}}^{{Lich setting|name=summoned_weapons:pull|desc=true to pull the summoned weapon}}^{{Lich setting|name=summoned_weapons:push|desc=true to pull the summoned weapon.}}^{{Lich setting|name=summoned_weapons_element|desc=Element to summon your weapon as, defaults to stone.}}^{{Lich setting|name=summoned_weapons_ingot|desc=noun of ingot to use for rare metal summoning.}}^{{Lich setting|name=stances|desc=Used to override defense selection for a given weapon skill, normally used to prevent parrying with ranged weapons or offhand. See base.yaml for usage.}}^{{Lich setting|name=use_stealth_attacks|desc=true to attempt to hide before attacking to use ambush/poach while stealth skill is not mindlocked. This will also attempt to hide before casting Vivisection.}}^{{Lich setting|name=ambush|desc=true to use stealth attacks to train backstab. Should only use either ambush or backstab flags at one time}}^{{Lich setting|name=ambush_location|desc=Set the ambush target for better backstab training for thieves.}}^{{Lich setting|name=backstab|desc=Valid settings are 'Small Edged', 'Offhand Weapon' or both. This will attack with either backstab or backstab left for the chosen skill. Ensure you have a suitable weapon for backstabbing setup in your 'weapon_training:' section for the desired weapon skill(s). This defaults to ambush if the mob can't be backstabbed.}}^{{Lich setting|name=charged_maneuvers|desc=Hash of charged maneuvers to use for each weapon skill.}}^{{Lich setting|name=fatigue_regen_threshold|desc=Will use bob instead of an attack when fatigue drops below this.}}^{{Lich setting|name=aim_fillers|desc=list of actions to take to fill time while aiming.}}^{{Lich setting|name=aim_fillers_stealth|desc=Used in place of aim fillers if stealth experience is not capped.}}^{{Lich setting|name=dance_actions|desc=List of actions to take while dancing with enemies.}}^{{Lich setting|name=dance_actions_stealth|desc=Used in place of dance actions while stealth is not capped.}}^{{Lich setting|name=ignored_npcs|desc=List of npc names to ignore, used to keep combat from trying to count/interact with pets, familiars, and roaming npcs. This is the single noun that identifies them, bear, warrior, Brokk. Currently caps sensitive.}}^{{Lich setting|name=stance_override|desc=remove custom stance logic and simply set stance to provided string. E.g. 100 80 0}}^{{Lich setting|name=skinning|desc=Hash of skinning related settings.}}^{{Lich setting|name=skinning:skin|desc=true to skin kills.}}^{{Lich setting|name=skinning:arrange_all|desc=true if you can use the arrange ALL command.}}^{{Lich setting|name=skinning:arrange_count|desc=Number of times to arrange}}^{{Lich setting|name=skinning:arrange_types|desc=Hash of creature noun to the type of arranging to do, eg rat:part. All arranging defaults to skin.}}^{{Lich setting|name=skinning:tie_bundle|desc=true to tie your bundles up to reduce weight and item count.}}^{{Lich setting|name=lootables|desc=Base list of nouns to loot, the noun must be at the end of the object name and not part of another word. Changes to this are better made through loot_additions and loot_subtractions. Pearl would loot "a tiny yellow pearl" but not "a pearl studded coat" nor would rock cause you to loot "a large crock".}}^{{Lich setting|name=loot_additions|desc=List of nouns to add into the base loot list, a common example is box nouns.}}^{{Lich setting|name=loot_subtractions|desc=List of things to remove from your looting list, for example ammunition you don't use.}}^{{Lich setting|name=thanatology|desc=Necromancer related settings, only partially implemented.}}^{{Lich setting|name=thanatology:heal|desc=If true, use necromancer-specific healing rituals and spells.}}^{{Lich setting|name=thanatology:ritual_type|desc=Name of the ritual to perform, i.e dissect}}^{{Lich setting|name=spare_gem_pouch_container|desc=Container that holds your spare gem pouch should your equipped one become full.}}^{{Lich setting|name=gem_pouch_adjective|desc=Adjective your gem pouch responds too.}}^{{Lich setting|name=buff_spells|desc=Hash of buff spells to maintain on you while hunting, the key to the hash must match the spells name exactly e.g buff_spells:See the Wind. Will generally cast buffs in the order listed here.}}^{{Lich setting|name=buff_spells:Spell Name:abbrev|desc=Abbreviation to use for prepping the spell.}}^{{Lich setting|name=buff_spells:Spell Name:recast|desc=Remaining duration in minutes on a buff to trigger a recasting. -1 will wait until the spell falls off.}}^{{Lich setting|name=buff_spells:Spell Name:recast_every|desc=Number of seconds to wait between recasts of this spell, for spells that recast or expire messages don't make sense.}}^{{Lich setting|name=buff_spells:Spell Name:expire|desc=A string that when seen will trigger this spell to be recast}}^{{Lich setting|name=buff_spells:Spell Name:mana|desc=Amount of mana to prep the spell with.}}^{{Lich setting|name=buff_spells:Spell Name:cambrinth|desc=List of charges to put into cambrinth, will use worn cambrinth that can't be charged worn, however don't list more than two charges or strange things can happen.}}^{{Lich setting|name=buff_spells:Spell Name:prep_time|desc=Time in seconds to wait before trying to cast the spell, optional, if not present waits until full prep.}}^{{Lich setting|name=buff_spells:Spell Name:before|desc=A custom action to take immediately before casting the spell.}}^{{Lich setting|name=buff_spells:Spell Name:before:message|desc=The message to send to the game.}}^{{Lich setting|name=buff_spells:Spell Name:before:matches|desc=List of strings that are possible responses for the message.}}^{{Lich setting|name=buff_spells:Spell Name:after|desc=A custom action to take immediately after casting the spell.}}^{{Lich setting|name=buff_spells:Spell Name:after:message|desc=The message to send to the game.}}^{{Lich setting|name=buff_spells:Spell Name:after:matches|desc=List of strings that are possible responses for the message.}}^{{Lich setting|name=buff_spells:Spell Name:moon|desc=true if spell requires a moon to cast.}}^{{Lich setting|name=buff_nonspells|desc=Nonspell buffs. Each has the format "action: timer", where 'action' will be output to the game every 'timer' number seconds.}}^{{Lich setting|name=buff_nonspells:barb_buffs|desc=Specific subsection for barbarian buffs. These require no timer, instead they trigger off of expiration and activation messaging. List by buff name, i.e. "Python", capitalization required.}}^{{Lich setting|name=buff_nonspells:khri|desc=Specfic sub section for Thief Khri. These require no timer. List skill by name. Capitalization not required.}}^{{Lich setting|name=offensive_spells|desc=TM and Debil spells to use. Debil spells will be recast when a mob dies or the expiration message is seen.}}^{{Lich setting|name=offensive_spells:skill|desc=Targeted Magic or Debilitation.}}^{{Lich setting|name=offensive_spells:abbrev|desc=Abbreviation used for preparing the spell.}}^{{Lich setting|name=offensive_spells:recast_every|desc=Number of seconds to wait between recasts of this spell, for spells that recast or expire messages don't make sense.}}^{{Lich setting|name=offensive_spells:expire|desc=String that will trigger a recast of the spell when seen.}}^{{Lich setting|name=offensive_spells:mana|desc=Amount of mana to prep the spell with}}^{{Lich setting|name=offensive_spells:cambrinth|desc=List of charges to put into cambrinth, will use worn cambrinth that can't be charged worn, however don't list more than two charges or strange things can happen.}}^{{Lich setting|name=offensive_spells:prep_time|desc=Time in seconds to wait before trying to cast the spell, optional, if not present waits until full prep.}}^{{Lich setting|name=offensive_spells:before|desc=A custom action to take immediately before casting the spell.}}^{{Lich setting|name=offensive_spells:before:message|desc=The message to send to the game.}}^{{Lich setting|name=offensive_spells:before:matches|desc=List of strings that are possible responses for the message.}}^{{Lich setting|name=offensive_spells:after|desc=A custom action to take immediately after casting the spell.}}^{{Lich setting|name=offensive_spells:after:message|desc=The message to send to the game.}}^{{Lich setting|name=offensive_spells:after:matches|desc=List of strings that are possible responses for the message.}}^{{Lich setting|name=offensive_spells:tattoo_tm|desc=Will tell the system to target the invoked tattoo spell, if it's Targeted Magic.}}^{{Lich setting|name=cambrinth|desc=Cambrinth item to charge for casting.}}^{{Lich setting|name=cast_messages|desc=Casting messages, if we're missing your custom message let us know!}}^{{Lich setting|name=prep_messages|desc=Spell Prep messages, see cast_messages.}}^{{Lich setting|name=empath_healing|desc=a VH entry here will control the mana used when vit drops. List of values is prep followed by cambrinth charges.}}^{{Lich setting|name=osrel_amount|desc=Amount to infuse into OM each try.}}^{{Lich setting|name=osrel_no_harness|desc=true if you don't need to harness before infusing.}}^{{Lich setting|name=kneel_khri|desc=true if you have to kneel to activate khri.}}^{{Lich setting|name=khri_preps|desc=Khri activation messages, let us know if yours is missing.}}^{{Lich setting|name=manipulate_threshold|desc=Number of enemies before attempting to manipulate.}}^{{Lich setting|name=training_abilities|desc=Special one off trainers during combat. Hash is training type keyed to cooldown in seconds.}}^{{Lich setting|name=training_abilities:PercMana|desc=Moon mage attunement training, retreats first.}}^{{Lich setting|name=training_abilities:Perc|desc=Attunement training with perc.}}^{{Lich setting|name=training_abilities:Perc Health|desc=Empathy training with perc heal.}}^{{Lich setting|name=training_abilities:Astro|desc=Predict weather for astrology training.}}^{{Lich setting|name=training_abilities:App|desc=Train appraisal by appraising enemies. Requires Approx 100 ranks for learning.}}^{{Lich setting|name=training_abilities:App Quick|desc=See above.}}^{{Lich setting|name=training_abilities:App Careful|desc=See above.}}^{{Lich setting|name=training_abilities:Locks|desc=Train locksmithing by picking pet boxes in combat.}}^{{Lich setting|name=training_abilities:Tactics|desc=Train tactics with weave, bob, and circle.}}^{{Lich setting|name=training_abilities:Analyze|desc=Train tactics by analyzing your opponent.}}^{{Lich setting|name=training_abilities:Hunt|desc=Train perception and possibly scouting with the hunt command.}}^{{Lich setting|name=training_abilities:Pray|desc=Pray to an immortal for theurgy.}}^{{Lich setting|name=training_abilities:Meraud|desc=Maintains the Meraud Commune.}}^{{Lich setting|name=training_abilities:Scream|desc=Train bardic lore with scream conc.}}^{{Lich setting|name=training_abilities:Stealth|desc=Train stealth with hiding and stalking.}}^{{Lich setting|name=training_abilities:Ret Stealth|desc=Retreat before stealth with hiding and stalking.}}^{{Lich setting|name=training_abilities:Teach|desc=Teach hunting_buddies if there are any in the room on this timer.}}^{{Lich setting|name=training_abilities:Recall|desc=Uses 'recall' on a mob in the room, which trains Scholarship}}^{{Lich setting|name=training_abilities:Ambush Stun|desc=Uses settings stun_weapon, stun_weapon_skill and stun_skill}}^{{Lich setting|name=stun_weapon|desc=The weapon you want to use to Ambush Stun. IE club or broadsword}}^{{Lich setting|name=stun_weapon_skill|desc=The skill that stun_weapon trains or you would like to swap it to train IE Small Blunt or Large Edged}}^{{Lich setting|name=stun_skill|desc=Set to either Backstab or Debilitation for the skill to watch while using Ambush Stun}}^{{Lich setting|name=training_abilities:Khri Prowess|desc=Trains Debilitation with Khri Prowess.}}^{{Lich setting|name=fatigue_regen_action|desc=Action to take when low on fatigue.}}^{{Lich setting|name=dual_load|desc=true if you're capable of dual load}}^{{Lich setting|name=dedicated_camb_use|desc=Set to 'cyclic' or 'spell' with respect to the magical feat}}^{{Lich setting|name=cycle_armors|desc=List of armor types and corresponding items from gear to rotate for training purposes}}^{{Lich setting|name=whirlwind_trainables|desc=Barb specific section for telling the combat-trainer which weapon skills you want to train with whirlwind. It requires one-handed templates, doesn't support two handed weapons, and will use the weapon listed under weapon_training.}}^{{Lich setting|name=barb_famine_healing|desc=Barb specific section for automatic usage of Berserk Famine when low health. Has two settings listed below as well as knowledge of Berserk Famine as requirements.}}^{{Lich setting|name=barb_famine_healing:health_threshold:|desc=Famine will be used when below this threshold.}}^{{Lich setting|name=barb_famine_healing:inner_fire_threshold|desc=Will not use Berserk Famine unless above this threshold.}}^{{Lich setting|name=wield|desc=Set to true or false; If true, then it wields and sheaths your weapon. This is very useful if you have weapons in different containers. With this set to true on each weapon (e.g. :wield: true in your gear settings), it will return them back from where they came with the wield and sheath commands.}}^{{Lich setting|name=hide_type|desc=Value of "stalk" changes hide type to "slip stalk". This will perform the command "stalk" instead of "hide" which activates "slip stalk". "Slip stalk" is only available for a number of professions and must be learned. Default value: hide. Uses hide as normal.}}^{{Lich setting|name=force_unhide|desc=Value of true will always unhide after hiding via Stealth timer under training_abilities:.}}^{{Lich setting|name=dont_stalk|desc=Value of true prevents stalk usage after hiding when hiding via Stealth timer under training_abilities:. Default value is false.}}
|uservars={{Lich setting|name=combat_trainer_debug|desc=Turns on debugging messages.}}
|children=tendme
}}

== corn-maze ==
{{Lich script
|description=Runs the Hollow Eve corn maze.
|usage=Run inside the large-form corn maze, anywhere in the starting 'labyrinth' or entrance area. This does NOT work with the short/single-task versions. The script will finish any pre-existing corn-maze task, then search the maze for incidental loot. Make sure to allow ten minutes between runs for the loot to respawn.
|args={{Lich setting|name=noloot|desc=Run as normal, but only pick up free corn maze passes from the incidentals.}}^{{Lich setting|name=restart|desc=Run as normal, but skip incidental looting entirely. Useful if you already looted this run and needed to restart the script for some reason.}}^{{Lich setting|name=manual|desc=Replaces loot-corn-maze.lic. Control your run manually. Pick up and complete tasks on your own. This will sit in the background, and search and loot any incidental objects you come across automatically.}}^{{Lich setting|name=short|desc=Runs the fast 10-task challenge for the harried Halfling.}}
|settings={{Lich setting|name=maze_junk|desc=What to throw away during incidental looting. See defaults in base.yaml, and copy to your setup yaml to change them. }}^{{Lich setting|name=cornmaze_containers|desc=A list of bags to try and put incidental loot into, top ones first. If all of them are full it'll try and STOW the item, and if that fails it'll drop it. By default, no bags listed.

cornmaze_containers:
- backpack
- rucksack
- satchel
}}
}}

== craft ==
{{Lich script
|description=Crafts one item.
|args={{Lich setting|name=outfitting|desc=Knit.}}^{{Lich setting|name=forging|desc=Forge a Blacksmithing item.}}^{{Lich setting|name=engineering|desc=Shape one item.}}
|settings={{Lich setting|name=yarn_quantity|desc=How much yarn to keep on hand for knitting, defaults to 100.}}^{{Lich setting|name=craft_max_mindstate|desc=What mindstate to make running the script a noop. Defaults to 31}}
}}

== crossing-repair ==
{{Lich script
|description=Repair items in your gear list.
|usage=Originally intended to be used in [[RanikMap1|The Crossing]]. The script now works outside [[RanikMap1|The Crossing]] with hometown set to: [[RanikMap30|Riverhaven]], [[RanikMap42|Therenborough]], [[RanikMap67|Shard]], [[RanikMap99|Aesry]], [[RanikMap107|Mer'Kresh]], [[RanikMap117|Hibarnhvidar]], [[RanikMap121|Boar Clan]], [[RanikMap150|Fang Cove]], [[RanikMap47|Muspar'i]], [[RanikMap106|Hara'jaal]], [[RanikMap61|Leth Deriel]], [[RanikMap34a|Rossman's Landing]], [[RanikMap40|Langenfirth]], or [[RanikMap90|Ratha]]
|args=
|settings={{Lich setting|name=repair_withdrawal_amount|desc=Amount in coppers to withdraw to cover repairs.}}^{{Lich setting|name=gear|desc=List of gear that will be used in this script. Armor and Weapons.}}^{{Lich setting|name=gear:name|desc=Noun of the item.}}^{{Lich setting|name=gear:is_leather|desc=true if this is repaired at the leather repair npcs.}}^{{Lich setting|name=gear:hinders_lockpicking|desc=true if should be removed for lockpicking.}}^{{Lich setting|name=gear:is_worn|desc=true if the item is worn such as armor, shields, wearable weapons.}}^{{Lich setting|name=gear:swappable|desc=true if this is a swappable weapon.}}^{{Lich setting|name=gear:tie_to|desc=This is the name of what this weapon is tied to, e.g toolstrap.}}^{{Lich setting|name=gear:adjective|desc=Used to differentiate items with the same name, if TAP ADJECTIVE NAME doesn't work then these settings are wrong.}}^{{Lich setting|name=gear:bound|desc=true if the item bonded for hurl/invoke.}}
|uservars={{Lich setting|name=crossing_repair_debug|desc=Turns on debugging messages.}}
|children=
}}

== crossing-training==
{{Lich script
|description=Trains non-combat skills. Despite the name, crossing-trainer this works in other towns using the hometown setting.
|usage= Cycles through skills training the lowest one in field experience at the time.

Skills that can be trained: Appraisal, Athletics, Astrology, Attunement, Augmentation, Warding, Utility, Debilitation, Empathy, Engineering, First Aid, Forging, Locksmithing, Mechanical Lore, Outdoorsmanship, Outfitting, Perception, Performance, Scholarship, Scouting, Sorcery, Stealth, Summoning, Theurgy, Thievery, Trading.

Additionally, the following skills can be trained only via research: Arcana, Life Magic, Holy Magic, Lunar Magic, Elemental Magic, Arcane Magic.
|args=
|settings={{Lich setting|name=train_with_burgle|desc=Set true to turn on burgle for locksmithing, thievery, stealth, and/or athletics. Needs burgle_settings:.}}^{{Lich setting|name=classes_to_teach|desc=List of subjects to teach people in your safe room}}^{{Lich setting|name=climbing_target|desc=Object to practice climbing on. Setting this causes you to climb practice during athletics training. Look in base-athletics for a list of climbing targets.}}^{{Lich setting|name=use_research|desc=Whether or not to use research when training magic skills. Requires train_with_spells to be true.}}^{{Lich setting|name=outdoor_room|desc=Used for spells requiring moons.}}^{{Lich setting|name=perform_options|desc=List in base-perform.yaml of playstyles sorted by difficulty.}}^{{Lich setting|name=storage_containers|desc=A list of containers to open before starting training.}}^{{Lich setting|name=crossing_training_requires_movement|desc=Skills which require movement as part of their training. This is used to avoid spamming the safe room with repeated entry/exit messages.}}^{{Lich setting|name=trash_nouns|desc=Nouns that can be thrown away without warning}}^{{Lich setting|name=crossing_training|desc=List of skills to train. Supported Skills - Appraisal (requires zills), Athletics, Arcana/Primary Magic(requires research enabled), Astrology, Attunement, Augmentation, Warding, Utilty, Debilitation(barb only?), Empathy, Engineering(workorders), First Aid (needs compendium), Forging (workorders or raw smithing), Locksmithing, Mechanical Lore, Outdoorsmanship, Outfitting(workorders or knitting), Perception, Performance(zills), Scholarship(blacksmithing book), Scouting(enough ranks for trails), Sorcery, Stealth (low ranks only), Summoning, Theurgy(see theurgy script), Thievery, Trading(workorders).}}^{{Lich setting|name=safe_room|desc=Room Id where you do any stationary training and listen for classes.}}^{{Lich setting|name=exit_on_skills_capped|desc=Whether or not to exit the game when all skills are locked}}^{{Lich setting|name=crossing_training_sorcery_room|desc=The room to use when training sorcery. MAKE SURE THIS ROOM IS LAWLESS by typing 'justice'.}}^{{Lich setting|name=crossing_training_sorcery|desc=Action to take when training sorcery}}^{{Lich setting|name=listen|desc=Whether or not you should attempt to listen to classes while training}}^{{Lich setting|name=train_with_spells|desc=}}^{{Lich setting|name=cyclic_training_spells|desc=Cyclic Spells to use when training.}}^{{Lich setting|name=cyclic_cycle_skills|desc=Skills to train with cyclic spells during crossing-training.}}^{{Lich setting|name=training_spells|desc=Spells to use when training magic skills. TODO: Make this its own page.}}^{{Lich setting|name=research_skills|desc=}}^{{Lich setting|name=exp_timers|desc=Cooldown timers between attempts to train a given skill}}^{{Lich setting|name=training_nonspells|desc=}}^{{Lich setting|name=kneel_khri|desc=}}^{{Lich setting|name=khri_preps|desc=If you use Khri for training, make sure their prep messages are recorded here}}^{{Lich setting|name=prep_scaling_factor|desc=This scaling factor is multiplied by your discerned max mana for a spell. The mana to be removed is rounded up, so anything < 1.0 will always result in at least one mana removed.}}^{{Lich setting|name=cambrinth_cap|desc=The maximum amount of mana your cambrinth can hold}}^{{Lich setting|name=osrel_amount|desc=}}^{{Lich setting|name=osrel_no_harness|desc=}}^{{Lich setting|name=held_cambrinth|desc=Whether or not you need to hold your cambrinth to charge it}}^{{Lich setting|name=stored_cambrinth |desc=Whether or not your cambrinth item is stored (false indicates worn)}}^{{Lich setting|name=cambrinth|desc=The noun for the cambrinth you use. Multiple cambrinth is not yet supported.}}^{{Lich setting|name=prep_messages|desc=If you cast spells for training, make sure their prep messages are recorded here}}^{{Lich setting|name=cambrinth_cap |desc=The maximum amount of mana your cambrinth can hold}}^{{Lich setting|name=forage_item|desc=}}^{{Lich setting|name=hand_armor|desc=Noun of any armor that needs to be removed when braiding}}^{{Lich setting|name=braid_item|desc=}}^{{Lich setting|name=athletics_options|desc=}}^{{Lich setting|name=trail_override|desc=}}^{{Lich setting|name=art_options|desc=}}^{{Lich setting|name=train_workorders|desc=Disciplines to train via workorders when training that skill}}^{{Lich setting|name=work_order_disciplines|desc=Disciplines to train via workorders when training Trading}}^{{Lich setting|name=tithe|desc=Whether or not to tithe (two boxes are supported), with a cooldown of 4 hours}}^{{Lich setting|name=cleaning_cloth|desc=The type of cleaning cloth to use when zills are dirty}}^{{Lich setting|name=dedicated_camb_use|desc=Set to 'cyclic' or 'spell' with respect to the magical feat}} ^{{Lich setting|name=wield|desc=Set to true or false; If true, then it wields and sheaths your weapon. This is very useful if you have weapons in different containers. With this set to true on each weapon (e.g. :wield: true in your gear settings), it will return them back from where they came with the wield and sheath commands.}}^{{Lich setting|name=dedicated_camb_use|desc=Set to 'cyclic' or 'spell' with respect to the magical feat}}
|uservars={{Lich setting|name=crossing_trainer_debug|desc=Turns on debugging messages.}}
|children=attunement, pick, sell-loot, theurgy, safe-room, workorders, sew, smith
}}

== crowns ==
{{Lich script
|description=Plays the Hollow Eve's game dice/crowns.
|usage=
|args=
|settings={{Lich setting|name=dice_bet_amount|desc=Put this in your yaml and set to some whole number, like dice_bet_amount: 10.}}^{{Lich setting|name=dice_money_on_hand|desc=How much money to withdraw from the bank.}}^{{Lich setting|name=dice_withdraw|desc=Withdraw money from the bank setting.}}^{{Lich setting|name=hollow_eve_loot_container|desc=Storage container name.}}
|uservars=
|children=
}}

== dusk-labyrinth ==
{{Lich script
|description=Searches for pets, bloodscrip, and loot in [[Drathrok%27s_Duskruin#Labyrinth|Duskruin Labyrinth]].
|usage=Configure your settings, enter the labyrinth, then start the script. The script will wait for messaging about a critter scurrying about and either try to catch it or move to another room. If no pet has been found by the 5 minute warning then it begins to search each room to collect bloodscrip and incidentals.
|args={{Lich setting|name=debug|desc=(optional) Turns on debugging messages.}}
|settings={{Lich setting|name=duskruin:labyrinth:pet_noun|desc=(required) Kind of pet searching for, such as '''monkey''' or '''rat'''.}}^{{Lich setting|name=duskruin:labyrinth:loot_container|desc=(optional) Which container to put the bloodscrip and items you find when searching. If not specified then relies on {{com|STOW}} left/right.}}^{{Lich setting|name=duskruin:labyrinth:redeem_scrip|desc=(optional) Set to '''true''' to auto redeem any found bloodscrip. Default is ''false''.}}
|uservars={{Lich setting|name=dusk_labyrinth_debug|desc=(optional) Turns on debugging messages.}}
|children=
}}

== echo ==
{{Lich script
|description=
|usage=
|args=
|settings=
|uservars=
|children=
}}

== edityaml ==
{{Lich script
|description=
|usage=
|args=
|settings=
|uservars=
|children=
}}

== equipmanager ==
{{Lich script
|description=
|usage=
|args=
|settings=
|uservars={{Lich setting|name=equipmanager_debug|desc=Turns on debugging messages.}}
|children=
}}

== expreset ==
Resets your EXP window in Stormfront. This is useful for removing erroneous game output that gets 'stuck' in your exp window (usually during connection).
{{Lich script
|description=
|usage=
|args=
|settings=
|uservars=
|children=
}}

== faux-atmo ==
{{Lich script
|description=Bring your verby items to life! Turn toys and items with fun verbs into [[Atmospheric_item|atmospherics]] by periodically performing a random verb on a random item based on your settings.
|usage=Configure which items and verbs you want to periodically do then start the script. It runs in the background.
|args={{Lich setting|name=debug|desc=Enable debug mode.}}
|settings=
* Example Settings:
<pre>
# Number of minutes to wait between performing a verb on an item.
faux_atmo_interval: 15

# Set to true to randomly select an item and verb to perform.
# Set to false to round-robin select items and verbs to perform.
faux_atmo_random: true

# Items that don't have an inherent atmo effect
# but whose verbs if done periodically would.
faux_atmo_items:
- name: blue basilisk
verbs:
- pet
- pinch
- poke
- name: hooded cloak
verbs:
- rub
- pat
- wave

# Don't perform verbs on items if these scripts are running.
faux_atmo_no_use_scripts:
- combat-trainer
- go2
- get2
- bescort
- steal
- burgle

# Don't perform verbs on items if in these rooms.
faux_atmo_no_use_rooms:
- Carousel Chamber # Room with vault
- Carousel Booth # Room just before vault
- 1900 # You can specify room ids, too
</pre>
|uservars={{Lich setting|name=faux_atmo_debug|desc=Enable debug mode.}}
|children=
}}

== favor ==
{{Lich script
|description=Gets one favor by rubbing an orb repeatedly.
|usage=
It is intended to be used in [[RanikMap1|The Crossing]].

If an argument is passed to the script, that Immortal's name will be used. The default is Hodierna.
|args=
|settings=
|uservars=
|children=
}}

== fill-dirt ==
{{Lich script
|description=Fills a dirt stacker with dirt.
|usage=Run the script in any room where dirt is forageable.
|args=
|settings={{Lich setting|name=dirt_stacker|desc=Name of dirt stacker to fill. Must be worn.}}
|uservars=
|children=
}}

== find ==
{{Lich script
|description=Finds an NPC in [[RanikMap1|The Crossing]].
|usage=
|args={{Lich setting|name=npc|desc=A unique name (or noun) of the NPC to find.}}^{{Lich setting|name=follow|desc=If present, the script will follow the NPC around.}}
|settings=
|uservars=
|children=
}}

== find-darkbox ==
{{Lich script
|description=Finds and plays the Hollow Eve's game Darkbox.
|usage=
|args={{Lich setting|name=override|desc=Optional arg. Passes override to heal-remedy to use remedies instead of herbs if you already have herbs setup in your yaml.}}
|settings={{Lich setting|name=he_use_herbs_remedies|desc=Put this as true in your yaml if you want to use heal-remedy.}}^{{Lich setting|name=hollow_eve_loot_container|desc=Storage container name.}}
|uservars=
|children=
}}

== first-aid ==
{{Lich script
|description=Trains the First Aid skill by reading compendiums or textbooks More in-depth look at first-aid.lic: https://github.com/rpherbig/dr-scripts/wiki/First-Aid-Strategy
|usage=
|args=
|settings={{Lich setting|name=textbook|desc=False if using a compendium, true otherwise.}}^{{Lich setting|name=textbook_type|desc=If not using a compendium, the name of the thing to study.}}^{{Lich setting|name=compendium_type|desc=Will default to compendium but also supports burgled manuals and guides.}}
|uservars=
|children=
}}

== faskinner ==
{{Lich script
|description=Trains the First Aid skill with training items such as a small blue-belly crocodile with prominently stitched seams or a small fuzzy caracal with tufted ears and double-stitched seams.
|usage=
|args=
|settings=
* Example Settings:
<pre>
# Trainer noun should match exactly, such as crocodile or caracal
fa_skinning_trainer:

# Container where you store your trainer, if it's not worn.
fa_skinning_trainer_container:

# If you don't wear a skinning knife, this is the
# bladed weapon you want to use to skin with, such as a dagger.
fa_skinning_knife:

# If you specify 'fa_skinning_knife:' then this is
# the container where that bladed weapon is stored.
fa_skinning_knife_container:

# Options: First Aid, Skinning, Both or leave blank for whichever happens first
fa_skinning_priority:
</pre>
|uservars=
|children=
}}

== feed-cloak ==
{{Lich script
|description=Feeds [[living vine cloaks]] that you are wearing so that they stay refreshed and healthy.
|usage=Run on demand or part of a training routine to feed your cloak regularly. Does not run in the background.
|settings=
* Example Settings:
<pre>
# If your cloak can't feed in your current room
# then feed-cloak will move to this specified room id.
# If not specified, or if the cloak can't feed here either,
# then the script will move to your `safe_room`.
feed_cloak_room: 992 # Crossing, [Northeast Wilds, Outside Northeast Gate]
</pre>
}}

== forge ==
{{Lich script
|description=Forges an item. Adapted from a script by Mallitek.
|usage=
EXAMPLES:

<code>;forge weaponsmithing 2 sword steel sword</code>

<code>;forge blacksmithing 6 "shallow metal cup" bronze cup</code>

<code>;forge blacksmithing 6 scratcher bronze scratcher</code>

<code>;forge temper sword</code>
|args={{Lich setting|name=type|desc=Type of book (blacksmithing, armorsmithing, weaponsmithing)}}^{{Lich setting|name=chapter|desc=Chapter of the book}}^{{Lich setting|name=recipe|desc=the name of the recipe}}^{{Lich setting|name=metal|desc=metal type of the ingot in your bag}}^{{Lich setting|name=noun|desc=item noun to make}}
|settings=
|uservars=
|children=
}}

== gbox ==
{{Lich script
|description=Hand all boxes from a container (the first argument) to a character (the second argument).
|usage=
|args={{Lich setting|name=container|desc=The container}}^{{Lich setting|name=character|desc=The character}}
|settings=
|uservars=
|children=
}}

== glyph-of-mana ==
{{ Lich script
|description=A script that will keep glyph of mana up always.
|usage=Meant to be used as a during: in combat but can be used anywhere.
<pre>
# Example usage:
hunting_info:
- :zone: cinder_beasts
args:
- d1
stop_on:
- Small Edged
:duration: 55
before:
- go2 12345
- mech-lore
- athletics
during:
- glyph-of-mana
</pre>
|args=
|settings=
|uservars=
}}

== gmoney ==
{{Lich script
|description=Hand money to the given character. The money is given 10 plat at a time, depositing first to minimize coinage (i.e. hand off plat instead of copper where possible). Useful for F2P players who cannot deposit more than 10 plat at once.
|usage=Start the script while you and the other player are standing at a bank teller.
|args={{Lich setting|name=character|desc=The character}}
|settings=
|uservars=
|children=
}}

== heal-remedy ==
{{Lich script
|description=Uses crafted remedies for healing
|usage=This script will cycle through the remedies, from base-remedies.yaml, from the most potent to least potent. The script will pause a little bit, letting the remedies work to make scars, then apply scar remedies. Will need one hand free to use.
|args={{Lich setting|name=override|desc=Override setting to force using remedies instead of herbs if herbs are already defined in your yaml.}}
}}

== healme ==
{{Lich script
|description=A self healing script for empaths
|usage=Will heal your own wounds, leaving external bleeders as desired. Uses Heal preferentially if configured and not attempting to keep bleeders. Targets wounds on potentially lethal body parts first, otherwise heals in severity order.
<pre>
#the first line is prep amount, second is a single cambrinth charge
empath_healing:
HW:
- 1
- 1
HS:
- 1
- 1
#HEAL:
#- 15
</pre>
|args={{Lich setting|name=Bleeders|desc=any body parts to leave external wounds on, quote two word body parts.}}
|settings={{Lich setting|name=prep_messages|desc=Used for spell casting matching and lives in base.yaml please submit custom prep messages as needed.}}^{{Lich setting|name=cambrinth|desc=noun for cambrinth used for casting}}^{{Lich setting|name=held_cambrinth|desc=true if you cannot charge your cambrinth worn}}^{{Lich setting|name=stored_cambrinth|desc= true if your cambrinth is stored in a container instead of worn}}^{{Lich setting|name=empath_healing:HW|desc=List of mana amounts. preps HW with the first the rest will be charged into cambrinth}}^{{Lich setting|name=empath_healing:HS|desc=List of mana preps for HS}}^{{Lich setting|name=empath_healing:HEAL|desc=List of mana preps for HEAL}}
|uservars={{Lich setting|name=healme_debug|desc=Turns on debugging messages.}}
}}

== horse-trainer ==
{{Lich script
|description=Teaches all skills to a horse.
|usage=This script will go through the list of skills and try to teach a horse. The order teaches is leadrope, saddle, animal, joust, kneel, prance, beg, spin, jump, combat, magic, war. You must be a Ranger to run this.
|args=
}}

== hunting-buddy==
{{Lich script
|description= Trains combat skills (using combat-trainer) in defined hunting areas
|usage= Will move through a series of defined hunting spots, training at each one until specified conditions are met. Stops at the first empty room it finds in the hunting area, will search for hiding players and wait 10 seconds for them to take any actions in rooms with monsters, moving on if a player is already there.
|args=
|settings={{Lich setting|name=training_manager_hunting_priority|desc=Set to true and and you will stay in hunting spots until stop_on skills are at 32/34, set to false and you will stay until stop_on or duration is met.}}^{{Lich setting|name=hunting_zones|desc=The set of hunting areas defined in base.yaml that can be directly reached with go2.}}^{{Lich setting|name=escort_zones|desc=The set of hunting areas defined in base.yaml that requires custom pathing to reach.}}^{{Lich setting|name=hunting_info|desc=In order list of hunts.}}^{{Lich setting|name=hunting_info:zone|desc=Name of hunting zone, must match one of the two zone lists above.}}^{{Lich setting|name=hunting_info:args|desc=List of arguments to call combat-trainer with at this hunting area.}}^{{Lich setting|name=hunting_info:full_waiting_room|desc=Room to wait in while the zones are full, defaults to safe_room number if not present.}}^{{Lich setting|name=hunting_info:duration|desc=Time in minutes to hunt here if hunting_priority is false.}}^{{Lich setting|name=hunting_info:stop_on|desc=List of skills that will stop hunting when they are all at 32/34}}^{{Lich setting|name=hunting_info:boxes|desc=Sets the hunt as a box priority hunt, will stop or skip if you have box_loot_limit number of boxes if set to true}}^{{Lich setting|name=hunting_buddies|desc=List of PC's that you're ok to share a hunting room with, remember proper Capitalization.}}^{{Lich setting|name=hunting_nemesis|desc=List of PC's you do not want to hunt with, remember proper Capitalization.}}^{{Lich setting|name=empty_hunting_room_messages|desc=List of messages to use when asking if a room is empty. A random message will be used each hunt.}}^{{Lich setting|name=prehunt_buffs|desc=Room number where you can cast buffs before beginning hunt. List buffs under waggle_sets: with same heading prehunt_buffs:.}}^{{Lich setting|name=hunting_room_min_mana|desc=Minimum mana level of an acceptable hunting room.}}^{{Lich setting|name=hunting_room_strict_mana|desc=If false, it will find any empty room in the event that no empty rooms are found above the minimum mana level.}}^uservars=
|children=combat-trainer, buff
}}

== inventory-manager ==
{{Lich script
|description= Stores current "inv list" data in a YAML file for searching from any character... works across multiple accounts.
|usage= Store and access any character's "inventory list". Prints a list of character names stored, prints individual inventory, and searches all inventory for any keyword(s).
|args={{Lich setting|name=save|desc=Executes game command "inv list" and saves all items to database labeled as either worn or in container.}}^{{Lich setting|name=search|desc=Searches database for text provided. Requires an item for which to search.}}^{{Lich setting|name=list|desc=Shows all character(s) names stored within the database. Optional input of a character's name to list their inventory.}}^{{Lich setting|name=remove|desc=Removes character and associated data from database, requires a name.}}
}}

== invoke-rune ==
{{Lich script
|description= Use to cast spells from runestones. The runestones are the ones purchased from Sierack's Reagents, https://elanthipedia.play.net/Sierack%27s_Reagents, in Shard. Can add more from Enchanting or other places.
|usage= ;invoke-rune "<spell name>" example: ;invoke-rune "Clear Vision"
|args={{Lich setting|name=spell|desc=Name of the spells: "Arc Light" Althleticism Bless Calm "Clear Vision" Compost "Eagle's Cry" "Fire Shards" "Glythtide's Gift" Geyser "Protection from Evil" Refresh Shadows Zephyr. Use double quotes for spells with two or more words.}}^{{Lich setting|name=debug|desc=Puts script in debug mode.}}
|settings=
|uservars=
|children=
}}

== jail-buddy ==
{{Lich script
|description= Handles being arrested in the crossing
|usage= Keep running.
|args=
|settings=
|uservars=
|children=
}}

== join-thieves ==
{{Lich script
|description=Joins the thieves guild in Crossing.
|usage=
|args=
|settings=
|uservars=
|children=
}}

== journal ==
{{Lich script
|description=A script to use an epistemic journal. Best used as an after:
|args=
|settings=
|uservars= ''journal_noun'': Set the noun of your journal, defaults to journal
|children=
}}

== lamprey ==
{{Lich script
|description=Plays the Hollow Eve's game lamprey. Can only play this game once every 10 minutes if you get a lamprey or prize.
|usage=
|args=
|settings={{Lich setting|name=hollow_eve_loot_container|desc=Storage container name.}}
|uservars=
|children=
}}

== levelup ==
{{Lich script
|description=Walks to your guild leader and levels up as many times as you can.
|usage= <pre>;levelup</pre>
|args=
|settings=
|uservars=
|children=
}}

== locksmithing ==
{{Lich script
|description=Trains locksmithing independently or with crossing-training. Can use unlimited training boxes, daily charge training boxes, or limited use disposable training items such as corn maze pouches, liquor cabinets, or burgled keepsake boxes. Also trains [[Lich_script_repository#performance|performance]] while picking.
|usage=Can be used independently or by listing Locksmithing under crossing_training. If used with crossing_training additional feature <code>train_with_burgle: true</code> is available. The [[Lich_script_repository#burgle|burgle_settings: loot_container]] is a shared feature for ease of use with keepsake boxes.

'''Example Settings:'''
<pre>
# Do you use a worn lockpick ring for picking?
# If true then specify the name of your lockpick ring as the container.
use_lockpick_ring: true
lockpick_container: lockpick ring

# If false then the script will get a loose lockpick from the container.
#use_lockpick_ring: false
#lockpick_container: backpack

# When done picking boxes that contains coins, gems, and such,
# do you want to run the ;sell-loot script?
sell_loot: true

# Do you want to pick looted boxes from critters and such?
# If true then the ;pick script is ran using its settings.
# Refer to that script for how to set up those settings.
pick_live_boxes: true

# Do you want to pick a daily use lockbox trainer like a training box or harvest bag?
# If true then specify your trainer's name and whether it's worn or not.
have_training_box: false
picking_lockbox: training box
picking_worn_lockbox: false

# Do you want to pick consumable boxes such as limited use trainers from burgling or incidentals?
# If true then list the names of those discardable consumables here.
# IMPORTANT! Consumable boxes will be pulled from your burgle_settings: loot_container.
# IMPORTANT! Consumable boxes should be kept separate from live boxes so as not to cause issues with ;pick script.
# IMPORTANT! THESE BOXES WILL BE DROPPED. MAKE CERTAIN YOU ONLY LIST THROW-AWAY TRAINERS.
consumable_lockboxes:
- keepsake box
- box puzzle
- jewelry box

# If you use a daily use lockpick trainer,
# be sure to add it to your gear: config.
gear:
- :adjective: training
:name: box
:skip_repair: true
:container: backpack

</pre>
|args=
|settings=
|uservars=
|children=
}}

== makesteel ==
{{Lich script
|description= Makes steel ingots. The script will handle acquiring the needed materials.
|usage= <pre>;makesteel count [type] [refine]</pre>
|args= {{Lich setting|name=count|desc= (required) number of ingots to produce}}^{{Lich setting|name=type|desc=Carbon content, defaults to high. Options are: [l, m, h]}}^{{Lich setting|name=refine|desc=If provided, refine the resulting ingot}}
|settings={{Lich setting|name=hometown|desc=City in which to make the ingots, defaults to Crossing}}
|uservars=
|children=
}}

== mine ==
{{Lich script
|description= Mines a room while watching for danger
|usage= Prospects and mines out your current room, stowing or deeding anything in your vein list. Will prospect careful for more materials after exhausting the room.
|args=
|settings={{Lich setting|name=mining_buddy_vein_list|desc=List of metals and rocks that you wish to mine.}}^{{Lich setting|name=mine_implement|desc=Shovel or pick.}}^{{Lich setting|name=mine_use_packet|desc=Set to true to carry and use a deed packet, otherwise stow found minerals}}
|uservars=
|children=safe-room
}}

== mining-buddy ==
{{Lich script
|description= Perform a single pass through the mines
|usage= Will navigate through all listed mines, prospecting and stopping to mine anywhere it finds a resources it watches for. Can alternatively mine out each room it comes to, or merely look for resource rich rooms if you lack the skill to see resources. Will keep 1 plat on hand for repairs and buying deed packets. Will heal on injuries due to failed danger checks, or exit if buried.
|args=
|settings={{Lich setting|name=mining_buddy_rooms|desc=Defined in base.yaml, links mine names to a list of rooms}}^{{Lich setting|name=mines_to_mine|desc=List of mine names to mine, matches up against mining_buddy_rooms.}}^{{Lich setting|name=mining_skip_populated|desc=Set to true will NOT prospect and mine in rooms with other players.}}^{{Lich setting|name=mining_buddy_mine_every_room|desc=Set to true will prospect and mine out each room regardless of minerals.}}^{{Lich setting|name=mining_buddy_vein_list|desc=List of metals and rocks that you wish to mine.}}^{{Lich setting|name=mine_implement|desc=Shovel or pick.}}^{{Lich setting|name=mine_use_packet|desc=Set to true to carry and use a deed packet, otherwise stow found minerals}}
|uservars={{Lich setting|name=mining_debug|desc=Turns on debugging messages.}}
|children=mine,safe-room
}}

== mining-manager==
{{Lich script
|description=repeatedly mines in defined mining areas (using mining-buddy)
|usage=
|args=
|settings=
|uservars=
|children=
}}

== mm ==
{{Lich script
|description=A general purpose moon mage utility script
|usage= Run the script without any arguments to see usage
|args= {{Lich setting|name=locate <name>|desc=Locates the given name and reports the room number if the locate was successful}}^{{Lich setting|name=rift <name>|desc=Locates and rifts the given name to your current room. Checks if the moons are up. Uses the same settings as <code>;mm locate</code>}}
|settings= {{Lich setting|name=waggle_sets['locate']|desc=Optional. A waggle set called 'locate' with only the locate spell in it. Uses the data in DISCERN locate otherwise.}}^{{Lich setting|name=waggle_sets['rs']|desc=Optional. A waggle set called 'rs' with only the locate Riftal Summons spell in it. Uses the data in DISCERN RS otherwise.}}
|uservars=
|children=
}}

== moonwatch ==
{{Lich script
|description=populates UserVars.moons with data related to the moons
|usage=
Moonwatch will populate UserVars with the following data:
<code>
UserVars.moons = {
'katamba' => { 'pretty' => 'Katamba is up for 35 minutes', 'rise' => nil, 'set' =>35 },
'yavash' => { 'pretty' => 'Yavash will rise in 150 minutes', 'rise' => 150, 'set' => nil },
'xibar' => { 'pretty' => 'Xibar is up for 5 minutes', 'rise' => -1, 'set' => 5 }
'visible' => ['katamba', 'xibar']
}
</code>

We suggest using an alias such as:

<code>;alias add moon = ;eq respond("#{UserVars.moons['katamba']['pretty']} : #{UserVars.moons['yavash']['pretty']} : #{UserVars.moons['xibar']['pretty']}")</code>

You can {{com|PERCEIVE}} an individual moon to reset its data or [[Moon_Mage_attunement#Power Perception|PERCEIVE MOONS]] to reset all if this is a first start (or you've been offline for a while and the data seems wrong).
|args={{Lich setting|name=debug|desc=Turns on debugging messages.}}
|settings=
|uservars={{Lich setting|name=moon_debug|desc=Turns on debugging messages.}}
|children=
}}

== newbie-gear==
{{Lich script
|description=Crafts a set of gear for a new character.
|usage=
|args={{Lich setting|name=storage|desc=The container in which to store finished items}}
|settings=
|uservars=
|children=
}}

== oshu_manor ==
{{Lich script
|description=Navigates you through the Oshu Manor. Used to hunt [[Seordhevor kartais]]. Note there is an underscore in this script's name, not a dash.
|usage=
|args=
|settings=
|uservars=
|children=
}}

== paladin-quests ==
{{Lich script
|description=Completes the paladin Glyph quests for you.
|args={{Lich setting|name=warding|desc=Complete the Glyph of Warding Quest.}}{{Lich setting|name=bonding|desc=Complete the Glyph of Bonding Quest.}}{{Lich setting|name=light|desc=Complete the Glyph of Light Quest.}}{{Lich setting|name=mana|desc=Complete the Glyph of Mana Quest.}}{{Lich setting|name=ease|desc=Complete the Glyph of Ease Quest.}}{{Lich setting|name=renewal|desc=Complete the Glyph of Renewal Quest.}}
|settings=
|uservars=
|children=
}}

== pattern-hues ==
{{Lich script
|description=Casts Warrior Mage Pattern Hues cantrip at set intervals.
|usage= The script will cast pattern hues cantrip based on settings in yaml. If no custom settings set, will cast a random color. Examples: ;pattern-hues now will cast now and exit. ;pattern-hues in you before, after, t2, manually, or in a personal startup script will change cast the cantrip on your interval and with settings. Leave pattern and hue empty if you want to pick from all the available options. Put what you only want the color to go to for random. Custom is for those lucky enough to have their own color (Dartellum has a custom color). Or, put the exact color you want in gesture, such as bright emerald.
|args= {{Lich setting|name=now|desc=Cast now.}}{{Lich setting|name=debug|desc=Output variable values.}}
|settings={{Lich setting|name=Pattern Hues yaml settings: gesture is either random, custom, or a specific setting.}}
pattern_hues:
duration: 600
gesture: custom
pattern_hues_styles:
pattern:
- bright
- hazy
- gleaming
- lucent
hue:
- soot black
- emerald
- bone white
- snowflake white
- yellow
- charcoal black
- sky blue

|uservars=
|children=
}}

== pay-debt ==
{{Lich script
|description=Pays your debt. Optionally retrieves your sack of belongings from the guard house.
|usage=
|args=
|settings=
|uservars=
|children=
}}

== performance ==
{{Lich script
|description=Script to train performance. Defaults to worn instrument but accepts an instrument setting
|usage=
|args=
|settings={{Lich setting|name=instrument|desc=Optional. The instrument you would like to use. Defaults to worn instrument if none selected}}
|uservars=
|children=
}}

== performance-monitor ==
{{Lich script
|description=Logs combat-related events such as damage, roundtime, etc. for later parsing.
|usage=
|args=
|settings=
|uservars=
|children=
}}

== pick ==
{{Lich script
|description=Disarms, harvests, and unlocks boxes
|usage=The script will look for suitable disposal sources in the room, or drop refuse on the ground. Refills lockpicking ring after finished.
|args={{Lich setting|name=pets|desc=Disarm boxes and place them in the pet box container}}^{{Lich setting|name=count|desc=How many pet boxes to make }}^{{Lich setting|name=refill|desc=Refill your lockpick ring}}
|settings={{Lich setting|name=stop_pick_on_mindlock|desc=true to stop after the current box when your mind is full.}}^{{Lich setting|name=use_lockpick_ring|desc=Do you wear a lockpick ring?}}^{{Lich setting|name=skip_lockpick_ring_refill|desc=Set this to TRUE in order to skip buying lockpicks after mind-locked. This is important if you have crafted lockpicks on the ring, since you can't use lockpicks of differing qualities on the same ring.}}^{{Lich setting|name=lockpick_type|desc=Type of lockpick to stock on ring.}}^{{Lich setting|name=harvest_traps|desc=true to harvest traps while disarming.}}^{{Lich setting|name=picking_box_source|desc=The bag that unopened boxes are stored in.}}^{{Lich setting|name=picking_box_storage|desc=The bag to put boxes into that are too difficult to disarm.}}^{{Lich setting|name=picking_pet_box_source|desc=The bag that disarmed pet boxes are stored in.}}^{{Lich setting|name=lockpick_dismantle|desc=If you have a custom dismantle type to use, put it here.}}^{{Lich setting|name=lockpick_buffs:spells:abbrev|desc=abbreviation of a buff to put up before picking.}}^{{Lich setting|name=lockpick_buffs:spells:mana|desc=amount of mana to use for prep.}}^{{Lich setting|name=lockpick_buffs:spells:cambrinth|desc=List of cambrinth charges, see crossing-training for cambrinth related settings.}}^{{Lich setting|name=lockpick_buffs:khri|desc=List of khri to turn on before lockpicking.}}^{{Lich setting|name=lockpick_room_id|desc=Select a specific room number to open boxes to avoid blowing up your neighbors}}
|uservars={{Lich setting|name=lockpick_debug|desc=Turns on debugging messages.}}
|children=
}}

== release_cyclic ==
{{Lich script
|description=Releases all cyclic spells.
}}

== ranger-companion ==
{{Lich script
|description=Summons a companion and feeds it milk or corn if it's a baby, handles raising a baby pet to young age. Meant to be used as a during: in combat but works anywhere as long as you are stationary.
}}

== researcher ==
{{ Lich script
|description=Does research on a single subject.
|usage=Specify the subject as an argument, e.g. ;researcher augmentation
|args=missing
|settings=missing
|uservars=missing
|children=missing
}}

== register ==
{{ Lich script
|description=A script for searching your deed register.
|usage=The script will search your deed register for the specified crafting material.

Example: <code>;register damite</code>
--- Lich: register active.
;Output of reading register not shown here to save space.
Results:
45 -- a deed for a damite ingot (48V 91Q - pure Damite --Binu)
46 -- a deed for a damite ingot (10V 86Q - pure Damite --Binu)
[register]>stow right
You put your register in your hunting pack.
--- Lich: register has exited.

|args={{Lich setting|name=query|desc=The material you want to search for. Can also be information you entered in the deed note.}}
|settings={{Lich setting|name=crafting_container|desc=The name of the container where you store your deed register.}}
|uservars=
|children=
}}

== remedy ==
{{ Lich script
|description=A script for crafting remedies using alchemy.

remedy <book type> <chapter> <recipe name> <herb1> <herb2> <catalyst> <container> <noun>

Book type: What alchemy type is this item. [remedies]

Chapter: containing the item.

Recipe name: Name of the recipe, wrap in double quotes if this is multiple words.

Herb1: Prepared herb, wrap in double quotes if this is multiple words..

herb2: Prepared herb, wrap in double quotes if this is multiple words. Put none for none.

catalyst: Type of catalyst.

container: Type of container for creating.

noun: End product [cream, salve, wash, balm, ungent, potion, tonic, ointment, elixir, poultices, draught]

remedy <continue> <herb2> <catalyst> <container> <noun>

continue

herb2: Prepared herb, wrap in double quotes if this is multiple words. Put none for none.

catalyst: Type of catalyst.

container: Type of container for creating.

noun: End product [cream, salve, wash, balm, ungent, potion, tonic, ointment, elixir, poultices, draught]

}}

== repeat ==
{{ Lich script
|description=A script for repeating a sequence of up to 10 commands. Does not take scripts.
|usage=>;repeat "get my rock" "drop my rock"
}}

== restock ==
{{ Lich script
|description=A script for restocking your supply of stackable and nonstackable items.
|usage= Will parse your YAML for a restock set and make the appropriate purchases to maintain your desired quantity. This is called at the start of hunting-buddy as the preferred mechanism to maintain ammunition counts.
|args=
|settings={{Lich setting|name=restock|desc=list of item names or hashes. A name will be searched in base-consumables based on your hometown setting. It will go and purchase the appropriate version of that item found in that hometown. For example, lising "arrow" will purchase boar-tusk arrows in Crossing, but if your in Shard will purchase long arrows. Any of the values pulled from base-consumables can be overridden by providing by appropriate key-value-pair under the item name within your YAML. Not all cities have every type of item (for example only the Crossing sells rocks or sling/ammo). As such, you can explicitly define your own items within the YAML by setting the item name, with the following key-value-pairs: name, room, price, size (how many obtained in a single purchase transaction), stackable (t/f), and quantity (how many you want to maintain on hand at a given time). Here are some examples:
<pre>
# This will purchase arrows from your hometown using all defaults; including quantity (which is 30)
restock:
arrow

# This is the same as above, but with a custom quantity
restock:
arrow:
quantity: 45

# this is a completely custom item not contained in base-consumables. It will not change based on hometown.
restock:
super_cool_thing:
name: cool thing
room: 1337
price: 10
size: 3
stackable: true
quantity: 4

# Here are a list of generic items in base-consumables:
arrow
bolt
tk_ammo
rock

# Restock now supports custom Hometowns. This will be super useful if you use Shard as a hometown and need rocks from Hib. You can have as many as you want, but be reminded that we must support the hometown in base-towns.yaml. The hometowns will be visited in order from first to last, listed top to bottom.

hometown: Shard

restock:
arrow:
quantity: 50
bolt:
quantity: 50
rock:
hometown: Hibarnhvidar
name: smooth rocks
room: 12172
price: 45
size: 30
stackable: true
quantity: 50

# restock can probably handle items with "charges" (i.e ritual foci) if they disappear/consumed once all charges are gone.
</pre>}}
|uservars=
}}

== rezz ==
{{ Lich script
|description=A script to rezz corpses
|usage=The script will either raise the person you specify, or if you don't specify someone it will raise all of the corpses in the room. You should add a rezz: waggle set so that it doesn't use default values for rejuv and rezz.
|args={{Lich setting|name=player|desc=The person you want to raise. Optional argument}}
|settings={{Lich setting|name=osrel_no_harness|desc=true to infuse directly, false to harness first.}}

Waggle set to add. Customize the mana and cambrinth values to your skill level:

waggle_sets:
rezz:
Resurrection:
abbrev: rezz
mana: 17
Rejuvenation:
abbrev: rejuv
mana: 10
cambrinth:
- 15
}}

== roomnumbers==
{{Lich script
|description=Adapted from a script by Geldan for Gemstone. Appends the Lich room ID# to your in-game room look. Example:

<pre>[Whistling Wood, Barrows]
A mound of earth looks curiously out of place beneath the twisted and warped branches of the dead trees. Barren of all but the hardiest of grasses, the mound has several small
holes in its side. You also see an Adan'f blood warrior, a chipped and weather-beaten sign, an Adan'f blood warrior and an Adan'f blood warrior.
Obvious paths: southeast, southwest, northwest.
Room Number: 9471
</pre>
|usage=
|args=
|settings=
|uservars=
|children=
}}

== safe-room ==
{{Lich script
|description= Heals at a PC or NPC empath and shares items between characters by taking and dropping them in a safe room
|usage= Gets 4 gold (for autopath), goes to the auto empath and waits until healed. Alternatively can go to a specific set of rooms and wait for 45 seconds for a player empath to heal you. You can list several PC empaths. The script will go to the nearest one from your current location. PC Empaths will heal themselves using healme, Necromancers will not attempt to go to an empath. Can be configured to stop by a room and pick up or drop given item nouns.
|args=
|settings={{Lich setting|name=safe_room_tip_threshold|desc=Amount of copper to carry for npc healing, or if you have more than this amount donate to player empath.}}^{{Lich setting|name=safe_room_id|desc=Id of room for player empath healer or item exchanges.}}^{{Lich setting|name=saferoom_health_threshold|desc=Skips saferoom healing unless the 'force' argument is used. This is a number that represents your wound severity. The calculation of your wound score is Sum(wound level^2 * number of wounds at that level).}}^{{Lich setting|name=safe_room_empath|desc=Name of PC empath healer.}}^{{Lich setting|name=safe_room_empaths|desc=A list of PC empaths with their name and room ID}}^{{Lich setting|name=safe_room_tip_amount|desc=Amount in coppers to donate player empath.}}^{{Lich setting|name=safe_room|desc=Id of room to heal self at as empath.}}^{{Lich setting|name=safe_room_give|desc=List of nouns to drop at safe_room_id, CAUTION will drop all items of this noun there, don't use for anything valuable.}}^{{Lich setting|name=safe_room_take|desc=List of nouns to pick up in safe_room_id.}}^{{Lich setting|name=force_healer_town|desc=Override your hometown: setting to use an auto empath in a different town.}}^{{Lich setting|name=heal_with_divine_charm|desc=true/false - Attempt to use a divine charm that new characters start with to heal, instead of an auto-path.}}
|uservars=
|children=healme
}}

== sanowret-crystal ==
{{Lich script
|description=Runs in the background, gazing or exhaling your sanowret crystal to train [[Arcana]]. Checks for concentration and current mindstate to run only when necessary. Supports worn crystals or stored in a container.
|usage=This script can be run in passive mode or on-demand, and is well suited as part of your autostarts.

Run once on-demand: <code>;sanowret-crystal run=true</code>

Run in the background: <code>;sanowret-crystal</code>

Auto start: <code>;autostart add sanowret-crystal</code>

|args={{Lich setting|name=run|desc=If present, only run the script once (instead of in passive mode).}}
|settings=In your YAML, configure the adjective of your sanowret crystal and list any scripts or rooms where you don't want the script to run, such as when burgling or in a room that prevents magical device usage.

Example:

sanowret_adjective: sanowret
sanowret_no_use_scripts: # Don't try to use crystal while these scripts are active.
- sew
- carve
- tinker
- forge
- remedy
- shape
- enchant
- outdoorsmanship
- combat-trainer
- buff
- burgle
- go2
sanowret_no_use_rooms: # Don't try to use crystal while in these rooms.
- Carousel Chamber # Room with vault
- Carousel Booth # Room just before vault
- 1900 # You can specify room ids, too (Crossing bank window)

}}

== scroll-search ==
{{Lich script
|description= Searches through the given container for any and all spell scroll and displays them in a more readable way. Also allows for the player to grab a specific scroll or transfer scrolls between containers. This script allows you to search multiple containers and tracks the scrolls in each.
|usage= Player specifies the container to search and the script looks through the container for any nouns matching scroll_nouns specified in base-items.yaml
|args={{Lich setting|name=search <container>|desc=Searches the given container}}^{{Lich setting|name=display|desc=Displays the scrolls in all searched containers. Must have already searched or the list will be empty!}}
|settings={{Lich setting|name=scroll_nouns|desc=List of scroll nouns to search container for.}}
|uservars={{Lich setting|name=owned_scrolls|desc=Hashset of the scroll name and the container it resides in.}}^{{Lich setting|name=scroll_counter|desc=Global counter for the amount of scrolls owned.}}^{{Lich setting|name=scroll_search_debug|desc=Turns on debug messaging for scroll-search.lic script.}}
|children=
}}

== sell-loot ==
{{Lich script
|description= Sells gems and bundles; then deposits coin. Defaults to keeping 3 silver on hand (the maximum amount that cannot be stolen by a Thief).
|usage= Will sell bundles and any gems in untied gem pouches. Optionally will make sure you have a spare gem pouch. It is intended to be used in [[RanikMap1|The Crossing]].

EXAMPLES:
* <code>;sell-loot</code> # Uses the default: keeps 3 silver
* <code>;sell-loot 12</code> # Uses one argument: keeps 12 silver, which is withdrawn as 1 gold and 2 silver
* <code>;sell-loot 4 g</code> # Uses two arguments: keeps 4 gold
|args={{Lich setting|name=Withdraw|desc=Amount of coin to withdraw after depositing all. 3 silver, 5 gold, etc.}}
|settings={{Lich setting|name=sell_loot_money_on_hand|desc=Same as the Withdraw argument, overridden by the argument if both exist.}}^{{Lich setting|name=sell_loot_pouch|desc=Set true to sell any gems in a worn pouch.}}^{{Lich setting|name=sell_loot_bundle|desc=Set to true to sell a worn bundle.}}^{{Lich setting|name=sell_loot_traps|desc=Sell harvested traps from boxes that are in your 'component_container'.}}^{{Lich setting|name=spare_gem_pouch_container|desc=The container to store a spare gem pouch in, should NOT be the container a pouch stows to.}}^{{Lich setting|name=gem_pouch_adjective|desc=Adjective you use to request gem pouches, you should be able to tap ADJ pouch to tap your current pouch.}}^{{Lich setting|name=sell_loot_skip_bank|desc=If true, skip bank parts of the script (currency exchange, deposit, withdrawal).}}^{{Lich setting|name=sell_loot_skip_exchange|desc=If true, skip currency exchange.}}^{{Lich setting|name=bankbot_name|desc=The name of the bankbot with whom you would like to deposit coin.}}^{{Lich setting|name=bankbot_deposit_threshold|desc=An amount of copper to keep on hand. Excess will be deposited with the bankbot. Your in-game bank will always be deposited into before the bankbot.}}^{{Lich setting|name=bankbot_room_id|desc=The room ID of the bankbot.}}
|uservars=
|children=
}}

== sell-pouches ==
{{Lich script
|description=Sell gem pouches for trading experience
|usage=This script is called by crossing-training when you have 'Trading' listed as a training skill and 'sell_pouches_for_trading' set to true. You can also call it to sell a pouch.
|settings={{Lich setting|name=hometown|desc=Your hometown. This is used to determine which gemshop you will sell your pouches to}}^{{Lich setting|name=sale_pouches_container|desc=Container where your pouches for sale are stored}}^{{Lich setting|name=waggle_set named 'sell-pouches'|desc=Casts these spells before selling a pouch. This is where you would include spell data for casting Finesse}}

}}

== setupaliases ==
{{Lich script
|description=Adds a useful selection of aliases to the global list:
* <code>as</code> - accepts a trade offer and then stows the item
* <code>gs</code> - gets the given item and then stows the item
* <code>cc</code> - runs ;circlecheck to show your leveling status. it can take args, like cc 200
* <code>ct</code> - toggles crossing-training on or off
* <code>tm</code> - toggles training-manager on or off
* <code>fr</code> - find room, searches for a room description matching provided text
* <code>ids</code> - echos the current mapped connections from the room you're standing in
* <code>lr</code> - echos the full data of the room you're standing in
* <code>lfr</code> - echos the full data of the room a remote room number, pass the number to it
* <code>ls</code> - shows all items in the current room you are in that are stealable that are not in base-stealing
* <code>cb</code> and <code>rec</code> - these work as a pair, for recording room numbers (like setting up a hunting area); run <code>cb</code> to start, then <code>rec</code> in each room you want to record
* <code>hz</code> - list all hunting zones alphabetically
* <code>ez</code> - list all escort hunting zones alphabetically
* <code>fz</code> - search hunting zones and get room numbers, e.g. <code>fz wark</code> returns a list of room numbers for warklins
|usage=
|args=
|settings=
|uservars=
|children=
}}

== sew ==
{{Lich script
|description=
|usage=
|args=
|settings=
|uservars=
|children=
}}

== shape ==
{{Lich script
|description=
|usage=
|args=
|settings=
|uservars=
|children=
}}

== skill-recorder ==
{{Lich script
|description=
|usage=
|args=
|settings=
|uservars=
|children=
}}

== slackbot ==
{{Lich script
|description= If the status-monitor script detects an problem, it will use this script to send you a Direct Message on Slack.
|usage= This script should not be run directly. Instead, status-monitor will run it if the slack_username setting is present. On first time setup you will communicate with a lichbot to get a slack token. The token lets you send messages to your username via the bot. You will currently not receive any notification on setup.
|args=
|settings={{Lich setting|name=slack_username|desc=Your Slack username. It should be all lowercase.}}
|uservars={{Lich setting|name=slack_token|desc=The token used to authenticate to a Slack team.}}
|children=
}}

== smartlisten ==
{{Lich script
|description=If someone teaches you an approved class you'll start listening.
|usage=The default list of approved classes is all non-necromancer skills and no sorcery or thievery. Guild-specific skills are approved if you are of that guild. Some specific classes are also removed based on your guild (e.g. remove Arcana for Barbarians).
|args=
|settings=
|uservars=
|children=
}}

== smarttransfer ==
{{Lich script
|description=safely transfer wounds from the target, avoiding useless injuries in fatal areas
|usage=
|args={{Lich setting|name=bleed|desc=If present, leave external bleeders.}}
|settings=
|uservars=
|children=
}}

== smash-pumpkins ==
{{Lich script
|description=Travel to the pumpkin vat, buy one, go one room away to smash and repeat until too injured. Then return to the safe room.
|usage=
|args=
|settings={{Lich setting|name=hollow_eve_loot_container|desc=Storage container name.}}
|uservars=
|children=
}}

== smelt ==
{{Lich script
|description=Smelt the contents of a crucible. Assumes that material has already been placed into the crucible.
|usage=
|args=
|settings=
|uservars=
|children=
}}

== smelt-deeds ==
{{Lich script
|description=combines deeds of like metals to save inventory space
|usage=
|args=
|settings=
|uservars=
|children=
}}

== smith ==
{{Lich script
|description=
|usage=
|args=
|settings=
|uservars=
|children=
}}

== smoke ==
{{Lich script
|description=smokes an item
|usage=
You can run the script two ways, one from command line and the other from a YAML.

Command line:

;smoke <image> <cigar noun> <container things are in> <lighter's noun (MUST be a lighter)>

You can also run it from a YAML setting:

;smoke <cigar noun>

|args=Command Line:

<image> <cigar noun> <container things are in> <lighter's noun (MUST be a lighter)>

YAML:

<cigar noun> (When running from YAML)

|settings=
<pre>
smoke:
cigar_container: humidor
smoke_image:
lighter:
type: flint
container: humidor
blade: dagger
</pre>
|uservars=
|children=
}}

== sorcery ==
{{Lich script
|description=
|usage=
|args=
|settings=
|uservars=
|children=
}}

== spin ==
{{Lich script
|description=This script is intended to be used in [[RanikMap1|The Crossing]].
|usage=
|args=
|settings=
|uservars=
|children=
}}

== stabbity ==
{{Lich script
|description=Stabbity is designed for thieves, and relies on backstab and thrown weapons to kill things quickly. It's useful in invasions and events.
|usage=
When run without a mode specified (e.g. <code>;stabbity</code>), stabbity will wield your weapon and hide, killing any mob in the room. If no mobs are present, it will wait in hiding for one to arrive.

'''Example Configuration'''
<pre>stabbity:
eliminate: true
weapons:
preferred: glaes pasabas
alternate: judge's gavel
thrown: throwing club
use_alternate_on:
- archer
- soldier
- dryad
- oshu
- frostweaver
- guardian
use_thrown_on:
- hawk
- gryphon</pre>
|args=
{{Lich setting|name=mode|desc=Optional, can be one of:^
* ''equip'': Wields your preferred weapon.^
* ''cleanup'': Sheathes your preferred weapon.^
* ''single'': Kills all mobs in the current room and exits. Does not wait for mob to arrive.^
* ''arena'': Used to run the Dusk Ruin arena.}}^
{{Lich setting|name=noloot|desc=Do not loot mobs when killed.}}
|settings=
{{Lich setting|name=stabbity:eliminate|desc=True/False. Only used during arena. Will use krhi eliminate at the beginning of rounds 5/10/15/20/25. '''Only include if you are a thief with khri eliminate.'''}}^
{{Lich setting|name=stabbity:weapons:preferred|desc=The name of the weapon you wish to backstab with.}}^
{{Lich setting|name=stabbity:weapons:alternate|desc=The name of the weapon you wish to use for mobs defined in use_alternate_on.}}^
{{Lich setting|name=stabbity:weapons:thrown|desc=The name of the weapon you wish to use for mobs defined in use_thrown_on. If this is left off, then it will never try thrown (useful for characters with passive abilities that can force flying thins to land - ex khri terrify).}}^
{{Lich setting|name=stabbity:use_alternate_on|desc=List of mobs on which to use your alternate weapon.}}^
{{Lich setting|name=stabbity:use_thrown_on|desc=List of mobs on which to use your thrown weapon.}}
|uservars={{Lich setting|name=stabbity_debug|desc=Turns on debugging messages.}}
|children=
}}

== stack-scrolls ==
{{Lich script
|description=Scroll stacker manager script that stores and retrieves scrolls using stackers.
}}

== status-monitor ==

{{Lich script
|description=Informs user of high-frequency game output and characters current health via a small window. Useful for keeping tabs on multiple characters.
|usage=Trust status monitor then run it.
|args={{Lich setting|name=debug|desc=Turns on debugging messages.}}
|settings=
|uservars=
|children=
}}

== steal ==
{{Lich script
|description=
|usage=
|args=
|settings=^{{Lich setting|name=hide_to_steal|desc=set to false if you do not wish to hide to steal.}}^{{Lich setting|name=bin_stolen|desc=set to true for Thieves who wish to bin stolen goods.}}^{{Lich setting|name=stealing_bag|desc=storage bag for stolen goods if bin_stolen: true}}^{{Lich setting|name=slow_bin_speed|desc=set to true to bin items slower. Resolves type-ahead issue for Genie users.}}^{{Lich setting|name=steal_past_mindlock|desc=set to true if you wish to continue stealing after Thievery is locked.}}^{{Lich setting|name=dont_steal_list|desc=list items by id# identified in '''base-stealing.yaml''' to skip these items when stealing.}}^{{Lich setting|name=stealing_buffs|desc=list of buffs to use before starting stealing run.}}^{{Lich setting|name=stealing_high_acceptable_count|desc=.}}^{{Lich setting|name=stealing_low_acceptable_count|desc=.}}^{{Lich setting|name=npc_stealing_attempt_count|desc=Numeric amount of stealing attempts on NPCs (minstrel, veteran, etc.)}}^{{Lich setting|name=stealing_options|desc=list of stealable items in base-stealing.yaml}}^
|uservars=
|children=
}}

== study-art ==
{{Lich script
|description=Walks through the Crossing art gallery and appraises each piece on display. Trains scholarship and appraisal.
|usage=Just run it. e.g. <code>;study-art</code>
|args=
|settings=
|uservars=
|children=
}}

== summoning ==
{{Lich script
|description=Trains summoning via summoning and breaking a magical weapon. Summons admittance to build up charges to summon a weapon. [[Warrior Mages]] must have already {{com|align}}ed to an element.
|settings={{Lich setting|name=summoning_target_increment|desc=The desired number of mind states to increase by. Respects crossing_training_max_threshold as an upper threshold.}}
}}

== tarantula ==
{{Lich script
|description=Manages the automated usage of the biomechanical tarantula, a gift handed out for patrons of Hollow Eve 432.
|usage=Run <code>;tarantula</code> after adjusting YAML settings as desired. Can be added to startup. The script watches for skills near max-mindstate to sacrifice for their bonus, with different behavior depending on if you're in combat or not.
|args=
|settings=^{{Lich setting|name=tarantula_startup_delay|desc=Number of seconds to wait after first starting before it will eat skills. Useful when tarantula is added to autostarts, so that it doesn't eat skills on first login, before login drain.}}^
{{Lich setting|name=tarantula_noun|desc=Change if you've had a tarantula alteration or if you bought the harvester spider at 2020 Corn Maze. Use both the adjective and noun.}}^
{{Lich setting|name=tarantula_debug|desc=Set true if you wish to see debug messages}}^
{{Lich setting|name=tarantula_excluded_skills|desc=A list of skills never to sacrifice to the tarantula.}}^
{{Lich setting|name=tarantula_no_use_scripts|desc=A list of scripts defined by you, during which the tarantula will not activate.}}^
{{Lich setting|name=tarantula|desc=A list of skills, organized by skillset and by whether you want them sacrificed in and/or out of combat as defined by whether combat-trainer is running. These are the prioritized choices, however ;tarantula will choose other full skills in that sphere if none of its prioritized skills are available, unless they are listed in <code>tarantula_excluded_skills</code>

<pre>
tarantula:
Armor:
combat:
- Chain Armor
- Brigandine
- Plate Armor
- Light Armor
- Defending
Weapon:
combat:
- Melee Mastery
- Missile Mastery
Magic:
combat:
- Utility
non_combat:
- Lunar Magic
- Warding
- Augmentation
- Utility
Survival:
combat:
- Evasion
- Skinning
non_combat:
- Outdoorsmanship
Lore:
non_combat:
- Appraisal
- Performance
- Scholarship

An example of exclusions added to a yaml:

tarantula_excluded_skills:
- Large Edged
- Brawling
- Evasion
- Parry
- Shield
- Athletics
- Crossbow
- Slings
- Light Thrown
- Bow

</pre>

}}^
|uservars={{Lich setting|name=tarantula_last_use|desc=The last time the tarantula was sacrificed to.}}^{{Lich setting|name=tarantula_last_skillset|desc=The last sphere sacrificed to, since the tarantula can't be used on the same sphere twice in a row.}}
|children=
}}

== tendme ==
{{Lich script
|description=Automatic wound tender for self. On start, checks {{com|health}} for bleeding wounds and tends them, then watches for messages to unbind or retend wounds.
|usage=
|args={{Lich setting|name=train|desc=If present, unwrap and rebind wounds for optimum learning.}}
|settings=
|uservars=
|children=
}}

== tendother ==
{{Lich script
|description=Automatic wound tender for another player. On start, looks for bleeding wounds and tends them, then watches for messages to unbind or retend wounds.
|usage=
|args={{Lich setting|name=player|desc=Name of the player to tend.}}
|settings=
|uservars=
|children=
}}

== textsubs==
{{Lich script
|description=Provides in-game text substitution capabilities; comes with many defaults (e.g. appraisal and combat messages).
|usage=
Example of adding a sub: <code><nowiki>TextSubs.add('^(\s+)no (puncture|slice|impact|fire|cold|electric) damage','\1no (0/27) \2 damage')</nowiki></code>

Clear out all stored subs with <code>TextSubs.clear()</code>
|args=
|settings=
|uservars=
|children=
}}

== theurgy ==
{{Lich script
|description=train theurgy by working up devotion and doing communes
|usage= Recommended - Eluned (holy water)
|args=
|settings={{Lich setting|name=theurgy_supply_container|desc=Container for storing wine, flint, and incense.}}^{{Lich setting|name=water_holder|desc=Vessel that you store holy water in.}}^{{Lich setting|name=flint_lighter|desc=Blade for lighting flint.}}^{{Lich setting|name=immortal_aspect|desc=for bead carving/meditation (must be aspect of god you last got a favor from).}}^{{Lich setting|name=theurgy_prayer_mat_room|desc=Room in which to use your prayer mat. Requires an object defined with an `id: roomid` format, ex.
<nowiki>
theurgy_prayer_mat_room:
id: 1234</nowiki>
}}
|uservars=
|children=
}}

== titlecheck ==
{{Lich script
|description=Checks for new titles since the last time you ran the script.
|usage=Run the script and provide a set of titles to check (e.g. ;titlecheck moonmage). On the first run for that title set, all titles will be reported as new. Running the script afterwards will report only new titles.
|args=title_set
|settings=
|uservars=titles
|children=
}}

== trade ==
{{Lich script
|description=Do caravan trading in Zoluren
}}

== train ==
{{Lich script
|description=Train the given attributes. It is intended to be used in [[RanikMap1|The Crossing]].
|usage=
Arguments are the name of the attribute to train, with an optional number of trainings (Defaults to 1):
* <code>;train</code>
No arguments: nothing happens
* <code>;train st</code>
"st" is ambiguious between stamina and strength: nothing happens
* <code>;train sta w2</code>
Trains stamina once and wisdom twice
|args=
|settings=
|uservars=
|children=
}}

== training-manager==
{{Lich script
|description= High level script for managing combat and non combat training
|usage= Will alternate training in the crossing and hunting with a focus on either in or out of combat as specified. Heals and repairs after combat.
|args=
|settings={{Lich setting|name=training_manager_hunting_priority|desc=Set to true will cause it to focus on combat training at the expense of out of combat.}}^{{Lich setting|name=training_manager_priority_skills|desc=List of combat skills to monitor when it should go hunting again, only used if hunting_priority is set true.}}^{{Lich setting|name=training_manager_town_duration|desc=Number of minutes to limit town training to before going hunting. This works when hunting priority is true or false}}^{{Lich setting|name=mine_while_training|desc=Set to true will cause town training to start with a mining loop.}}^{{Lich setting|name=favor_goal|desc=Number of favors to work towards, if this is set will work on favors while training.}}^{{Lich setting|name=favor_god|desc=Desired immortal to request favor orb for Must be set for favor gathering to work properly.}}^{{Lich setting|name=repair_timer|desc=Time in seconds between each run of crossing-repair. Default is 10 minutes, or 600 seconds.}}^{{Lich setting|name=repair_withdrawal_amount|desc=Amount of currency to withdrawal for each repair. Default amount is 10,000.}}^{{Lich setting|name=skip_repair|desc=True/false setting. Use true to skip all crossing-repair functionality. Default is false.}}
|uservars=
|children=mining-buddy,sell-loot,hunting-buddy,crossing-training,safe-room,crossing-repair
}}

== transfer-items ==
{{Lich script
|description=Transfers all items from one container to another. It may need to be run multiple times if you have a lot of stuff. If you use an adjective you must type it completely in double quotes, e.g. "hide sack", not "h sack".
|usage=
* Transfer all items from <source> to <destination>
;transfer-items <source> <destination>
;transfer-items backpack haversack

* Transfer only items that respond to <noun> from <source> to <destination>
;transfer-items <source> <destination> <noun>
;transfer-items backpack quiver arrows
|args={{Lich setting|name=source|desc=Source container.}}^{{Lich setting|name=destination|desc=Destination container.}}^{{Lich setting|name=noun|desc=If specified, only items with this noun will be transferred.}}
|settings=
|uservars=
|children=
}}

== truffenyi-commune-quest ==
{{Lich script
|description=Runs in the background to do all actions required during the truffenyi commune quest, praying to the gods presented in the visions and dropping any food items that appear in your hands. This should be run somewhere safe, without other scripts running because they can interfere. Start after drinking the vial created from your mini altar twice.
|usage=
|args=
|settings=
|uservars=
|children=
}}

== validate ==
{{Lich script
|description=Checks character yamls for common mistakes.
|usage=
|args=
|settings=
|uservars=
|children=
}}

== walkingastro ==
{{Lich script
|description=Runs as a background script whose aim is to keep your prediction pools filling and the Astrology Skill moving.
|usage=On a 215 second timer, while not in combat (or while a series of other scripts are running), it will grab your telescope and if day observe the Sun, if night observe the Heart constellation. If your survival prediction pool fills, the script will instead align and predict against a survival skill. The aim of the script is to keep Astrology moving while you are out and about with your character, without having to rely on the ;astrology script.

Note, walkingastro will wait and not fire while the following scripts are running: 'steal', 'combat-trainer', 'pick', 'craft', 'shape', 'sew','bescort', 'remedy', 'forge', 'carve', 'performance', 'theurgy', 'hlctheurgy', 'astrology', 'astrology2', 'study-art', 'mech-lore', 'first-aid'.

Finally, this script assumes that you have a telescope (see Astrology for telescope support settings) and that Piercing Gaze is up.

It is highly recommended that you add PG to your list of in/out of combat buff spells.
|args=
|settings=
|uservars=
|children=
}}

== weave-cloth ==
{{Lich script
|description=This script is intended to be used in [[RanikMap1|The Crossing]].
|usage=
|args=
|settings=
|uservars=
|children=
}}

== workorders ==
{{Lich script
|description=completes a workorder for the given discipline. Supplemental information: https://github.com/rpherbig/dr-scripts/wiki/Crafting-Setup
|usage=
|args={{Lich setting|name=type|desc=Type of workorder to do, blacksmithing, tailoring, shaping.}}
|settings={{Lich setting|name=crafting_container|desc=Bag that materials, tools, and books are stored in.}}^{{Lich setting|name=workorder_diff|desc=difficulty of workorder to request.}}^{{Lich setting|name=crafting_recipes|desc=List of crafting recipes in base-crafting.yaml.}}^{{Lich setting|name=forging_tools|desc=List of tools used in forging.}}^{{Lich setting|name=forging_belt|desc=Set up this has if you have a toolbelt for this craft.}}^{{Lich setting|name=forging_belt:name|desc=Unique name of belt.}}^{{Lich setting|name=forging_belt:items|desc=List of items held on the belt.}}^{{Lich setting|name=knitting_tools|desc=List of tools used in knitting.}}^{{Lich setting|name=outfitting_belt|desc=Set up this has if you have a toolbelt for this craft.}}^{{Lich setting|name=outfitting_belt:name|desc=Unique name of belt.}}^{{Lich setting|name=outfitting_belt:items|desc=List of items held on the belt.}}^{{Lich setting|name=shaping_tools|desc=List of tools used in shaping.}}^{{Lich setting|name=engineering_belt|desc=Set up this has if you have a toolbelt for this craft.}}^{{Lich setting|name=engineering_belt:name|desc=Unique name of belt.}}^{{Lich setting|name=engineering_belt:items|desc=List of items held on the belt.}}^{{Lich setting|name=carving_tools|desc=List of tools used in carving.}}^{{Lich setting|name=workorder_min_items|desc=Minimum number of items in the workorder required to accept.}}^{{Lich setting|name=workorder_max_items|desc=Maximum number of items in the workorder required to accept.}}^{{Lich setting|name=workorders_repair|desc= Whether you want to repair your crafting tools after completing workorders or not. For those with tools setup under gear, set to false in your yaml.}}
workorders_repair: true

#CARAVAN SETTINGS
# container holding caravan contracts for ;trade

|uservars=
|children=smith, shape, sew
}}

{{cat|Lich scripts}}

Lich script repository

2020-11-10T02:44:31Z

POPWEASEL:

{{RTOC}}

This page documents the collection of scripts that are available from an external repository located at [https://github.com/rpherbig/dr-scripts https://github.com/rpherbig/dr-scripts], and not through the in-game <code>;repository</code> functionality.

For script-specific documentation, see the appropriate section, below. For YAML documentation, see [https://github.com/rpherbig/dr-scripts/wiki/Introduction-to-Character-Settings Introduction-to-Character-Settings].

Also there is a newbie-friendly video guide - '''How to setup Lich: https://www.youtube.com/watch?v=Ty-seLTJSi4'''

If you have some feedback or suggestions, please contact us in-game (Sheltim or Etreu) or [https://github.com/rpherbig/dr-scripts/issues open an issue on GitHub]. We look forward to hearing from you!

= Introduction to Character Settings =
Character settings are read from a YAML file.

== What is YAML? ==
YAML is a human friendly file format that we use to store settings. It stands for YAML Ain't Markup Language (the name references itself as a kind of computer science joke). It's got a website and everything (http://yaml.org/), but there are only a few things you actually need to know:

Indentation matters. Use two spaces for each level of indentation.

If you see a line like <code>train_with_spells: true</code>, that means that the <code>train_with_spells</code> setting is being assigned a value of <code>true</code>. This may also be referred to as a hash in which <code>train_with_spells</code> is mapped to <code>true</code>. Values can be true/false, numbers, text, hashes, or lists (see below).

A list (or array) is a series of values. For example, this creates a list named <code>loot_additions</code> of item nouns that you want to loot:
<pre>
loot_additions:
- card
- dira
- bolt
- arrow
- stone
</pre>

A comment is any line that starts with a <code>#</code>. They are ignored when our scripts read your settings file. Comments are entirely for your own benefit (e.g. to leave yourself a note).

Don't worry, it'll make more sense if you go look at a YAML file. Try taking a look at [https://github.com/rpherbig/dr-scripts/tree/master/profiles some of these.]

== Loading YAML Files ==
YAML files are loaded in a predefined order. <code>base.yaml</code> is loaded first, then <code>YourCharacterName-setup.yaml</code>. If any arguments are given to a script (for example, <code>;combat-trainer BacktrainWeapons</code>), then <code>YourCharacterName-BacktrainWeapons.yaml</code> will be loaded last.

If the same setting occurs in multiple YAML files, then the last version of that setting is used. For example, you could define <code>dance_threshold</code> to be 1 in <code>YourCharacterName-setup.yaml</code> and then redefine it to be 0 in <code>YourCharacterName-BacktrainWeapons.yaml</code>.

<code>base.yaml</code> provides defaults for many (but not all) of the settings. You should never modify <code>base.yaml</code> directly; instead override settings in <code>YourCharacterName-setup.yaml</code> or <code>YourCharacterName-SomethingElse.yaml</code>. If you think something should be changed in <code>base.yaml</code>, please contact us in-game or open a [https://github.com/rpherbig/dr-scripts/pulls pull request]. We welcome all feedback and suggestions.

== Debugging YAML files ==
Its helpful to use a YAML parser for diagnosing issues.
http://yaml-online-parser.appspot.com/

= Autostart =
There are '''two''' autostart scripts.

<code>;autostart</code> is part of '''lich'''.

<code>;e autostart</code> is part of '''dependency''', a lich script, which manages the start up process for scripts documented here.

Use ''dependency'' autostart (the second one) for any script on this page. This means you should use <code>;e autostart 'scriptname'</code> or <code>;e autostart('scriptname')</code> instead of <code>;autostart add scriptname</code>

If any of the scripts on this page are in <code>;autostart list</code>, you should remove them. Try the command <code>;autostart help</code> if you need help.

== Add an autostart ==
<pre>
;e autostart('script-name') will start the script called 'script-name' for all of your characters
;e autostart 'script-name'
;e autostart('script-name', false) will start the script for only this character
;e autostart 'script-name', false
</pre>
Parenthesis do not matter
== List autostart scripts ==
<pre>
;e echo(list_autostarts) will show you the files being autostarted on a given character
;e echo list_autostarts
</pre>

== Remove an autostart ==
<pre>
;e stop_autostart('script-name') will remove an autostarted file from the list
;e stop_autostart 'script-name' parenthesis do not matter
</pre>

= Scripts =
== accept-sell ==
{{Lich script
|description=Accepts an outstanding trade offer for a pouch/bundle, appraises it and sells it. Returning coins, item, and a profit report to the owner.
|usage= Call the script when you have empty hands and an outstanding trade offer.
|args={{Lich setting|name=skip|desc=Don't appraise and send profit summary to seller, faster for multiple pouches/bundles.}}^{{Lich setting|name=buy|desc=Pay for the pouch out of your own money and keep it.}}^{{Lich setting|name=dump|desc=Dump item after sale.}}
|settings=
|uservars=
|children=
}}

== addroom ==
{{Lich script
|description=Add a series of rooms to the lich map. This script will checkout the mapdb, add the new rooms, and commit the mapdb. Automap is preferred to this script.
|usage=
To use this script send it an ordered set of directions to map. If you don't provide a direction no mapping will be provided.

For example, to add a Y branch to the north:

<code>;addroom "north, northeast, southwest, northwest, southeast, south"</code>

To add a store:

<code>;addroom "go shop, out"</code>

The travel delay defaults to 0.2.
|args={{Lich setting|name=debug|desc=Turns on debugging messages.}}
|settings=
|uservars={{Lich setting|name=add_room_debug|desc=Turns on debugging messages.}}
|children=
}}

== afk ==
{{Lich script
|description=Runs in the background to provide safety while you are afk. Basic keep alive script with simple health/spirit/death monitoring. Will exit on low health, low spirit, or death.
|usage=
|args=
|settings={{Lich setting|name=health_threshold|desc=Threshold at which you will exit (the same threshold is used for health and spirit)}}
|uservars=
|children=
}}

== almanac ==
{{Lich script
|description=Uses an almanac every 10 minutes. Pauses all other scripts, stows your left hand, studies it, then unpauses everything.
|usage=
|args=
|settings=
|uservars=
|children=
}}

== appraisal ==
{{Lich script
|description=Trains the Appraisal skill by appraising your gear, zills, bundles, gem pouches, and studying the art in the Crossing art gallery. Use the <code>appraisal_training</code> setting to specify a training regimen.
|usage=Define the <code>appraisal_training</code> list in your settings file. It will train in the order listed.
* Example Settings
<pre>appraisal_training:
- gear
- zills
- art
- bundle
- pouches
full_pouch_container: backpack
</pre>
<ul>
<li>The <code>gear</code> setting appraises everything listed in <code>gear</code> (where your armor and weapons are listed).
<li>The <code>zills</code> setting appraises zills up to 250 appraisal ranks; after that you will get a warning to remove zills from your training list.
<li>The <code>art</code> setting runs the study-art script which appraises art in the Crossing art gallery.
<li>The <code>bundle</code> setting appraises a worn bundle quick.
<li>The <code>pouches</code> setting appraises gem pouches stored in the container you list as <code>full_pouch_container</code>. Up to eleven gem pouches can be appraised. This has been updated to also appraise your worn gem pouch if <code>gem_pouch_adjective</code> is defined, making the total pouches appraised twelve.
</ul>
|args=
|settings={{Lich setting|name=appraisal_training|desc=List of training options. Valid options are <code>zills</code>, <code>pouches</code>, <code>bundle</code>, <code>gear</code>, and <code>art</code>}}^{{Lich setting|name=full_gem_pouch_container|desc=The container where you store gem pouches for appraisal. This should not be the same container where you store empty ones}}
|uservars=
|children=study-art
}}

== arrows ==
{{Lich script
|description=Creates shaft, arrowheads, and arrows all in one script.
Syntax: ;arrows type lumber tools

* Examples:
;arrows drake-fang maple
;arrows drake-fang balsa yes

|args=type, lumber, tools
|settings={{Lich setting|name=type|desc=The type of arrow you would like to make. The list is
<pre>
couger-claw
boar-tusk
sabertooth
angiswaerd
hele'la
basilisk
elsralael
soot-stained
ice-adder
jagged-horn
drake-fang
</pre>
}}^{{Lich setting|name=lumber|desc=The type of lumber you would like to use. Maple is the default lumber. You can use all the lumber types at the Society store. You can also use your own as long as you have the lumber on you.}}^{{Lich setting|name=tools|desc=This setting is storing your tools at the Society. This setting is optional.}}
|uservars={{Lich setting|name=None|desc= }}
|children=go2, shape

}}

== astrology ==
{{Lich script
|description=Trains astrology via by observing a known constellation which fills the most prediction pools and performing predictions aligned to those pools. If your character is above 99th circle the script can also walk the ways to train astrology. Walking is limited to one round-trip per hour.
|usage=Start in any room where the heavens are observable or where moongate can be cast (if astral traveling).
* Example Settings:
<pre>
astrology_training:
- ways
- observe
- rtr
- weather
- events
- moons
astral_plane_training:
train_destination: crossing
train_source: shard

have_telescope: true
#Choose one, container or tie
telescope_storage:
container:
tie:

#Choose one, container, tied, or worn
divination_tool:
name:
container:
tied:
worn:

#Choose one, container or tied
divination_bones_storage:
container:
tied:

NOTE: DO NOT INCLUDE THE STUFF UNDER divination_tool or divination_bones_storage IF NOT USING!!

EXAMPLE YAML IF NOT USING:
divination_tool:
divination_bones_storage:

</pre>
|args=
|settings={{Lich setting|name=astrology_training|desc=A list of training options. The possible options are ways, observe, rtr, weather, events, and moons. Things will be trained in the order they are listed}}^{{Lich setting|name=have_telescope|desc=Set to true to indicate you have a telescope on you and it will be used to observe the heavens.}}^{{Lich setting|name=astral_plane_training|desc=Hash which contains the settings for astral training.}}^{{Lich setting|name=train_destination|desc=indicate the shard destination in lowercase(this is a town, not the shard name). This is where you will walk to for training. Options are: shard, crossing, leth, riverhaven, merkresh, fang, raven, throne, muspari, aesry, taisgath, theren, steppes}}^{{Lich setting|name=train_source|desc=indicates the shard you wish to return to after arriving at the destination shard, options are the same as in <code>train_destination</code>.}}
|uservars={{Lich setting|name=astral_plane_exp_timer|desc=This is set to the current time on your computer once you emerge from the shard indicated in <code>train_destination</code>. It's used to check how long its been since you last walked.}}
|children=bescort
}}

== athletics ==
{{Lich script
|description=Athletics training script
|args={{Lich setting|name=wyvern|desc=Climb wyverns instead of undergondola.}}^{{Lich setting|name=undergondola|desc=Climb undergondola.}}^{{Lich setting|name=xalas|desc=Climb in xalas}}
|settings={{Lich setting|name=have_climbing_rope|desc=Set this to true to use a magic climbing rope for training. This currently requires zills.}}^{{Lich setting|name=held_athletics_items|desc=A list of 1-2 items held while doing athletics to increase the difficulty. Each item adds difficulty. Uses get/stow, and the items don't need to be weapons.}}
}}

== attunement ==
{{Lich script
|description=Trains attunement via power walking or in perceiving in a single room. Power walking rooms are based on your hometown setting unless the <code>attunement_rooms</code> setting is filled out. Moon mages will not powerwalk, but use perceive mana instead. This script will cast spells listed in the <code>waggle_set</code> called 'attunement' when it starts.
|settings={{Lich setting|name=attunement_rooms|desc=A list of room id's to use for power walking. This is useful for power walking near your safe room, in non-justice areas (necromancers), or if your <code>hometown</code> does not have power walking room data.}}^{{Lich setting|name=crossing_training_stationary_skills_only|desc=Set to true to only train attunement in your current room. This setting does nothing for moon mages.}}^{{Lich setting|name=hometown|desc=Town to train attunement in; most towns have a pre-defined list of rooms to power walk in. Using <code>attunement_rooms</code> overrides this.}}^{{Lich setting|name=attunement_target_increment|desc=The desired number of mind states to increase by. Respects crossing_training_max_threshold as an upper threshold.}}
}}

== autocontingency ==
{{Lich script
|description=Moon Mages only. It can be run two different ways. First, by providing two arguments for a contingency target (anchor), and the room number that anchor will be in. Your character will run to the room in question, and cast both SEER and Contingency on the anchor. i.e. <code>autocontingency Eteu 798</code>. Contingency established, you can then go about your business.

The other method is <code>autocontingency invoke</code>. When run in this manner, typically after a hunt or a long athletics trip to the far side of Elanthia, the script will invoke the Contingency to bring you back to your point of origin.
|usage= Ensure that a waggle titled `contingency` is present in your YAML. Example below:
contingency:
Seer's Sense:
abbrev: SEER
recast: 2
mana: 15
cambrinth:
- 5
- 5
Contingency:
abbrev: CONTINGENCY
recast: 1
mana: 15
cambrinth:
- 7
- 7

The waggle does not have to include both spell entries, but SEER should only not be included if you are casting that by hand (or in another script) on your anchor target before the Contingency cast. Best practice, include both.

Example YAML usage for including autocontingency as a <code>before</code> in a hunt:
hunting_info:
- :zone:
- rats
- rats
- rats
:duration: 30
args:
- d0
- combat
before:
- go2 798
- autocontingency Etreu
after:
- autocontingency invoke
stop_on:
- Large Blunt
- Large Edged
- Small Edged
- Staves

Example YAML usage for including autocontingency as part of T2's <code>training_list</code>:
training_list:
- skill:
- Targeted Magic
start: 4
scripts:
- autocontingency Etreu 798
- buff main
- hunting-buddy
- autocontingency invoke
- safe-room
}}

== automap ==
{{Lich script
|description=Mapping assistance script
|usage=Start from an already mapped room. Records the commands you type to move around and maps new rooms as it encounters them. Will update existing paths if traveling through previously mapped areas. Run the script to start recording, then kill it when finished. Do not use your typeahead lines when this is running or you will damage the map.
|args=
|settings=
|uservars=
|children=
}}

== avtalia ==
{{Lich script
|description=Traders only. When run, it watches cambrinth defined in avtalia_array:. It maintains a running list of how much mana is in those cambrinth and allows it to be pulled by scripts like combat-trainer when mana is low.
|usage= Define a list of cambrinth as below:
avtalia_array:
- name: cambrinth bracer
cap: 32
- name: watersilk bag
cap: 108
- name: cambrinth anklet
cap: 12
- name: tattered robe
cap: 50
- name: cambrinth chains
cap: 50

Each entry must be unique, all cambrinth must be worn, you must have sufficient Arcana to charge and invoke accurately while worn, and you must not use your primary casting cambrinth you use for other spells.
|args=
|settings=avtalia_array: defines the array of worn cambrinth.
|uservars=avtalia
|children=
}}

== bankbot ==
{{Lich script
|description=Have a character act as a banker
}}

== bescort ==
{{Lich script
|description=A script for navigating certain problematic areas like swamp mazes, the wilds, and some river swims. Mostly used by other scripts. Can also be used for astral traveling.
|usage= Start this script with no arguments to see a list of supported areas and destinations.
|args=
|settings=
|uservars= ''citizenship'': Set citizenship to 'Zoluren' to skip a money check. Set to 'Ilithi' to use the north, west, south gates of Shard
|children=
}}

== buff ==
{{Lich script
|description=Casts waggle sets defined in your yaml. Casts the default: waggle set if no args are given.
|usage=
|args=
|settings=
|uservars=
|children=
}}

https://github.com/rpherbig/dr-scripts/wiki/Waggle-Sets

== burgle ==
{{Lich script
|description=[[Breaking and Entering]] - Used to train Thievery, Stealth, and depending on entry method, 1 of Athletics (rope) / Locksmithing(lockpick). '''Extremely high fines if you are caught. Be sure to read the [[Breaking and Entering]] page to understand how the system works prior to using this script.'''
|usage=Script can be started anywhere that can path the room you set in the settings.
* Example Settings:
<pre>
# Turn on Burgle inside crossing_training. Attempts to use ;burgle during Athletics, Locksmithing, Thievery, or Stealth
# Uses burgle_settings for entry method then continues to alternate methods such as climbing, picking shop stealing, etc.
train_with_burgle: true

#Plead guilty for lower fines if caught in normal justice.
guilty_plea: guilty

burgle_settings:
room: nnn # pick your own room, you should pick a room that no guard will ''ever'' enter. Picking rooms guards can come to is a failure on setup, not the script.
entry_type: lockpick # lockpick | rope | cycle | prioritylockpick | priorityrope
max_priority_mindstate: 26 # only used if priority setting for entry_type is used. Sets max midstate value before switchover to other entry_method. Default: 26
use_lockpick_ring: true # if you use a worn lockpick stacker
lockpick_container: lockpick ring # name of your lockpick stacker
max_search_count: 2 # max number of total searches to do including retries
retry: false # retry if you don't find loot. default: false
loot: keep # drop | keep | bin | pawn default: keep
loot_container: duffel bag # container to keep loot in while burglering
safe_mode: true # stop searching and try to get out as quickly as possible when hearing footsteps. Default: true
room_blacklist: # array of rooms to ignore. Case sensitive.
item_whitelist: # array of full item names (adj + noun) of items to keep no matter what. Case Sensitive.
item_whitelist: # array of **full item names** (adj + noun) of items to keep no matter what. Case Sensitive. Default: empty list
- blunt-tipped arrows # armory - non-lodging ammo
- blunt-tipped bolts # armory - non-lodging ammo
- blunt stones # armory - non-lodging ammo
- keepsake box # bedroom - limited use (35) locksmithing trainer
# - mixing bowl # kitchen - alchemy tool: 12/12 MC. 11/18 durability, 5/11 speed
# - mixing stick # kitchen - alchemy tool: 12/12 MC. 11/18 durability, 5/11 speed
# - rustic mortar # kitchen - alchemy tool: 12/12 MC. 11/18 durability, 5/11 speed
# - rustic pestle # kitchen - alchemy tool: 12/12 MC. 11/18 durability, 5/11 speed
# - mesh sieve # kitchen - alchemy tool: 12/12 MC. 11/18 durability, 5/11 speed
# - butcher's knife # kitchen - wrist worn 'belt' knife
- worn book # library - scroll stacker (15 page, 10 copies per page)
# - contract case # library - Trader Jewelry
# - dainty cowbell # library - wrist worn weatherproof instrument
# - writing quill # library - writing instrument (ledgers, etc)
# - thumb ring # library - Trader Jewelry
# - glass lens # sanctum - minion identifier
# - letter opener # sanctum - belt worn belt knife
- memory orb # sanctum - random skill absorber
# - crystal prism # sanctum - divination tool
# - celestial charts # sanctum - divination tool
# - tool case # work room - belt worn lockspick stacker - 25 ct
# - stirring rod # work room - forging tool: 12/12 MC. 11/18 durability, 5/11 speed
# - carving knife # work room - shaping tool: 12/12 MC. 11/18 durability, 5/11 speed
# - wood shaper # work room - shaping tool: 12/12 MC. 11/18 durability, 5/11 speed
# - metal rasp # work room - shaping/carving tool: 12/12 MC. 11/18 durability, 5/11 speed
# - imbuement rod # work room - enchanting tool
# - !ruby/regexp '/\S+ fabric/' # Bedroom - illustrates REGEX syntax for items
before: # array of scripts to run, similar to hunting-buddy, before the burgle (will be called right before buffing)
- yourscripthere with args here
after: # array of scripts to run, similar to hunting-buddy, after the burgle, (will be called right before script ends)
- anotherscript here
waggle_sets:
burgle:
- Plunder
- Slight
- Sight
- Silence
</pre>
|args={{Lich setting|name=start|desc=Required to run the script. Protects against accidental starting/typos.}}^{{Lich setting|name=entry|desc=Optional. Override yaml setting for entry_type. Valid options are: lockpick, rope, cycle, prioritylockpick, priorityrope.}}^{{Lich setting|name=roomid|desc=Optional. Override yaml setting for room to burgle from.}}^{{Lich setting|name=loot_type|desc=Optional. Override yaml setting what to do with loot. Items in your item_whitelist are always kept. Valid options: drop, keep, pawn bin.}}^{{Lich setting|name=hometown|desc=Optional. Override yaml hometown setting when using pawn or bin options.}}^{{Lich setting|name=follow|desc=Optional. Puts brugle into group follow mode. To be used when you've already joined someone to do a group burglary. This will buff, then hide if needed and then wait for the leader to burgle. Will attempt to leave the group if you are following once in, to prevent getting lost.}}
|settings={{Lich setting|name=burgle_settings|desc=Hash of all the burgle settings}}^{{Lich setting|name=burgle_settings:room|desc=The Room id that burgle should be done in. Guards should never come to this room, so pick carefully}}^{{Lich setting|name=burgle_settings:entry_type|desc=The type of entry - <code>rope</code> or <code>priorityrope</code> or <code>lockpick</code> or <code>prioritylockpick</code> or <code>cycle</code> You must have a heavy rope if using <code>rope</code> or <code>cycle</code>. You must have a lockpick, or a worn lockpick stacker with lockpicks on it if using <code>lockpick</code> or <code>cycle</code>. You must have both if you are using the <code>prioritylockpick</code> or <code>priorityrope</code> settings. the priority settings will use that entry method unless your mindstate is above the max value.}}^{{Lich setting|name=burgle_settings:max_priority_mindstate|desc=Tha maximum mindstate to use when using one of the priority entry settings, before switching to the other entry method.}}^{{Lich setting|name=burgle_settings:use_lockpick_ring|desc=<code>true</code> or <code>false</code>Check for a lockpick ring/stacker if using lockpick as entry_type. <code>true</code> or <code>false</code>}}^{{Lich setting|name=burgle_settings:lockpick_container|desc=The name of your lockpick ring/stacker.}}^{{Lich setting|name=burgle_settings:max_search_count|desc=Limits the number of searches you do. Setting this too high will result in arrest, and large fine. Start low and increase as needed.)}}^{{Lich setting|name=burgle_settings:retry|desc=Retry searches if you don't find loot. <code>true</code> or <code>false</code>}}^{{Lich setting|name=burgle_settings:loot|desc=What to do with loot. Supported options: <code>drop</code>, <code>keep</code>, <code>pawn</code>, <code>bin</code>. Note that you will always attempt to store loot while in the house, to avoid problems inside with items with custom drop scripts. <code>bin</code> is only supported for thieves.}}^{{Lich setting|name=burgle_settings:loot_container|desc=Where to put loot while in the house. This is required as the script will not attempt to drop loot in the house.}}^{{Lich setting|name=burgle_settings:safe_mode|desc=Stop searching and try to get out as quickly as possible when hearing footsteps. <code>true</code> or <code>false</code>}}^{{Lich setting|name=burgle_settings:room_blacklist|desc=List of room types (using Sentence Case) that you don't want to search for loot in.}}^{{Lich setting|name=burgle_settings:item_whitelist|desc=List of full item names (adj + noun) that you want to keep regardless of any other setting.}}^{{Lich setting|name=burgle_settings:before|desc=List of scripts you want to run before burglary. This is run right before the waggle set.}}^{{Lich setting|name=burgle_settings:after|desc=List of scripts you want to run after burglary. This is run right after the burglary before processing the loot.}}^{{Lich setting|name=waggle_sets['burgle']|desc=Optional. A waggle set called 'burgle' to cast right before burglary.}}
|children=jail-buddy
}}

== carve ==
{{Lich script
|description=
|usage=
|args=
|settings=
|uservars=
|children=
}}

== charge-holy-weapon ==
{{Lich script
|description= Charges holy weapon if below 200 estimated remaining uses. Usable in Crossing or Shard Chadatru temples, or in a player-specified room using a holy icon. There is a large cooldown, and if too low circle & charisma, this could be bad. Best used independently on lower circle Paladins.
|usage= Run it as a before or after within training manager, as a normal part of T2's system, or as an independent script.
|settings={{Lich setting|name=holy_weapon|desc=Main setting which holds the other settings.}}^{{Lich setting|name=holy_weapon:weapon_name|desc=Name of the holy weapon, MUST match gear setting entry exactly.}}^{{Lich setting|name=holy_weapon:icon_name|desc=Name of the icon to use for the ritual.}}^{{Lich setting|name=holy_weapon:icon_container|desc=Name of the container which holds the icon, optional.}}^{{Lich setting|name=holy_weapon:icon_room|desc=Room number to use for the icon ritual.}}
}}

== chop-wood ==
{{Lich script
|description= Chops trees in a room while watching for danger
|usage= Watches and chops out your current room, stowing or deeding anything in your tree list. Will run to a healer if injured.
|args=
|settings={{Lich setting|name=holy_weapon|desc=Holds all the holy weapon settings.}}^{{Lich setting|name=weapon_name|desc=name of holy weapon, MUST match weapon in gear, <adj> <noun>}}^{{Lich setting|name=icon_name|desc=Name of the icon to use}}^{{Lich setting|name=icon_container|desc=Container which holds the icon (optional)}}^{{Lich setting|name=icon_room|desc=Room to do the icon ritual.}}
}}

== circlecheck ==
{{Lich script
|description=Circle check tells you how far you are from your next or target circle.
|usage=
Display circle progress:
* <code>;circlecheck</code>

Display only skills needed for the next circle:
* <code>;circlecheck short</code>
* <code>;circlecheck brief</code>
* <code>;circlecheck next</code>

Display progress towards circle 35
* <code>;circlecheck 35</code>
|args={{Lich setting|name=debug|desc=Turns on debugging messages.}}^{{Lich setting|name=short|desc=Uses short output mode, aliases brief, next}}^{{Lich setting|name=target|desc=Display progress towards target circle.}}
|settings=
|uservars=
|children=
}}

== cleric-quests ==
{{Lich script
|description=Automatically does cleric quests you are eligible for. Currently does tamsine, eluned, eluned2, kertigen, hodiera, meraud, and glythtide commune quests if you are the right level.
|usage=
|args=
|settings=
|uservars=
|children=
}}

== coordinator ==
{{Lich script
|description=Training manager script
|usage=
|args=
|settings=
|uservars=
|children=
}}

== combat-trainer ==
{{Lich script
|description= Train combat skills in your current room.
|usage= Trains combat skills in your current room, maintains listed buffs, uses TM/debil as specified, trains certain non combat actions on timers. Skins, loots.
|args={{Lich setting|name=d#|desc=Dance threshold, keep N mobs alive to train defenses against, where dN is the provided argument.}}^{{Lich setting|name=r#|desc=Retreat threshold, stay at missile range when N mobs are present and use ranged combat options, where rN is the provided argument.}}^{{Lich setting|name=construct|desc=overrides empath non attack settings.}}^{{Lich setting|name=debug|desc=Enables debug mode.}}^{{Lich setting|name=custom|desc= Extra arguments will be used to load in extra yaml files. <code>;combat-trainer back</code> would load in <code>YourName-back.yaml</code>.}}
|settings={{Lich setting|name=aiming_trainables|desc=Lets you train weapons in the offhand while aiming crossbows, slings, and bows. The weapon must be usable in the offhand for attacking/throwing, swappables are supported. Large weapons require weapons prime, and other conditions need to be met, etc. It works in conjunction with the settings attack_overrides (hurl/invoke supported) and using_light_crossbow.}}^{{Lich setting|name=using_light_crossbow|desc=Lets you designate that your Crossbow is light, this enables swinging attack options with aiming_trainables.}}^{{Lich setting|name=storage_containers|desc=List of containers to make sure are open before starting hunting.}}^{{Lich setting|name=dance_threshold|desc=Same as d# argument.}}^{{Lich setting|name=retreat_threshold|desc=Same as r# argument.}}^{{Lich setting|name=dance_skill|desc=Weapon skill to have active when dancing with enemies, ideally allows parry. Note this is the SKILL not the weapon.}}^{{Lich setting|name=combat_trainer_action_count|desc=Number of attacks to make with a given weapon before cycling.}}^{{Lich setting|name=combat_trainer_target_increment|desc=Number of mind states of exp to get before cycling weapons.}}^{{Lich setting|name=weapon_training|desc=Hash of weapon skills to the weapon names that you use to train that skill. Brawling should map to an empty string. This controls what weapons are cycled through for training.}}^{{Lich setting|name=gear|desc=List of gear that will be used in this script. Armor and Weapons.}}^{{Lich setting|name=gear:name|desc=Noun of the item.}}^{{Lich setting|name=gear:is_leather|desc=true if this is repaired at the leather repair npcs.}}^{{Lich setting|name=gear:hinders_lockpicking|desc=true if should be removed for lockpicking.}}^{{Lich setting|name=gear:skip_repair|desc=true if you want to skip repairing this item.}}^{{Lich setting|name=gear:is_worn|desc=true if the item is worn such as armor, shields, wearable weapons.}}^{{Lich setting|name=gear:swappable|desc=true if this is a swappable weapon.}}^{{Lich setting|name=gear:tie_to|desc=This is the name of what this weapon is tied to, e.g toolstrap.}}^{{Lich setting|name=gear:adjective|desc=Used to differentiate items with the same name, if TAP ADJECTIVE NAME doesn't work then these settings are wrong.}}^{{Lich setting|name=gear:bound|desc=true if the item bonded for hurl/invoke.}}^{{Lich setting|name=gear_sets:standard|desc=A list of ADJ NAME for each item that should show up in INV COMBAT when you're ready for combat. If it shows up in inv combat it must be here. This gear set will be equipped at the start of combat.}}^{{Lich setting|name=summoned_weapons|desc=List of summoned weapons/moonblades.}}^{{Lich setting|name=summoned_weapons:name|desc=The skill to make a summoned weapon for.}}^{{Lich setting|name=summoned_weapons:turn|desc= true to turn the summoned weapon}}^{{Lich setting|name=summoned_weapons:pull|desc=true to pull the summoned weapon}}^{{Lich setting|name=summoned_weapons:push|desc=true to pull the summoned weapon.}}^{{Lich setting|name=summoned_weapons_element|desc=Element to summon your weapon as, defaults to stone.}}^{{Lich setting|name=summoned_weapons_ingot|desc=noun of ingot to use for rare metal summoning.}}^{{Lich setting|name=stances|desc=Used to override defense selection for a given weapon skill, normally used to prevent parrying with ranged weapons or offhand. See base.yaml for usage.}}^{{Lich setting|name=use_stealth_attacks|desc=true to attempt to hide before attacking to use ambush/poach while stealth skill is not mindlocked. This will also attempt to hide before casting Vivisection.}}^{{Lich setting|name=ambush|desc=true to use stealth attacks to train backstab. Should only use either ambush or backstab flags at one time}}^{{Lich setting|name=ambush_location|desc=Set the ambush target for better backstab training for thieves.}}^{{Lich setting|name=backstab|desc=Valid settings are 'Small Edged', 'Offhand Weapon' or both. This will attack with either backstab or backstab left for the chosen skill. Ensure you have a suitable weapon for backstabbing setup in your 'weapon_training:' section for the desired weapon skill(s). This defaults to ambush if the mob can't be backstabbed.}}^{{Lich setting|name=charged_maneuvers|desc=Hash of charged maneuvers to use for each weapon skill.}}^{{Lich setting|name=fatigue_regen_threshold|desc=Will use bob instead of an attack when fatigue drops below this.}}^{{Lich setting|name=aim_fillers|desc=list of actions to take to fill time while aiming.}}^{{Lich setting|name=aim_fillers_stealth|desc=Used in place of aim fillers if stealth experience is not capped.}}^{{Lich setting|name=dance_actions|desc=List of actions to take while dancing with enemies.}}^{{Lich setting|name=dance_actions_stealth|desc=Used in place of dance actions while stealth is not capped.}}^{{Lich setting|name=ignored_npcs|desc=List of npc names to ignore, used to keep combat from trying to count/interact with pets, familiars, and roaming npcs. This is the single noun that identifies them, bear, warrior, Brokk. Currently caps sensitive.}}^{{Lich setting|name=stance_override|desc=remove custom stance logic and simply set stance to provided string. E.g. 100 80 0}}^{{Lich setting|name=skinning|desc=Hash of skinning related settings.}}^{{Lich setting|name=skinning:skin|desc=true to skin kills.}}^{{Lich setting|name=skinning:arrange_all|desc=true if you can use the arrange ALL command.}}^{{Lich setting|name=skinning:arrange_count|desc=Number of times to arrange}}^{{Lich setting|name=skinning:arrange_types|desc=Hash of creature noun to the type of arranging to do, eg rat:part. All arranging defaults to skin.}}^{{Lich setting|name=skinning:tie_bundle|desc=true to tie your bundles up to reduce weight and item count.}}^{{Lich setting|name=lootables|desc=Base list of nouns to loot, the noun must be at the end of the object name and not part of another word. Changes to this are better made through loot_additions and loot_subtractions. Pearl would loot "a tiny yellow pearl" but not "a pearl studded coat" nor would rock cause you to loot "a large crock".}}^{{Lich setting|name=loot_additions|desc=List of nouns to add into the base loot list, a common example is box nouns.}}^{{Lich setting|name=loot_subtractions|desc=List of things to remove from your looting list, for example ammunition you don't use.}}^{{Lich setting|name=thanatology|desc=Necromancer related settings, only partially implemented.}}^{{Lich setting|name=thanatology:heal|desc=If true, use necromancer-specific healing rituals and spells.}}^{{Lich setting|name=thanatology:ritual_type|desc=Name of the ritual to perform, i.e dissect}}^{{Lich setting|name=spare_gem_pouch_container|desc=Container that holds your spare gem pouch should your equipped one become full.}}^{{Lich setting|name=gem_pouch_adjective|desc=Adjective your gem pouch responds too.}}^{{Lich setting|name=buff_spells|desc=Hash of buff spells to maintain on you while hunting, the key to the hash must match the spells name exactly e.g buff_spells:See the Wind. Will generally cast buffs in the order listed here.}}^{{Lich setting|name=buff_spells:Spell Name:abbrev|desc=Abbreviation to use for prepping the spell.}}^{{Lich setting|name=buff_spells:Spell Name:recast|desc=Remaining duration in minutes on a buff to trigger a recasting. -1 will wait until the spell falls off.}}^{{Lich setting|name=buff_spells:Spell Name:recast_every|desc=Number of seconds to wait between recasts of this spell, for spells that recast or expire messages don't make sense.}}^{{Lich setting|name=buff_spells:Spell Name:expire|desc=A string that when seen will trigger this spell to be recast}}^{{Lich setting|name=buff_spells:Spell Name:mana|desc=Amount of mana to prep the spell with.}}^{{Lich setting|name=buff_spells:Spell Name:cambrinth|desc=List of charges to put into cambrinth, will use worn cambrinth that can't be charged worn, however don't list more than two charges or strange things can happen.}}^{{Lich setting|name=buff_spells:Spell Name:prep_time|desc=Time in seconds to wait before trying to cast the spell, optional, if not present waits until full prep.}}^{{Lich setting|name=buff_spells:Spell Name:before|desc=A custom action to take immediately before casting the spell.}}^{{Lich setting|name=buff_spells:Spell Name:before:message|desc=The message to send to the game.}}^{{Lich setting|name=buff_spells:Spell Name:before:matches|desc=List of strings that are possible responses for the message.}}^{{Lich setting|name=buff_spells:Spell Name:after|desc=A custom action to take immediately after casting the spell.}}^{{Lich setting|name=buff_spells:Spell Name:after:message|desc=The message to send to the game.}}^{{Lich setting|name=buff_spells:Spell Name:after:matches|desc=List of strings that are possible responses for the message.}}^{{Lich setting|name=buff_spells:Spell Name:moon|desc=true if spell requires a moon to cast.}}^{{Lich setting|name=buff_nonspells|desc=Nonspell buffs. Each has the format "action: timer", where 'action' will be output to the game every 'timer' number seconds.}}^{{Lich setting|name=buff_nonspells:barb_buffs|desc=Specific subsection for barbarian buffs. These require no timer, instead they trigger off of expiration and activation messaging. List by buff name, i.e. "Python", capitalization required.}}^{{Lich setting|name=buff_nonspells:khri|desc=Specfic sub section for Thief Khri. These require no timer. List skill by name. Capitalization not required.}}^{{Lich setting|name=offensive_spells|desc=TM and Debil spells to use. Debil spells will be recast when a mob dies or the expiration message is seen.}}^{{Lich setting|name=offensive_spells:skill|desc=Targeted Magic or Debilitation.}}^{{Lich setting|name=offensive_spells:abbrev|desc=Abbreviation used for preparing the spell.}}^{{Lich setting|name=offensive_spells:recast_every|desc=Number of seconds to wait between recasts of this spell, for spells that recast or expire messages don't make sense.}}^{{Lich setting|name=offensive_spells:expire|desc=String that will trigger a recast of the spell when seen.}}^{{Lich setting|name=offensive_spells:mana|desc=Amount of mana to prep the spell with}}^{{Lich setting|name=offensive_spells:cambrinth|desc=List of charges to put into cambrinth, will use worn cambrinth that can't be charged worn, however don't list more than two charges or strange things can happen.}}^{{Lich setting|name=offensive_spells:prep_time|desc=Time in seconds to wait before trying to cast the spell, optional, if not present waits until full prep.}}^{{Lich setting|name=offensive_spells:before|desc=A custom action to take immediately before casting the spell.}}^{{Lich setting|name=offensive_spells:before:message|desc=The message to send to the game.}}^{{Lich setting|name=offensive_spells:before:matches|desc=List of strings that are possible responses for the message.}}^{{Lich setting|name=offensive_spells:after|desc=A custom action to take immediately after casting the spell.}}^{{Lich setting|name=offensive_spells:after:message|desc=The message to send to the game.}}^{{Lich setting|name=offensive_spells:after:matches|desc=List of strings that are possible responses for the message.}}^{{Lich setting|name=offensive_spells:tattoo_tm|desc=Will tell the system to target the invoked tattoo spell, if it's Targeted Magic.}}^{{Lich setting|name=cambrinth|desc=Cambrinth item to charge for casting.}}^{{Lich setting|name=cast_messages|desc=Casting messages, if we're missing your custom message let us know!}}^{{Lich setting|name=prep_messages|desc=Spell Prep messages, see cast_messages.}}^{{Lich setting|name=empath_healing|desc=a VH entry here will control the mana used when vit drops. List of values is prep followed by cambrinth charges.}}^{{Lich setting|name=osrel_amount|desc=Amount to infuse into OM each try.}}^{{Lich setting|name=osrel_no_harness|desc=true if you don't need to harness before infusing.}}^{{Lich setting|name=kneel_khri|desc=true if you have to kneel to activate khri.}}^{{Lich setting|name=khri_preps|desc=Khri activation messages, let us know if yours is missing.}}^{{Lich setting|name=manipulate_threshold|desc=Number of enemies before attempting to manipulate.}}^{{Lich setting|name=training_abilities|desc=Special one off trainers during combat. Hash is training type keyed to cooldown in seconds.}}^{{Lich setting|name=training_abilities:PercMana|desc=Moon mage attunement training, retreats first.}}^{{Lich setting|name=training_abilities:Perc|desc=Attunement training with perc.}}^{{Lich setting|name=training_abilities:Perc Health|desc=Empathy training with perc heal.}}^{{Lich setting|name=training_abilities:Astro|desc=Predict weather for astrology training.}}^{{Lich setting|name=training_abilities:App|desc=Train appraisal by appraising enemies. Requires Approx 100 ranks for learning.}}^{{Lich setting|name=training_abilities:App Quick|desc=See above.}}^{{Lich setting|name=training_abilities:App Careful|desc=See above.}}^{{Lich setting|name=training_abilities:Locks|desc=Train locksmithing by picking pet boxes in combat.}}^{{Lich setting|name=training_abilities:Tactics|desc=Train tactics with weave, bob, and circle.}}^{{Lich setting|name=training_abilities:Analyze|desc=Train tactics by analyzing your opponent.}}^{{Lich setting|name=training_abilities:Hunt|desc=Train perception and possibly scouting with the hunt command.}}^{{Lich setting|name=training_abilities:Pray|desc=Pray to an immortal for theurgy.}}^{{Lich setting|name=training_abilities:Meraud|desc=Maintains the Meraud Commune.}}^{{Lich setting|name=training_abilities:Scream|desc=Train bardic lore with scream conc.}}^{{Lich setting|name=training_abilities:Stealth|desc=Train stealth with hiding and stalking.}}^{{Lich setting|name=training_abilities:Ret Stealth|desc=Retreat before stealth with hiding and stalking.}}^{{Lich setting|name=training_abilities:Teach|desc=Teach hunting_buddies if there are any in the room on this timer.}}^{{Lich setting|name=training_abilities:Recall|desc=Uses 'recall' on a mob in the room, which trains Scholarship}}^{{Lich setting|name=training_abilities:Ambush Stun|desc=Uses settings stun_weapon, stun_weapon_skill and stun_skill}}^{{Lich setting|name=stun_weapon|desc=The weapon you want to use to Ambush Stun. IE club or broadsword}}^{{Lich setting|name=stun_weapon_skill|desc=The skill that stun_weapon trains or you would like to swap it to train IE Small Blunt or Large Edged}}^{{Lich setting|name=stun_skill|desc=Set to either Backstab or Debilitation for the skill to watch while using Ambush Stun}}^{{Lich setting|name=training_abilities:Khri Prowess|desc=Trains Debilitation with Khri Prowess.}}^{{Lich setting|name=fatigue_regen_action|desc=Action to take when low on fatigue.}}^{{Lich setting|name=dual_load|desc=true if you're capable of dual load}}^{{Lich setting|name=dedicated_camb_use|desc=Set to 'cyclic' or 'spell' with respect to the magical feat}}^{{Lich setting|name=cycle_armors|desc=List of armor types and corresponding items from gear to rotate for training purposes}}^{{Lich setting|name=whirlwind_trainables|desc=Barb specific section for telling the combat-trainer which weapon skills you want to train with whirlwind. It requires one-handed templates, doesn't support two handed weapons, and will use the weapon listed under weapon_training.}}^{{Lich setting|name=barb_famine_healing|desc=Barb specific section for automatic usage of Berserk Famine when low health. Has two settings listed below as well as knowledge of Berserk Famine as requirements.}}^{{Lich setting|name=barb_famine_healing:health_threshold:|desc=Famine will be used when below this threshold.}}^{{Lich setting|name=barb_famine_healing:inner_fire_threshold|desc=Will not use Berserk Famine unless above this threshold.}}^{{Lich setting|name=wield|desc=Set to true or false; If true, then it wields and sheaths your weapon. This is very useful if you have weapons in different containers. With this set to true on each weapon (e.g. :wield: true in your gear settings), it will return them back from where they came with the wield and sheath commands.}}^{{Lich setting|name=hide_type|desc=Value of "stalk" changes hide type to "slip stalk". This will perform the command "stalk" instead of "hide" which activates "slip stalk". "Slip stalk" is only available for a number of professions and must be learned. Default value: hide. Uses hide as normal.}}^{{Lich setting|name=force_unhide|desc=Value of true will always unhide after hiding via Stealth timer under training_abilities:.}}^{{Lich setting|name=dont_stalk|desc=Value of true prevents stalk usage after hiding when hiding via Stealth timer under training_abilities:. Default value is false.}}
|uservars={{Lich setting|name=combat_trainer_debug|desc=Turns on debugging messages.}}
|children=tendme
}}

== corn-maze ==
{{Lich script
|description=Runs the Hollow Eve corn maze.
|usage=Run inside the large-form corn maze, anywhere in the starting 'labyrinth' or entrance area. This does NOT work with the short/single-task versions. The script will finish any pre-existing corn-maze task, then search the maze for incidental loot. Make sure to allow ten minutes between runs for the loot to respawn.
|args={{Lich setting|name=noloot|desc=Run as normal, but only pick up free corn maze passes from the incidentals.}}^{{Lich setting|name=restart|desc=Run as normal, but skip incidental looting entirely. Useful if you already looted this run and needed to restart the script for some reason.}}^{{Lich setting|name=manual|desc=Replaces loot-corn-maze.lic. Control your run manually. Pick up and complete tasks on your own. This will sit in the background, and search and loot any incidental objects you come across automatically.}}
|settings={{Lich setting|name=maze_junk|desc=What to throw away during incidental looting. See defaults in base.yaml, and copy to your setup yaml to change them. }}^{{Lich setting|name=cornmaze_containers|desc=A list of bags to try and put incidental loot into, top ones first. If all of them are full it'll try and STOW the item, and if that fails it'll drop it. By default, no bags listed.

cornmaze_containers:
- backpack
- rucksack
- satchel
}}
}}

== craft ==
{{Lich script
|description=Crafts one item.
|args={{Lich setting|name=outfitting|desc=Knit.}}^{{Lich setting|name=forging|desc=Forge a Blacksmithing item.}}^{{Lich setting|name=engineering|desc=Shape one item.}}
|settings={{Lich setting|name=yarn_quantity|desc=How much yarn to keep on hand for knitting, defaults to 100.}}^{{Lich setting|name=craft_max_mindstate|desc=What mindstate to make running the script a noop. Defaults to 31}}
}}

== crossing-repair ==
{{Lich script
|description=Repair items in your gear list.
|usage=Originally intended to be used in [[RanikMap1|The Crossing]]. The script now works outside [[RanikMap1|The Crossing]] with hometown set to: [[RanikMap30|Riverhaven]], [[RanikMap42|Therenborough]], [[RanikMap67|Shard]], [[RanikMap99|Aesry]], [[RanikMap107|Mer'Kresh]], [[RanikMap117|Hibarnhvidar]], [[RanikMap121|Boar Clan]], [[RanikMap150|Fang Cove]], [[RanikMap47|Muspar'i]], [[RanikMap106|Hara'jaal]], [[RanikMap61|Leth Deriel]], [[RanikMap34a|Rossman's Landing]], [[RanikMap40|Langenfirth]], or [[RanikMap90|Ratha]]
|args=
|settings={{Lich setting|name=repair_withdrawal_amount|desc=Amount in coppers to withdraw to cover repairs.}}^{{Lich setting|name=gear|desc=List of gear that will be used in this script. Armor and Weapons.}}^{{Lich setting|name=gear:name|desc=Noun of the item.}}^{{Lich setting|name=gear:is_leather|desc=true if this is repaired at the leather repair npcs.}}^{{Lich setting|name=gear:hinders_lockpicking|desc=true if should be removed for lockpicking.}}^{{Lich setting|name=gear:is_worn|desc=true if the item is worn such as armor, shields, wearable weapons.}}^{{Lich setting|name=gear:swappable|desc=true if this is a swappable weapon.}}^{{Lich setting|name=gear:tie_to|desc=This is the name of what this weapon is tied to, e.g toolstrap.}}^{{Lich setting|name=gear:adjective|desc=Used to differentiate items with the same name, if TAP ADJECTIVE NAME doesn't work then these settings are wrong.}}^{{Lich setting|name=gear:bound|desc=true if the item bonded for hurl/invoke.}}
|uservars={{Lich setting|name=crossing_repair_debug|desc=Turns on debugging messages.}}
|children=
}}

== crossing-training==
{{Lich script
|description=Trains non-combat skills. Despite the name, crossing-trainer this works in other towns using the hometown setting.
|usage= Cycles through skills training the lowest one in field experience at the time.

Skills that can be trained: Appraisal, Athletics, Astrology, Attunement, Augmentation, Warding, Utility, Debilitation, Empathy, Engineering, First Aid, Forging, Locksmithing, Mechanical Lore, Outdoorsmanship, Outfitting, Perception, Performance, Scholarship, Scouting, Sorcery, Stealth, Summoning, Theurgy, Thievery, Trading.

Additionally, the following skills can be trained only via research: Arcana, Life Magic, Holy Magic, Lunar Magic, Elemental Magic, Arcane Magic.
|args=
|settings={{Lich setting|name=train_with_burgle|desc=Set true to turn on burgle for locksmithing, thievery, stealth, and/or athletics. Needs burgle_settings:.}}^{{Lich setting|name=classes_to_teach|desc=List of subjects to teach people in your safe room}}^{{Lich setting|name=climbing_target|desc=Object to practice climbing on. Setting this causes you to climb practice during athletics training. Look in base-athletics for a list of climbing targets.}}^{{Lich setting|name=use_research|desc=Whether or not to use research when training magic skills. Requires train_with_spells to be true.}}^{{Lich setting|name=outdoor_room|desc=Used for spells requiring moons.}}^{{Lich setting|name=perform_options|desc=List in base-perform.yaml of playstyles sorted by difficulty.}}^{{Lich setting|name=storage_containers|desc=A list of containers to open before starting training.}}^{{Lich setting|name=crossing_training_requires_movement|desc=Skills which require movement as part of their training. This is used to avoid spamming the safe room with repeated entry/exit messages.}}^{{Lich setting|name=trash_nouns|desc=Nouns that can be thrown away without warning}}^{{Lich setting|name=crossing_training|desc=List of skills to train. Supported Skills - Appraisal (requires zills), Athletics, Arcana/Primary Magic(requires research enabled), Astrology, Attunement, Augmentation, Warding, Utilty, Debilitation(barb only?), Empathy, Engineering(workorders), First Aid (needs compendium), Forging (workorders or raw smithing), Locksmithing, Mechanical Lore, Outdoorsmanship, Outfitting(workorders or knitting), Perception, Performance(zills), Scholarship(blacksmithing book), Scouting(enough ranks for trails), Sorcery, Stealth (low ranks only), Summoning, Theurgy(see theurgy script), Thievery, Trading(workorders).}}^{{Lich setting|name=safe_room|desc=Room Id where you do any stationary training and listen for classes.}}^{{Lich setting|name=exit_on_skills_capped|desc=Whether or not to exit the game when all skills are locked}}^{{Lich setting|name=crossing_training_sorcery_room|desc=The room to use when training sorcery. MAKE SURE THIS ROOM IS LAWLESS by typing 'justice'.}}^{{Lich setting|name=crossing_training_sorcery|desc=Action to take when training sorcery}}^{{Lich setting|name=listen|desc=Whether or not you should attempt to listen to classes while training}}^{{Lich setting|name=train_with_spells|desc=}}^{{Lich setting|name=cyclic_training_spells|desc=Cyclic Spells to use when training.}}^{{Lich setting|name=cyclic_cycle_skills|desc=Skills to train with cyclic spells during crossing-training.}}^{{Lich setting|name=training_spells|desc=Spells to use when training magic skills. TODO: Make this its own page.}}^{{Lich setting|name=research_skills|desc=}}^{{Lich setting|name=exp_timers|desc=Cooldown timers between attempts to train a given skill}}^{{Lich setting|name=training_nonspells|desc=}}^{{Lich setting|name=kneel_khri|desc=}}^{{Lich setting|name=khri_preps|desc=If you use Khri for training, make sure their prep messages are recorded here}}^{{Lich setting|name=prep_scaling_factor|desc=This scaling factor is multiplied by your discerned max mana for a spell. The mana to be removed is rounded up, so anything < 1.0 will always result in at least one mana removed.}}^{{Lich setting|name=cambrinth_cap|desc=The maximum amount of mana your cambrinth can hold}}^{{Lich setting|name=osrel_amount|desc=}}^{{Lich setting|name=osrel_no_harness|desc=}}^{{Lich setting|name=held_cambrinth|desc=Whether or not you need to hold your cambrinth to charge it}}^{{Lich setting|name=stored_cambrinth |desc=Whether or not your cambrinth item is stored (false indicates worn)}}^{{Lich setting|name=cambrinth|desc=The noun for the cambrinth you use. Multiple cambrinth is not yet supported.}}^{{Lich setting|name=prep_messages|desc=If you cast spells for training, make sure their prep messages are recorded here}}^{{Lich setting|name=cambrinth_cap |desc=The maximum amount of mana your cambrinth can hold}}^{{Lich setting|name=forage_item|desc=}}^{{Lich setting|name=hand_armor|desc=Noun of any armor that needs to be removed when braiding}}^{{Lich setting|name=braid_item|desc=}}^{{Lich setting|name=athletics_options|desc=}}^{{Lich setting|name=trail_override|desc=}}^{{Lich setting|name=art_options|desc=}}^{{Lich setting|name=train_workorders|desc=Disciplines to train via workorders when training that skill}}^{{Lich setting|name=work_order_disciplines|desc=Disciplines to train via workorders when training Trading}}^{{Lich setting|name=tithe|desc=Whether or not to tithe (two boxes are supported), with a cooldown of 4 hours}}^{{Lich setting|name=cleaning_cloth|desc=The type of cleaning cloth to use when zills are dirty}}^{{Lich setting|name=dedicated_camb_use|desc=Set to 'cyclic' or 'spell' with respect to the magical feat}} ^{{Lich setting|name=wield|desc=Set to true or false; If true, then it wields and sheaths your weapon. This is very useful if you have weapons in different containers. With this set to true on each weapon (e.g. :wield: true in your gear settings), it will return them back from where they came with the wield and sheath commands.}}^{{Lich setting|name=dedicated_camb_use|desc=Set to 'cyclic' or 'spell' with respect to the magical feat}}
|uservars={{Lich setting|name=crossing_trainer_debug|desc=Turns on debugging messages.}}
|children=attunement, pick, sell-loot, theurgy, safe-room, workorders, sew, smith
}}

== crowns ==
{{Lich script
|description=Plays the Hollow Eve's game dice/crowns.
|usage=
|args=
|settings={{Lich setting|name=dice_bet_amount|desc=Put this in your yaml and set to some whole number, like dice_bet_amount: 10.}}^{{Lich setting|name=dice_money_on_hand|desc=How much money to withdraw from the bank.}}^{{Lich setting|name=dice_withdraw|desc=Withdraw money from the bank setting.}}^{{Lich setting|name=hollow_eve_loot_container|desc=Storage container name.}}
|uservars=
|children=
}}

== dusk-labyrinth ==
{{Lich script
|description=Searches for pets, bloodscrip, and loot in [[Drathrok%27s_Duskruin#Labyrinth|Duskruin Labyrinth]].
|usage=Configure your settings, enter the labyrinth, then start the script. The script will wait for messaging about a critter scurrying about and either try to catch it or move to another room. If no pet has been found by the 5 minute warning then it begins to search each room to collect bloodscrip and incidentals.
|args={{Lich setting|name=debug|desc=(optional) Turns on debugging messages.}}
|settings={{Lich setting|name=duskruin:labyrinth:pet_noun|desc=(required) Kind of pet searching for, such as '''monkey''' or '''rat'''.}}^{{Lich setting|name=duskruin:labyrinth:loot_container|desc=(optional) Which container to put the bloodscrip and items you find when searching. If not specified then relies on {{com|STOW}} left/right.}}^{{Lich setting|name=duskruin:labyrinth:redeem_scrip|desc=(optional) Set to '''true''' to auto redeem any found bloodscrip. Default is ''false''.}}
|uservars={{Lich setting|name=dusk_labyrinth_debug|desc=(optional) Turns on debugging messages.}}
|children=
}}

== echo ==
{{Lich script
|description=
|usage=
|args=
|settings=
|uservars=
|children=
}}

== edityaml ==
{{Lich script
|description=
|usage=
|args=
|settings=
|uservars=
|children=
}}

== equipmanager ==
{{Lich script
|description=
|usage=
|args=
|settings=
|uservars={{Lich setting|name=equipmanager_debug|desc=Turns on debugging messages.}}
|children=
}}

== expreset ==
Resets your EXP window in Stormfront. This is useful for removing erroneous game output that gets 'stuck' in your exp window (usually during connection).
{{Lich script
|description=
|usage=
|args=
|settings=
|uservars=
|children=
}}

== faux-atmo ==
{{Lich script
|description=Bring your verby items to life! Turn toys and items with fun verbs into [[Atmospheric_item|atmospherics]] by periodically performing a random verb on a random item based on your settings.
|usage=Configure which items and verbs you want to periodically do then start the script. It runs in the background.
|args={{Lich setting|name=debug|desc=Enable debug mode.}}
|settings=
* Example Settings:
<pre>
# Number of minutes to wait between performing a verb on an item.
faux_atmo_interval: 15

# Set to true to randomly select an item and verb to perform.
# Set to false to round-robin select items and verbs to perform.
faux_atmo_random: true

# Items that don't have an inherent atmo effect
# but whose verbs if done periodically would.
faux_atmo_items:
- name: blue basilisk
verbs:
- pet
- pinch
- poke
- name: hooded cloak
verbs:
- rub
- pat
- wave

# Don't perform verbs on items if these scripts are running.
faux_atmo_no_use_scripts:
- combat-trainer
- go2
- get2
- bescort
- steal
- burgle

# Don't perform verbs on items if in these rooms.
faux_atmo_no_use_rooms:
- Carousel Chamber # Room with vault
- Carousel Booth # Room just before vault
- 1900 # You can specify room ids, too
</pre>
|uservars={{Lich setting|name=faux_atmo_debug|desc=Enable debug mode.}}
|children=
}}

== favor ==
{{Lich script
|description=Gets one favor by rubbing an orb repeatedly.
|usage=
It is intended to be used in [[RanikMap1|The Crossing]].

If an argument is passed to the script, that Immortal's name will be used. The default is Hodierna.
|args=
|settings=
|uservars=
|children=
}}

== fill-dirt ==
{{Lich script
|description=Fills a dirt stacker with dirt.
|usage=Run the script in any room where dirt is forageable.
|args=
|settings={{Lich setting|name=dirt_stacker|desc=Name of dirt stacker to fill. Must be worn.}}
|uservars=
|children=
}}

== find ==
{{Lich script
|description=Finds an NPC in [[RanikMap1|The Crossing]].
|usage=
|args={{Lich setting|name=npc|desc=A unique name (or noun) of the NPC to find.}}^{{Lich setting|name=follow|desc=If present, the script will follow the NPC around.}}
|settings=
|uservars=
|children=
}}

== find-darkbox ==
{{Lich script
|description=Finds and plays the Hollow Eve's game Darkbox.
|usage=
|args={{Lich setting|name=override|desc=Optional arg. Passes override to heal-remedy to use remedies instead of herbs if you already have herbs setup in your yaml.}}
|settings={{Lich setting|name=he_use_herbs_remedies|desc=Put this as true in your yaml if you want to use heal-remedy.}}^{{Lich setting|name=hollow_eve_loot_container|desc=Storage container name.}}
|uservars=
|children=
}}

== first-aid ==
{{Lich script
|description=Trains the First Aid skill by reading compendiums or textbooks More in-depth look at first-aid.lic: https://github.com/rpherbig/dr-scripts/wiki/First-Aid-Strategy
|usage=
|args=
|settings={{Lich setting|name=textbook|desc=False if using a compendium, true otherwise.}}^{{Lich setting|name=textbook_type|desc=If not using a compendium, the name of the thing to study.}}^{{Lich setting|name=compendium_type|desc=Will default to compendium but also supports burgled manuals and guides.}}
|uservars=
|children=
}}

== faskinner ==
{{Lich script
|description=Trains the First Aid skill with training items such as a small blue-belly crocodile with prominently stitched seams or a small fuzzy caracal with tufted ears and double-stitched seams.
|usage=
|args=
|settings={{Lich setting|name=fa_skinning_trainer|desc=Noun of the trainer such as crocodile or caracal.}}^{{Lich setting|name=fa_skinning_priority|desc=Exit when mindlock on Skinning, First Aid, Both, or leave empty for whichever occurs first to avoid wasting charges.}}
|uservars=
|children=
}}

== feed-cloak ==
{{Lich script
|description=Feeds [[living vine cloaks]] that you are wearing so that they stay refreshed and healthy.
|usage=Run on demand or part of a training routine to feed your cloak regularly. Does not run in the background.
|settings=
* Example Settings:
<pre>
# If your cloak can't feed in your current room
# then feed-cloak will move to this specified room id.
# If not specified, or if the cloak can't feed here either,
# then the script will move to your `safe_room`.
feed_cloak_room: 992 # Crossing, [Northeast Wilds, Outside Northeast Gate]
</pre>
}}

== forge ==
{{Lich script
|description=Forges an item. Adapted from a script by Mallitek.
|usage=
EXAMPLES:

<code>;forge weaponsmithing 2 sword steel sword</code>

<code>;forge blacksmithing 6 "shallow metal cup" bronze cup</code>

<code>;forge blacksmithing 6 scratcher bronze scratcher</code>

<code>;forge temper sword</code>
|args={{Lich setting|name=type|desc=Type of book (blacksmithing, armorsmithing, weaponsmithing)}}^{{Lich setting|name=chapter|desc=Chapter of the book}}^{{Lich setting|name=recipe|desc=the name of the recipe}}^{{Lich setting|name=metal|desc=metal type of the ingot in your bag}}^{{Lich setting|name=noun|desc=item noun to make}}
|settings=
|uservars=
|children=
}}

== gbox ==
{{Lich script
|description=Hand all boxes from a container (the first argument) to a character (the second argument).
|usage=
|args={{Lich setting|name=container|desc=The container}}^{{Lich setting|name=character|desc=The character}}
|settings=
|uservars=
|children=
}}

== glyph-of-mana ==
{{ Lich script
|description=A script that will keep glyph of mana up always.
|usage=Meant to be used as a during: in combat but can be used anywhere.
<pre>
# Example usage:
hunting_info:
- :zone: cinder_beasts
args:
- d1
stop_on:
- Small Edged
:duration: 55
before:
- go2 12345
- mech-lore
- athletics
during:
- glyph-of-mana
</pre>
|args=
|settings=
|uservars=
}}

== gmoney ==
{{Lich script
|description=Hand money to the given character. The money is given 10 plat at a time, depositing first to minimize coinage (i.e. hand off plat instead of copper where possible). Useful for F2P players who cannot deposit more than 10 plat at once.
|usage=Start the script while you and the other player are standing at a bank teller.
|args={{Lich setting|name=character|desc=The character}}
|settings=
|uservars=
|children=
}}

== heal-remedy ==
{{Lich script
|description=Uses crafted remedies for healing
|usage=This script will cycle through the remedies, from base-remedies.yaml, from the most potent to least potent. The script will pause a little bit, letting the remedies work to make scars, then apply scar remedies. Will need one hand free to use.
|args={{Lich setting|name=override|desc=Override setting to force using remedies instead of herbs if herbs are already defined in your yaml.}}
}}

== healme ==
{{Lich script
|description=A self healing script for empaths
|usage=Will heal your own wounds, leaving external bleeders as desired. Uses Heal preferentially if configured and not attempting to keep bleeders. Targets wounds on potentially lethal body parts first, otherwise heals in severity order.
<pre>
#the first line is prep amount, second is a single cambrinth charge
empath_healing:
HW:
- 1
- 1
HS:
- 1
- 1
#HEAL:
#- 15
</pre>
|args={{Lich setting|name=Bleeders|desc=any body parts to leave external wounds on, quote two word body parts.}}
|settings={{Lich setting|name=prep_messages|desc=Used for spell casting matching and lives in base.yaml please submit custom prep messages as needed.}}^{{Lich setting|name=cambrinth|desc=noun for cambrinth used for casting}}^{{Lich setting|name=held_cambrinth|desc=true if you cannot charge your cambrinth worn}}^{{Lich setting|name=stored_cambrinth|desc= true if your cambrinth is stored in a container instead of worn}}^{{Lich setting|name=empath_healing:HW|desc=List of mana amounts. preps HW with the first the rest will be charged into cambrinth}}^{{Lich setting|name=empath_healing:HS|desc=List of mana preps for HS}}^{{Lich setting|name=empath_healing:HEAL|desc=List of mana preps for HEAL}}
|uservars={{Lich setting|name=healme_debug|desc=Turns on debugging messages.}}
}}

== horse-trainer ==
{{Lich script
|description=Teaches all skills to a horse.
|usage=This script will go through the list of skills and try to teach a horse. The order teaches is leadrope, saddle, animal, joust, kneel, prance, beg, spin, jump, combat, magic, war. You must be a Ranger to run this.
|args=
}}

== hunting-buddy==
{{Lich script
|description= Trains combat skills (using combat-trainer) in defined hunting areas
|usage= Will move through a series of defined hunting spots, training at each one until specified conditions are met. Stops at the first empty room it finds in the hunting area, will search for hiding players and wait 10 seconds for them to take any actions in rooms with monsters, moving on if a player is already there.
|args=
|settings={{Lich setting|name=training_manager_hunting_priority|desc=Set to true and and you will stay in hunting spots until stop_on skills are at 32/34, set to false and you will stay until stop_on or duration is met.}}^{{Lich setting|name=hunting_zones|desc=The set of hunting areas defined in base.yaml that can be directly reached with go2.}}^{{Lich setting|name=escort_zones|desc=The set of hunting areas defined in base.yaml that requires custom pathing to reach.}}^{{Lich setting|name=hunting_info|desc=In order list of hunts.}}^{{Lich setting|name=hunting_info:zone|desc=Name of hunting zone, must match one of the two zone lists above.}}^{{Lich setting|name=hunting_info:args|desc=List of arguments to call combat-trainer with at this hunting area.}}^{{Lich setting|name=hunting_info:full_waiting_room|desc=Room to wait in while the zones are full, defaults to safe_room number if not present.}}^{{Lich setting|name=hunting_info:duration|desc=Time in minutes to hunt here if hunting_priority is false.}}^{{Lich setting|name=hunting_info:stop_on|desc=List of skills that will stop hunting when they are all at 32/34}}^{{Lich setting|name=hunting_info:boxes|desc=Sets the hunt as a box priority hunt, will stop or skip if you have box_loot_limit number of boxes if set to true}}^{{Lich setting|name=hunting_buddies|desc=List of PC's that you're ok to share a hunting room with, remember proper Capitalization.}}^{{Lich setting|name=hunting_nemesis|desc=List of PC's you do not want to hunt with, remember proper Capitalization.}}^{{Lich setting|name=empty_hunting_room_messages|desc=List of messages to use when asking if a room is empty. A random message will be used each hunt.}}^{{Lich setting|name=prehunt_buffs|desc=Room number where you can cast buffs before beginning hunt. List buffs under waggle_sets: with same heading prehunt_buffs:.}}^{{Lich setting|name=hunting_room_min_mana|desc=Minimum mana level of an acceptable hunting room.}}^{{Lich setting|name=hunting_room_strict_mana|desc=If false, it will find any empty room in the event that no empty rooms are found above the minimum mana level.}}^uservars=
|children=combat-trainer, buff
}}

== inventory-manager ==
{{Lich script
|description= Stores current "inv list" data in a YAML file for searching from any character... works across multiple accounts.
|usage= Store and access any character's "inventory list". Prints a list of character names stored, prints individual inventory, and searches all inventory for any keyword(s).
|args={{Lich setting|name=save|desc=Executes game command "inv list" and saves all items to database labeled as either worn or in container.}}^{{Lich setting|name=search|desc=Searches database for text provided. Requires an item for which to search.}}^{{Lich setting|name=list|desc=Shows all character(s) names stored within the database. Optional input of a character's name to list their inventory.}}^{{Lich setting|name=remove|desc=Removes character and associated data from database, requires a name.}}
}}

== jail-buddy ==
{{Lich script
|description= Handles being arrested in the crossing
|usage= Keep running.
|args=
|settings=
|uservars=
|children=
}}

== join-thieves ==
{{Lich script
|description=Joins the thieves guild in Crossing.
|usage=
|args=
|settings=
|uservars=
|children=
}}

== journal ==
{{Lich script
|description=A script to use an epistemic journal. Best used as an after:
|args=
|settings=
|uservars= ''journal_noun'': Set the noun of your journal, defaults to journal
|children=
}}

== lamprey ==
{{Lich script
|description=Plays the Hollow Eve's game lamprey. Can only play this game once every 10 minutes if you get a lamprey or prize.
|usage=
|args=
|settings={{Lich setting|name=hollow_eve_loot_container|desc=Storage container name.}}
|uservars=
|children=
}}

== levelup ==
{{Lich script
|description=Walks to your guild leader and levels up as many times as you can.
|usage= <pre>;levelup</pre>
|args=
|settings=
|uservars=
|children=
}}

== locksmithing ==
{{Lich script
|description= Trains locksmithing independently or with crossing-training. Can use unlimited training boxes, daily charge training boxes, or limited use disposable training items such as corn maze pouches, liquor cabinets, or burgled keepsake boxes.
|usage= Can be used independently or by listing Locksmithing under crossing_training. If used with crossing_training additional feature <code>train_with_burgle: true</code> is available. The burgle_settings: loot_container is a shared feature for ease of use with keepsake boxes. [[Lich_script_repository#burgle]] information above.

Example Settings:
<pre>
## Locksmithing Settings ##

# use ;pick and pick settings first
pick_live_boxes: true

# second option to a daily use lockbox trainer like a training box or harvest bag
have_training_box: false
picking_lockbox: training box
picking_worn_lockbox: false

# IMPORTANT! Consumable boxes will be pulled from your burgle_settings: loot_container and should be kept separate from live boxes.
# list as many as you want - though it will try from the top down.
# THESE BOXES WILL BE DROPPED. MAKE CERTAIN YOU ONLY LIST THROW-AWAY TRAINERS.
consumable_lockboxes:
# - keepsake box
# - liquor cabinet
</pre>

|args=
|settings={{Lich setting|name=pick_live_boxes|desc=True or False to train with trapped boxes.}}^{{Lich setting|name=have_training_box|desc=True or False to use an unlimited or daily charge training box}}^{{Lich setting|name=picking_lockbox|desc=TAP adjective and noun of the permanent training box}}^{{Lich setting|name=picking_worn_lockbox|desc=Is the permanent training box worn? True/False}}^{{Lich setting|name=consumable_lockboxes|desc=A list of consumable trainers in the '''burgle_settings: loot_container'''. Format sample above.}}
|uservars=
|children=
}}

== makesteel ==
{{Lich script
|description= Makes steel ingots. The script will handle acquiring the needed materials.
|usage= <pre>;makesteel count [type] [refine]</pre>
|args= {{Lich setting|name=count|desc= (required) number of ingots to produce}}^{{Lich setting|name=type|desc=Carbon content, defaults to high. Options are: [l, m, h]}}^{{Lich setting|name=refine|desc=If provided, refine the resulting ingot}}
|settings={{Lich setting|name=hometown|desc=City in which to make the ingots, defaults to Crossing}}
|uservars=
|children=
}}

== mine ==
{{Lich script
|description= Mines a room while watching for danger
|usage= Prospects and mines out your current room, stowing or deeding anything in your vein list. Will prospect careful for more materials after exhausting the room.
|args=
|settings={{Lich setting|name=mining_buddy_vein_list|desc=List of metals and rocks that you wish to mine.}}^{{Lich setting|name=mine_implement|desc=Shovel or pick.}}^{{Lich setting|name=mine_use_packet|desc=Set to true to carry and use a deed packet, otherwise stow found minerals}}
|uservars=
|children=safe-room
}}

== mining-buddy ==
{{Lich script
|description= Perform a single pass through the mines
|usage= Will navigate through all listed mines, prospecting and stopping to mine anywhere it finds a resources it watches for. Can alternatively mine out each room it comes to, or merely look for resource rich rooms if you lack the skill to see resources. Will keep 1 plat on hand for repairs and buying deed packets. Will heal on injuries due to failed danger checks, or exit if buried.
|args=
|settings={{Lich setting|name=mining_buddy_rooms|desc=Defined in base.yaml, links mine names to a list of rooms}}^{{Lich setting|name=mines_to_mine|desc=List of mine names to mine, matches up against mining_buddy_rooms.}}^{{Lich setting|name=mining_skip_populated|desc=Set to true will NOT prospect and mine in rooms with other players.}}^{{Lich setting|name=mining_buddy_mine_every_room|desc=Set to true will prospect and mine out each room regardless of minerals.}}^{{Lich setting|name=mining_buddy_vein_list|desc=List of metals and rocks that you wish to mine.}}^{{Lich setting|name=mine_implement|desc=Shovel or pick.}}^{{Lich setting|name=mine_use_packet|desc=Set to true to carry and use a deed packet, otherwise stow found minerals}}
|uservars={{Lich setting|name=mining_debug|desc=Turns on debugging messages.}}
|children=mine,safe-room
}}

== mining-manager==
{{Lich script
|description=repeatedly mines in defined mining areas (using mining-buddy)
|usage=
|args=
|settings=
|uservars=
|children=
}}

== mm ==
{{Lich script
|description=A general purpose moon mage utility script
|usage= Run the script without any arguments to see usage
|args= {{Lich setting|name=locate <name>|desc=Locates the given name and reports the room number if the locate was successful}}^{{Lich setting|name=rift <name>|desc=Locates and rifts the given name to your current room. Checks if the moons are up. Uses the same settings as <code>;mm locate</code>}}
|settings= {{Lich setting|name=waggle_sets['locate']|desc=Optional. A waggle set called 'locate' with only the locate spell in it. Uses the data in DISCERN locate otherwise.}}^{{Lich setting|name=waggle_sets['rs']|desc=Optional. A waggle set called 'rs' with only the locate Riftal Summons spell in it. Uses the data in DISCERN RS otherwise.}}
|uservars=
|children=
}}

== moonwatch ==
{{Lich script
|description=populates UserVars.moons with data related to the moons
|usage=
Moonwatch will populate UserVars with the following data:
<code>
UserVars.moons = {
'katamba' => { 'pretty' => 'Katamba is up for 35 minutes', 'rise' => nil, 'set' =>35 },
'yavash' => { 'pretty' => 'Yavash will rise in 150 minutes', 'rise' => 150, 'set' => nil },
'xibar' => { 'pretty' => 'Xibar is up for 5 minutes', 'rise' => -1, 'set' => 5 }
'visible' => ['katamba', 'xibar']
}
</code>

We suggest using an alias such as:

<code>;alias add moon = ;eq respond("#{UserVars.moons['katamba']['pretty']} : #{UserVars.moons['yavash']['pretty']} : #{UserVars.moons['xibar']['pretty']}")</code>

You can {{com|PERCEIVE}} an individual moon to reset its data or [[Moon_Mage_attunement#Power Perception|PERCEIVE MOONS]] to reset all if this is a first start (or you've been offline for a while and the data seems wrong).
|args={{Lich setting|name=debug|desc=Turns on debugging messages.}}
|settings=
|uservars={{Lich setting|name=moon_debug|desc=Turns on debugging messages.}}
|children=
}}

== newbie-gear==
{{Lich script
|description=Crafts a set of gear for a new character.
|usage=
|args={{Lich setting|name=storage|desc=The container in which to store finished items}}
|settings=
|uservars=
|children=
}}

== oshu_manor ==
{{Lich script
|description=Navigates you through the Oshu Manor. Used to hunt [[Seordhevor kartais]]. Note there is an underscore in this script's name, not a dash.
|usage=
|args=
|settings=
|uservars=
|children=
}}

== paladin-quests ==
{{Lich script
|description=Completes the paladin Glyph quests for you.
|args={{Lich setting|name=warding|desc=Complete the Glyph of Warding Quest.}}{{Lich setting|name=bonding|desc=Complete the Glyph of Bonding Quest.}}{{Lich setting|name=light|desc=Complete the Glyph of Light Quest.}}{{Lich setting|name=mana|desc=Complete the Glyph of Mana Quest.}}{{Lich setting|name=ease|desc=Complete the Glyph of Ease Quest.}}{{Lich setting|name=renewal|desc=Complete the Glyph of Renewal Quest.}}
|settings=
|uservars=
|children=
}}

== pattern-hues ==
{{Lich script
|description=Casts Warrior Mage Pattern Hues cantrip at set intervals.
|usage= The script will cast pattern hues cantrip based on settings in yaml. If no custom settings set, will cast a random color. Examples: ;pattern-hues now will cast now and exit. ;pattern-hues in you before, after, t2, manually, or in a personal startup script will change cast the cantrip on your interval and with settings. Leave pattern and hue empty if you want to pick from all the available options. Put what you only want the color to go to for random. Custom is for those lucky enough to have their own color (Dartellum has a custom color). Or, put the exact color you want in gesture, such as bright emerald.
|args= {{Lich setting|name=now|desc=Cast now.}}{{Lich setting|name=debug|desc=Output variable values.}}
|settings={{Lich setting|name=Pattern Hues yaml settings: gesture is either random, custom, or a specific setting.}}
pattern_hues:
duration: 600
gesture: custom
pattern_hues_styles:
pattern:
- bright
- hazy
- gleaming
- lucent
hue:
- soot black
- emerald
- bone white
- snowflake white
- yellow
- charcoal black
- sky blue

|uservars=
|children=
}}

== pay-debt ==
{{Lich script
|description=Pays your debt. Optionally retrieves your sack of belongings from the guard house.
|usage=
|args=
|settings=
|uservars=
|children=
}}

== performance ==
{{Lich script
|description=Script to train performance. Defaults to worn instrument but accepts an instrument setting
|usage=
|args=
|settings={{Lich setting|name=instrument|desc=Optional. The instrument you would like to use. Defaults to worn instrument if none selected}}
|uservars=
|children=
}}

== performance-monitor ==
{{Lich script
|description=Logs combat-related events such as damage, roundtime, etc. for later parsing.
|usage=
|args=
|settings=
|uservars=
|children=
}}

== pick ==
{{Lich script
|description=Disarms, harvests, and unlocks boxes
|usage=The script will look for suitable disposal sources in the room, or drop refuse on the ground. Refills lockpicking ring after finished.
|args={{Lich setting|name=pets|desc=Disarm boxes and place them in the pet box container}}^{{Lich setting|name=count|desc=How many pet boxes to make }}^{{Lich setting|name=refill|desc=Refill your lockpick ring}}
|settings={{Lich setting|name=stop_pick_on_mindlock|desc=true to stop after the current box when your mind is full.}}^{{Lich setting|name=use_lockpick_ring|desc=Do you wear a lockpick ring?}}^{{Lich setting|name=skip_lockpick_ring_refill|desc=Set this to TRUE in order to skip buying lockpicks after mind-locked. This is important if you have crafted lockpicks on the ring, since you can't use lockpicks of differing qualities on the same ring.}}^{{Lich setting|name=lockpick_type|desc=Type of lockpick to stock on ring.}}^{{Lich setting|name=harvest_traps|desc=true to harvest traps while disarming.}}^{{Lich setting|name=picking_box_source|desc=The bag that unopened boxes are stored in.}}^{{Lich setting|name=picking_box_storage|desc=The bag to put boxes into that are too difficult to disarm.}}^{{Lich setting|name=picking_pet_box_source|desc=The bag that disarmed pet boxes are stored in.}}^{{Lich setting|name=lockpick_dismantle|desc=If you have a custom dismantle type to use, put it here.}}^{{Lich setting|name=lockpick_buffs:spells:abbrev|desc=abbreviation of a buff to put up before picking.}}^{{Lich setting|name=lockpick_buffs:spells:mana|desc=amount of mana to use for prep.}}^{{Lich setting|name=lockpick_buffs:spells:cambrinth|desc=List of cambrinth charges, see crossing-training for cambrinth related settings.}}^{{Lich setting|name=lockpick_buffs:khri|desc=List of khri to turn on before lockpicking.}}^{{Lich setting|name=lockpick_room_id|desc=Select a specific room number to open boxes to avoid blowing up your neighbors}}
|uservars={{Lich setting|name=lockpick_debug|desc=Turns on debugging messages.}}
|children=
}}

== release_cyclic ==
{{Lich script
|description=Releases all cyclic spells.
}}

== ranger-companion ==
{{Lich script
|description=Summons a companion and feeds it milk or corn if it's a baby, handles raising a baby pet to young age. Meant to be used as a during: in combat but works anywhere as long as you are stationary.
}}

== researcher ==
{{ Lich script
|description=Does research on a single subject.
|usage=Specify the subject as an argument, e.g. ;researcher augmentation
|args=missing
|settings=missing
|uservars=missing
|children=missing
}}

== register ==
{{ Lich script
|description=A script for searching your deed register.
|usage=The script will search your deed register for the specified crafting material.

Example: <code>;register damite</code>
--- Lich: register active.
;Output of reading register not shown here to save space.
Results:
45 -- a deed for a damite ingot (48V 91Q - pure Damite --Binu)
46 -- a deed for a damite ingot (10V 86Q - pure Damite --Binu)
[register]>stow right
You put your register in your hunting pack.
--- Lich: register has exited.

|args={{Lich setting|name=query|desc=The material you want to search for. Can also be information you entered in the deed note.}}
|settings={{Lich setting|name=crafting_container|desc=The name of the container where you store your deed register.}}
|uservars=
|children=
}}

== remedy ==
{{ Lich script
|description=A script for crafting remedies using alchemy.
}}

== repeat ==
{{ Lich script
|description=A script for repeating a sequence of up to 10 commands. Does not take scripts.
|usage=>;repeat "get my rock" "drop my rock"
}}

== restock ==
{{ Lich script
|description=A script for restocking your supply of stackable and nonstackable items.
|usage= Will parse your YAML for a restock set and make the appropriate purchases to maintain your desired quantity. This is called at the start of hunting-buddy as the preferred mechanism to maintain ammunition counts.
|args=
|settings={{Lich setting|name=restock|desc=list of item names or hashes. A name will be searched in base-consumables based on your hometown setting. It will go and purchase the appropriate version of that item found in that hometown. For example, lising "arrow" will purchase boar-tusk arrows in Crossing, but if your in Shard will purchase long arrows. Any of the values pulled from base-consumables can be overridden by providing by appropriate key-value-pair under the item name within your YAML. Not all cities have every type of item (for example only the Crossing sells rocks or sling/ammo). As such, you can explicitly define your own items within the YAML by setting the item name, with the following key-value-pairs: name, room, price, size (how many obtained in a single purchase transaction), stackable (t/f), and quantity (how many you want to maintain on hand at a given time). Here are some examples:
<pre>
# This will purchase arrows from your hometown using all defaults; including quantity (which is 30)
restock:
arrow

# This is the same as above, but with a custom quantity
restock:
arrow:
quantity: 45

# this is a completely custom item not contained in base-consumables. It will not change based on hometown.
restock:
super_cool_thing:
name: cool thing
room: 1337
price: 10
size: 3
stackable: true
quantity: 4

# Here are a list of generic items in base-consumables:
arrow
bolt
tk_ammo
rock

# Restock now supports custom Hometowns. This will be super useful if you use Shard as a hometown and need rocks from Hib. You can have as many as you want, but be reminded that we must support the hometown in base-towns.yaml. The hometowns will be visited in order from first to last, listed top to bottom.

hometown: Shard

restock:
arrow:
quantity: 50
bolt:
quantity: 50
rock:
hometown: Hibarnhvidar
name: smooth rocks
room: 12172
price: 45
size: 30
stackable: true
quantity: 50

# restock can probably handle items with "charges" (i.e ritual foci) if they disappear/consumed once all charges are gone.
</pre>}}
|uservars=
}}

== rezz ==
{{ Lich script
|description=A script to rezz corpses
|usage=The script will either raise the person you specify, or if you don't specify someone it will raise all of the corpses in the room. You should add a rezz: waggle set so that it doesn't use default values for rejuv and rezz.
|args={{Lich setting|name=player|desc=The person you want to raise. Optional argument}}
|settings={{Lich setting|name=osrel_no_harness|desc=true to infuse directly, false to harness first.}}

Waggle set to add. Customize the mana and cambrinth values to your skill level:

waggle_sets:
rezz:
Resurrection:
abbrev: rezz
mana: 17
Rejuvenation:
abbrev: rejuv
mana: 10
cambrinth:
- 15
}}

== roomnumbers==
{{Lich script
|description=Adapted from a script by Geldan for Gemstone. Appends the Lich room ID# to your in-game room look. Example:

<pre>[Whistling Wood, Barrows]
A mound of earth looks curiously out of place beneath the twisted and warped branches of the dead trees. Barren of all but the hardiest of grasses, the mound has several small
holes in its side. You also see an Adan'f blood warrior, a chipped and weather-beaten sign, an Adan'f blood warrior and an Adan'f blood warrior.
Obvious paths: southeast, southwest, northwest.
Room Number: 9471
</pre>
|usage=
|args=
|settings=
|uservars=
|children=
}}

== safe-room ==
{{Lich script
|description= Heals at a PC or NPC empath and shares items between characters by taking and dropping them in a safe room
|usage= Gets 4 gold (for autopath), goes to the auto empath and waits until healed. Alternatively can go to a specific set of rooms and wait for 45 seconds for a player empath to heal you. You can list several PC empaths. The script will go to the nearest one from your current location. PC Empaths will heal themselves using healme, Necromancers will not attempt to go to an empath. Can be configured to stop by a room and pick up or drop given item nouns.
|args=
|settings={{Lich setting|name=safe_room_tip_threshold|desc=Amount of copper to carry for npc healing, or if you have more than this amount donate to player empath.}}^{{Lich setting|name=safe_room_id|desc=Id of room for player empath healer or item exchanges.}}^{{Lich setting|name=saferoom_health_threshold|desc=Skips saferoom healing unless the 'force' argument is used. This is a number that represents your wound severity. The calculation of your wound score is Sum(wound level^2 * number of wounds at that level).}}^{{Lich setting|name=safe_room_empath|desc=Name of PC empath healer.}}^{{Lich setting|name=safe_room_empaths|desc=A list of PC empaths with their name and room ID}}^{{Lich setting|name=safe_room_tip_amount|desc=Amount in coppers to donate player empath.}}^{{Lich setting|name=safe_room|desc=Id of room to heal self at as empath.}}^{{Lich setting|name=safe_room_give|desc=List of nouns to drop at safe_room_id, CAUTION will drop all items of this noun there, don't use for anything valuable.}}^{{Lich setting|name=safe_room_take|desc=List of nouns to pick up in safe_room_id.}}^{{Lich setting|name=force_healer_town|desc=Override your hometown: setting to use an auto empath in a different town.}}^{{Lich setting|name=heal_with_divine_charm|desc=true/false - Attempt to use a divine charm that new characters start with to heal, instead of an auto-path.}}
|uservars=
|children=healme
}}

== sanowret-crystal ==
{{Lich script
|description=Runs in the background, gazing or exhaling your sanowret crystal to train [[Arcana]]. Checks for concentration and current mindstate to run only when necessary. Supports worn crystals or stored in a container.
|usage=This script can be run in passive mode or on-demand, and is well suited as part of your autostarts.

Run once on-demand: <code>;sanowret-crystal run=true</code>

Run in the background: <code>;sanowret-crystal</code>

Auto start: <code>;autostart add sanowret-crystal</code>

|args={{Lich setting|name=run|desc=If present, only run the script once (instead of in passive mode).}}
|settings=In your YAML, configure the adjective of your sanowret crystal and list any scripts or rooms where you don't want the script to run, such as when burgling or in a room that prevents magical device usage.

Example:

sanowret_adjective: sanowret
sanowret_no_use_scripts: # Don't try to use crystal while these scripts are active.
- sew
- carve
- tinker
- forge
- remedy
- shape
- enchant
- outdoorsmanship
- combat-trainer
- buff
- burgle
- go2
sanowret_no_use_rooms: # Don't try to use crystal while in these rooms.
- Carousel Chamber # Room with vault
- Carousel Booth # Room just before vault
- 1900 # You can specify room ids, too (Crossing bank window)

}}

== scroll-search ==
{{Lich script
|description= Searches through the given container for any and all spell scroll and displays them in a more readable way. Also allows for the player to grab a specific scroll or transfer scrolls between containers. This script allows you to search multiple containers and tracks the scrolls in each.
|usage= Player specifies the container to search and the script looks through the container for any nouns matching scroll_nouns specified in base-items.yaml
|args={{Lich setting|name=search <container>|desc=Searches the given container}}^{{Lich setting|name=display|desc=Displays the scrolls in all searched containers. Must have already searched or the list will be empty!}}
|settings={{Lich setting|name=scroll_nouns|desc=List of scroll nouns to search container for.}}
|uservars={{Lich setting|name=owned_scrolls|desc=Hashset of the scroll name and the container it resides in.}}^{{Lich setting|name=scroll_counter|desc=Global counter for the amount of scrolls owned.}}^{{Lich setting|name=scroll_search_debug|desc=Turns on debug messaging for scroll-search.lic script.}}
|children=
}}

== sell-loot ==
{{Lich script
|description= Sells gems and bundles; then deposits coin. Defaults to keeping 3 silver on hand (the maximum amount that cannot be stolen by a Thief).
|usage= Will sell bundles and any gems in untied gem pouches. Optionally will make sure you have a spare gem pouch. It is intended to be used in [[RanikMap1|The Crossing]].

EXAMPLES:
* <code>;sell-loot</code> # Uses the default: keeps 3 silver
* <code>;sell-loot 12</code> # Uses one argument: keeps 12 silver, which is withdrawn as 1 gold and 2 silver
* <code>;sell-loot 4 g</code> # Uses two arguments: keeps 4 gold
|args={{Lich setting|name=Withdraw|desc=Amount of coin to withdraw after depositing all. 3 silver, 5 gold, etc.}}
|settings={{Lich setting|name=sell_loot_money_on_hand|desc=Same as the Withdraw argument, overridden by the argument if both exist.}}^{{Lich setting|name=sell_loot_pouch|desc=Set true to sell any gems in a worn pouch.}}^{{Lich setting|name=sell_loot_bundle|desc=Set to true to sell a worn bundle.}}^{{Lich setting|name=sell_loot_traps|desc=Sell harvested traps from boxes that are in your 'component_container'.}}^{{Lich setting|name=spare_gem_pouch_container|desc=The container to store a spare gem pouch in, should NOT be the container a pouch stows to.}}^{{Lich setting|name=gem_pouch_adjective|desc=Adjective you use to request gem pouches, you should be able to tap ADJ pouch to tap your current pouch.}}^{{Lich setting|name=sell_loot_skip_bank|desc=If true, skip bank parts of the script (currency exchange, deposit, withdrawal).}}^{{Lich setting|name=sell_loot_skip_exchange|desc=If true, skip currency exchange.}}^{{Lich setting|name=bankbot_name|desc=The name of the bankbot with whom you would like to deposit coin.}}^{{Lich setting|name=bankbot_deposit_threshold|desc=An amount of copper to keep on hand. Excess will be deposited with the bankbot. Your in-game bank will always be deposited into before the bankbot.}}^{{Lich setting|name=bankbot_room_id|desc=The room ID of the bankbot.}}
|uservars=
|children=
}}

== sell-pouches ==
{{Lich script
|description=Sell gem pouches for trading experience
|usage=This script is called by crossing-training when you have 'Trading' listed as a training skill and 'sell_pouches_for_trading' set to true. You can also call it to sell a pouch.
|settings={{Lich setting|name=hometown|desc=Your hometown. This is used to determine which gemshop you will sell your pouches to}}^{{Lich setting|name=sale_pouches_container|desc=Container where your pouches for sale are stored}}^{{Lich setting|name=waggle_set named 'sell-pouches'|desc=Casts these spells before selling a pouch. This is where you would include spell data for casting Finesse}}

}}

== setupaliases ==
{{Lich script
|description=Adds a useful selection of aliases to the global list:
* <code>as</code> - accepts a trade offer and then stows the item
* <code>gs</code> - gets the given item and then stows the item
* <code>cc</code> - runs ;circlecheck to show your leveling status. it can take args, like cc 200
* <code>ct</code> - toggles crossing-training on or off
* <code>tm</code> - toggles training-manager on or off
* <code>fr</code> - find room, searches for a room description matching provided text
* <code>ids</code> - echos the current mapped connections from the room you're standing in
* <code>lr</code> - echos the full data of the room you're standing in
* <code>lfr</code> - echos the full data of the room a remote room number, pass the number to it
* <code>ls</code> - shows all items in the current room you are in that are stealable that are not in base-stealing
* <code>cb</code> and <code>rec</code> - these work as a pair, for recording room numbers (like setting up a hunting area); run <code>cb</code> to start, then <code>rec</code> in each room you want to record
* <code>hz</code> - list all hunting zones alphabetically
* <code>ez</code> - list all escort hunting zones alphabetically
* <code>fz</code> - search hunting zones and get room numbers, e.g. <code>fz wark</code> returns a list of room numbers for warklins
|usage=
|args=
|settings=
|uservars=
|children=
}}

== sew ==
{{Lich script
|description=
|usage=
|args=
|settings=
|uservars=
|children=
}}

== shape ==
{{Lich script
|description=
|usage=
|args=
|settings=
|uservars=
|children=
}}

== skill-recorder ==
{{Lich script
|description=
|usage=
|args=
|settings=
|uservars=
|children=
}}

== slackbot ==
{{Lich script
|description= If the status-monitor script detects an problem, it will use this script to send you a Direct Message on Slack.
|usage= This script should not be run directly. Instead, status-monitor will run it if the slack_username setting is present. On first time setup you will communicate with a lichbot to get a slack token. The token lets you send messages to your username via the bot. You will currently not receive any notification on setup.
|args=
|settings={{Lich setting|name=slack_username|desc=Your Slack username. It should be all lowercase.}}
|uservars={{Lich setting|name=slack_token|desc=The token used to authenticate to a Slack team.}}
|children=
}}

== smartlisten ==
{{Lich script
|description=If someone teaches you an approved class you'll start listening.
|usage=The default list of approved classes is all non-necromancer skills and no sorcery or thievery. Guild-specific skills are approved if you are of that guild. Some specific classes are also removed based on your guild (e.g. remove Arcana for Barbarians).
|args=
|settings=
|uservars=
|children=
}}

== smarttransfer ==
{{Lich script
|description=safely transfer wounds from the target, avoiding useless injuries in fatal areas
|usage=
|args={{Lich setting|name=bleed|desc=If present, leave external bleeders.}}
|settings=
|uservars=
|children=
}}

== smash-pumpkins ==
{{Lich script
|description=Travel to the pumpkin vat, buy one, go one room away to smash and repeat until too injured. Then return to the safe room.
|usage=
|args=
|settings={{Lich setting|name=hollow_eve_loot_container|desc=Storage container name.}}
|uservars=
|children=
}}

== smelt ==
{{Lich script
|description=Smelt the contents of a crucible. Assumes that material has already been placed into the crucible.
|usage=
|args=
|settings=
|uservars=
|children=
}}

== smelt-deeds ==
{{Lich script
|description=combines deeds of like metals to save inventory space
|usage=
|args=
|settings=
|uservars=
|children=
}}

== smith ==
{{Lich script
|description=
|usage=
|args=
|settings=
|uservars=
|children=
}}

== smoke ==
{{Lich script
|description=smokes an item
|usage=
You can run the script two ways, one from command line and the other from a YAML.

Command line:

;smoke <image> <cigar noun> <container things are in> <lighter's noun (MUST be a lighter)>

You can also run it from a YAML setting:

;smoke <cigar noun>

|args=Command Line:

<image> <cigar noun> <container things are in> <lighter's noun (MUST be a lighter)>

YAML:

<cigar noun> (When running from YAML)

|settings=
<pre>
smoke:
cigar_container: humidor
smoke_image:
lighter:
type: flint
container: humidor
blade: dagger
</pre>
|uservars=
|children=
}}

== sorcery ==
{{Lich script
|description=
|usage=
|args=
|settings=
|uservars=
|children=
}}

== spin ==
{{Lich script
|description=This script is intended to be used in [[RanikMap1|The Crossing]].
|usage=
|args=
|settings=
|uservars=
|children=
}}

== stabbity ==
{{Lich script
|description=Stabbity is designed for thieves, and relies on backstab and thrown weapons to kill things quickly. It's useful in invasions and events.
|usage=
When run without a mode specified (e.g. <code>;stabbity</code>), stabbity will wield your weapon and hide, killing any mob in the room. If no mobs are present, it will wait in hiding for one to arrive.

'''Example Configuration'''
<pre>stabbity:
eliminate: true
weapons:
preferred: glaes pasabas
alternate: judge's gavel
thrown: throwing club
use_alternate_on:
- archer
- soldier
- dryad
- oshu
- frostweaver
- guardian
use_thrown_on:
- hawk
- gryphon</pre>
|args=
{{Lich setting|name=mode|desc=Optional, can be one of:^
* ''equip'': Wields your preferred weapon.^
* ''cleanup'': Sheathes your preferred weapon.^
* ''single'': Kills all mobs in the current room and exits. Does not wait for mob to arrive.^
* ''arena'': Used to run the Dusk Ruin arena.}}^
{{Lich setting|name=noloot|desc=Do not loot mobs when killed.}}
|settings=
{{Lich setting|name=stabbity:eliminate|desc=True/False. Only used during arena. Will use krhi eliminate at the beginning of rounds 5/10/15/20/25. '''Only include if you are a thief with khri eliminate.'''}}^
{{Lich setting|name=stabbity:weapons:preferred|desc=The name of the weapon you wish to backstab with.}}^
{{Lich setting|name=stabbity:weapons:alternate|desc=The name of the weapon you wish to use for mobs defined in use_alternate_on.}}^
{{Lich setting|name=stabbity:weapons:thrown|desc=The name of the weapon you wish to use for mobs defined in use_thrown_on. If this is left off, then it will never try thrown (useful for characters with passive abilities that can force flying thins to land - ex khri terrify).}}^
{{Lich setting|name=stabbity:use_alternate_on|desc=List of mobs on which to use your alternate weapon.}}^
{{Lich setting|name=stabbity:use_thrown_on|desc=List of mobs on which to use your thrown weapon.}}
|uservars={{Lich setting|name=stabbity_debug|desc=Turns on debugging messages.}}
|children=
}}

== stack-scrolls ==
{{Lich script
|description=Scroll stacker manager script that stores and retrieves scrolls using stackers.
}}

== status-monitor ==

{{Lich script
|description=Informs user of high-frequency game output and characters current health via a small window. Useful for keeping tabs on multiple characters.
|usage=Trust status monitor then run it.
|args={{Lich setting|name=debug|desc=Turns on debugging messages.}}
|settings=
|uservars=
|children=
}}

== steal ==
{{Lich script
|description=
|usage=
|args=
|settings=^{{Lich setting|name=hide_to_steal|desc=set to false if you do not wish to hide to steal.}}^{{Lich setting|name=bin_stolen|desc=set to true for Thieves who wish to bin stolen goods.}}^{{Lich setting|name=stealing_bag|desc=storage bag for stolen goods if bin_stolen: true}}^{{Lich setting|name=slow_bin_speed|desc=set to true to bin items slower. Resolves type-ahead issue for Genie users.}}^{{Lich setting|name=steal_past_mindlock|desc=set to true if you wish to continue stealing after Thievery is locked.}}^{{Lich setting|name=dont_steal_list|desc=list items by id# identified in '''base-stealing.yaml''' to skip these items when stealing.}}^{{Lich setting|name=stealing_buffs|desc=list of buffs to use before starting stealing run.}}^{{Lich setting|name=stealing_high_acceptable_count|desc=.}}^{{Lich setting|name=stealing_low_acceptable_count|desc=.}}^{{Lich setting|name=npc_stealing_attempt_count|desc=Numeric amount of stealing attempts on NPCs (minstrel, veteran, etc.)}}^{{Lich setting|name=stealing_options|desc=list of stealable items in base-stealing.yaml}}^
|uservars=
|children=
}}

== study-art ==
{{Lich script
|description=Walks through the Crossing art gallery and appraises each piece on display. Trains scholarship and appraisal.
|usage=Just run it. e.g. <code>;study-art</code>
|args=
|settings=
|uservars=
|children=
}}

== summoning ==
{{Lich script
|description=Trains summoning via summoning and breaking a magical weapon. Summons admittance to build up charges to summon a weapon. [[Warrior Mages]] must have already {{com|align}}ed to an element.
|settings={{Lich setting|name=summoning_target_increment|desc=The desired number of mind states to increase by. Respects crossing_training_max_threshold as an upper threshold.}}
}}

== tarantula ==
{{Lich script
|description=Manages the automated usage of the biomechanical tarantula, a gift handed out for patrons of Hollow Eve 432.
|usage=Run <code>;tarantula</code> after adjusting YAML settings as desired. Can be added to startup. The script watches for skills near max-mindstate to sacrifice for their bonus, with different behavior depending on if you're in combat or not.
|args=
|settings=^{{Lich setting|name=tarantula_startup_delay|desc=Number of seconds to wait after first starting before it will eat skills. Useful when tarantula is added to autostarts, so that it doesn't eat skills on first login, before login drain.}}^
{{Lich setting|name=tarantula_noun|desc=change if you've had a tarantula alteration.}}^
{{Lich setting|name=tarantula_debug|desc=set true if you wish to see debug messages}}^
{{Lich setting|name=tarantula_excluded_skills|desc=A list of skills never to sacrifice to the tarantula.}}^
{{Lich setting|name=tarantula_no_use_scripts|desc=A list of scripts defined by you, during which the tarantula will not activate.}}^
{{Lich setting|name=tarantula|desc=A list of skills, organized by sphere and by whether you want them sacrificed in and/or out of combat as defined by whether combat-trainer is running. These are the prioritized choices, however ;tarantula will choose other full skills in that sphere if none of its prioritized skills are available, unless they are listed in <code>tarantula_excluded_skills</code>

<pre>
tarantula:
Armor:
combat:
- Chain Armor
- Brigandine
- Plate Armor
- Light Armor
- Defending
Weapon:
combat:
- Melee Mastery
- Missile Mastery
Magic:
combat:
- Utility
non_combat:
- Lunar Magic
- Warding
- Augmentation
- Utility
Survival:
combat:
- Evasion
- Skinning
non_combat:
- Outdoorsmanship
Lore:
non_combat:
- Appraisal
- Performance
- Scholarship

An example of exclusions added to a yaml:

tarantula_excluded_skills:
- Large Edged
- Brawling
- Evasion
- Parry
- Shield
- Athletics
- Crossbow
- Slings
- Light Thrown
- Bow

</pre>

}}^
|uservars={{Lich setting|name=tarantula_last_use|desc=The last time the tarantula was sacrificed to.}}^{{Lich setting|name=tarantula_last_skillset|desc=The last sphere sacrificed to, since the tarantula can't be used on the same sphere twice in a row.}}
|children=
}}

== tendme ==
{{Lich script
|description=Automatic wound tender for self. On start, checks {{com|health}} for bleeding wounds and tends them, then watches for messages to unbind or retend wounds.
|usage=
|args={{Lich setting|name=train|desc=If present, unwrap and rebind wounds for optimum learning.}}
|settings=
|uservars=
|children=
}}

== tendother ==
{{Lich script
|description=Automatic wound tender for another player. On start, looks for bleeding wounds and tends them, then watches for messages to unbind or retend wounds.
|usage=
|args={{Lich setting|name=player|desc=Name of the player to tend.}}
|settings=
|uservars=
|children=
}}

== textsubs==
{{Lich script
|description=Provides in-game text substitution capabilities; comes with many defaults (e.g. appraisal and combat messages).
|usage=
Example of adding a sub: <code><nowiki>TextSubs.add('^(\s+)no (puncture|slice|impact|fire|cold|electric) damage','\1no (0/27) \2 damage')</nowiki></code>

Clear out all stored subs with <code>TextSubs.clear()</code>
|args=
|settings=
|uservars=
|children=
}}

== theurgy ==
{{Lich script
|description=train theurgy by working up devotion and doing communes
|usage= Recommended - Eluned (holy water)
|args=
|settings={{Lich setting|name=theurgy_supply_container|desc=Container for storing wine, flint, and incense.}}^{{Lich setting|name=water_holder|desc=Vessel that you store holy water in.}}^{{Lich setting|name=flint_lighter|desc=Blade for lighting flint.}}^{{Lich setting|name=immortal_aspect|desc=for bead carving/meditation (must be aspect of god you last got a favor from).}}^{{Lich setting|name=theurgy_prayer_mat_room|desc=Room in which to use your prayer mat. Requires an object defined with an `id: roomid` format, ex.
<nowiki>
theurgy_prayer_mat_room:
id: 1234</nowiki>
}}
|uservars=
|children=
}}

== titlecheck ==
{{Lich script
|description=Checks for new titles since the last time you ran the script.
|usage=Run the script and provide a set of titles to check (e.g. ;titlecheck moonmage). On the first run for that title set, all titles will be reported as new. Running the script afterwards will report only new titles.
|args=title_set
|settings=
|uservars=titles
|children=
}}

== trade ==
{{Lich script
|description=Do caravan trading in Zoluren
}}

== train ==
{{Lich script
|description=Train the given attributes. It is intended to be used in [[RanikMap1|The Crossing]].
|usage=
Arguments are the name of the attribute to train, with an optional number of trainings (Defaults to 1):
* <code>;train</code>
No arguments: nothing happens
* <code>;train st</code>
"st" is ambiguious between stamina and strength: nothing happens
* <code>;train sta w2</code>
Trains stamina once and wisdom twice
|args=
|settings=
|uservars=
|children=
}}

== training-manager==
{{Lich script
|description= High level script for managing combat and non combat training
|usage= Will alternate training in the crossing and hunting with a focus on either in or out of combat as specified. Heals and repairs after combat.
|args=
|settings={{Lich setting|name=training_manager_hunting_priority|desc=Set to true will cause it to focus on combat training at the expense of out of combat.}}^{{Lich setting|name=training_manager_priority_skills|desc=List of combat skills to monitor when it should go hunting again, only used if hunting_priority is set true.}}^{{Lich setting|name=training_manager_town_duration|desc=Number of minutes to limit town training to before going hunting. This works when hunting priority is true or false}}^{{Lich setting|name=mine_while_training|desc=Set to true will cause town training to start with a mining loop.}}^{{Lich setting|name=favor_goal|desc=Number of favors to work towards, if this is set will work on favors while training.}}^{{Lich setting|name=favor_god|desc=Desired immortal to request favor orb for Must be set for favor gathering to work properly.}}^{{Lich setting|name=repair_timer|desc=Time in seconds between each run of crossing-repair. Default is 10 minutes, or 600 seconds.}}^{{Lich setting|name=repair_withdrawal_amount|desc=Amount of currency to withdrawal for each repair. Default amount is 10,000.}}^{{Lich setting|name=skip_repair|desc=True/false setting. Use true to skip all crossing-repair functionality. Default is false.}}
|uservars=
|children=mining-buddy,sell-loot,hunting-buddy,crossing-training,safe-room,crossing-repair
}}

== transfer-items ==
{{Lich script
|description=Transfers all items from one container to another. It may need to be run multiple times if you have a lot of stuff. If you use an adjective you must type it completely in double quotes, e.g. "hide sack", not "h sack".
|usage=
* Transfer all items from <source> to <destination>
;transfer-items <source> <destination>
;transfer-items backpack haversack

* Transfer only items that respond to <noun> from <source> to <destination>
;transfer-items <source> <destination> <noun>
;transfer-items backpack quiver arrows
|args={{Lich setting|name=source|desc=Source container.}}^{{Lich setting|name=destination|desc=Destination container.}}^{{Lich setting|name=noun|desc=If specified, only items with this noun will be transferred.}}
|settings=
|uservars=
|children=
}}

== truffenyi-commune-quest ==
{{Lich script
|description=Runs in the background to do all actions required during the truffenyi commune quest, praying to the gods presented in the visions and dropping any food items that appear in your hands. This should be run somewhere safe, without other scripts running because they can interfere. Start after drinking the vial created from your mini altar twice.
|usage=
|args=
|settings=
|uservars=
|children=
}}

== validate ==
{{Lich script
|description=Checks character yamls for common mistakes.
|usage=
|args=
|settings=
|uservars=
|children=
}}

== walkingastro ==
{{Lich script
|description=Runs as a background script whose aim is to keep your prediction pools filling and the Astrology Skill moving.
|usage=On a 215 second timer, while not in combat (or while a series of other scripts are running), it will grab your telescope and if day observe the Sun, if night observe the Heart constellation. If your survival prediction pool fills, the script will instead align and predict against a survival skill. The aim of the script is to keep Astrology moving while you are out and about with your character, without having to rely on the ;astrology script.

Note, walkingastro will wait and not fire while the following scripts are running: 'steal', 'combat-trainer', 'pick', 'craft', 'shape', 'sew','bescort', 'remedy', 'forge', 'carve', 'performance', 'theurgy', 'hlctheurgy', 'astrology', 'astrology2', 'study-art', 'mech-lore', 'first-aid'.

Finally, this script assumes that you have a telescope (see Astrology for telescope support settings) and that Piercing Gaze is up.

It is highly recommended that you add PG to your list of in/out of combat buff spells.
|args=
|settings=
|uservars=
|children=
}}

== weave-cloth ==
{{Lich script
|description=This script is intended to be used in [[RanikMap1|The Crossing]].
|usage=
|args=
|settings=
|uservars=
|children=
}}

== workorders ==
{{Lich script
|description=completes a workorder for the given discipline. Supplemental information: https://github.com/rpherbig/dr-scripts/wiki/Crafting-Setup
|usage=
|args={{Lich setting|name=type|desc=Type of workorder to do, blacksmithing, tailoring, shaping.}}
|settings={{Lich setting|name=crafting_container|desc=Bag that materials, tools, and books are stored in.}}^{{Lich setting|name=workorder_diff|desc=difficulty of workorder to request.}}^{{Lich setting|name=crafting_recipes|desc=List of crafting recipes in base-crafting.yaml.}}^{{Lich setting|name=forging_tools|desc=List of tools used in forging.}}^{{Lich setting|name=forging_belt|desc=Set up this has if you have a toolbelt for this craft.}}^{{Lich setting|name=forging_belt:name|desc=Unique name of belt.}}^{{Lich setting|name=forging_belt:items|desc=List of items held on the belt.}}^{{Lich setting|name=knitting_tools|desc=List of tools used in knitting.}}^{{Lich setting|name=outfitting_belt|desc=Set up this has if you have a toolbelt for this craft.}}^{{Lich setting|name=outfitting_belt:name|desc=Unique name of belt.}}^{{Lich setting|name=outfitting_belt:items|desc=List of items held on the belt.}}^{{Lich setting|name=shaping_tools|desc=List of tools used in shaping.}}^{{Lich setting|name=engineering_belt|desc=Set up this has if you have a toolbelt for this craft.}}^{{Lich setting|name=engineering_belt:name|desc=Unique name of belt.}}^{{Lich setting|name=engineering_belt:items|desc=List of items held on the belt.}}^{{Lich setting|name=carving_tools|desc=List of tools used in carving.}}^{{Lich setting|name=workorder_min_items|desc=Minimum number of items in the workorder required to accept.}}^{{Lich setting|name=workorder_max_items|desc=Maximum number of items in the workorder required to accept.}}^{{Lich setting|name=workorders_repair|desc= Whether you want to repair your crafting tools after completing workorders or not. For those with tools setup under gear, set to false in your yaml.}}
workorders_repair: true

#CARAVAN SETTINGS
# container holding caravan contracts for ;trade

|uservars=
|children=smith, shape, sew
}}

{{cat|Lich scripts}}