Elanthipedia - User contributions [en]

Experience

2019-10-15T21:49:28Z

ARCHIMEDIAN: /* Stats and learning */ reworded to remove reference to 'now', as documenting a system implies 'now'

{{RTOC}}
:''For the game command, see {{com|experience}}.''

[[Experience]], often abbreviated '''exp''', is the general term for all of the [[skill]] learning your character has attained.

In [[DragonRealms]], your ranks in a skill are increased by using it. This is called training. The amount of experience gained from any action is scaled to the difficulty of that action for your character at that time, and how successful your character is in performing it. It is common for a task that has become very simple or unchallenging to grant zero experience.

Experience can potentially be lost as a consequence of character [[death]], although this can be easily avoided through [[favors]].

==Ranks==
Gained [[experience]] is measured as whole-number increments called "ranks." As your experience drains from your experience pool for a particular [[:Category:Skills|skill]], your learning is converted into ranks. Your ability in a skill is measured by the number of ranks you have attained in that skill. Additionally, there are skill requirements for advancing in circle (or character level) within a guild. Finally, gaining ranks in skills grants [[Time Development Points|TDPs]], which can be used to raise your stats.

''Note:'' It is generally considered OOC to engage in explicit discussions of numerical stats or skills. (Role-players may also object to the term "ranks.") When discussing skill via IC channels, the most conservative approach is to use the [[Experience#RP_messaging|RP messaging]], reserving numerical discussions for whispers and private messages. See [[Out of Character]] for additional information.

The amount of effort required to move up one rank in a skill can be measured in bits. Through analysis of the output of the {{com|CONVERT}} command it was possible to reverse engineer this relationship between ranks. Your next rank in a skill will be reached after you have gained 200 + n bits, where n is the current rank. This means to go from rank 0 to rank 1 in a skill you will need 200 bits, to go from rank 1 to rank 2, you will need 201 bits, and so on. By summing up the number of ranks you can determine how many bits it will take to reach a current level.

The graph and table below show the total number of bits needed to reach a specific rank from 0. This graphic demonstrates the relative difficulty to climb ranks. For example, to go from 300 to 400 ranks takes roughly the same number of bits as going from 0 to 200 ranks. Going from rank 1,000 to 1,500 requires approximately twice the number of bits as going from 0 to 1,000.

[[File:TotalBitsNeededToReachRank.png|left|500px]]
{|class="wikitable"
!Rank!!Total bits needed
|-
| 1||200
|-
| 25||5,300
|-
| 50||11,225
|-
| 75||18,050
|-
| 100||24,950
|-
| 150||41,175
|-
| 200||59,900
|-
| 250||81,125
|-
| 300||104,850
|-
| 400||159,800
|-
| 500||224,750
|-
| 750||430,875
|-
|1,000||699,500
|-
|1,250||1,030,625
|-
|1,500||1,424,250
|-
|1,750||1,880,375
|}

===Maximum rank===
Ranks are capped at 1750. Once you hit 1750 ranks, you no longer gain experience into your experience pool for that skill and draining experience has no effect. It is possible to have effective ranks higher than 1750 through buffs such as abilities or spells. Skill buffs are capped at 20% for most skills, and 10% for [[crafting]] skills. You can see your current buffs using {{com|EXPERIENCE}} {{tt|MODS}}.

===Calculations for Ranks and Bits===
The relationship between bits and ranks can be defined algebraically. In the formulas below ''r'' refers to ranks and ''b'' refers to bits.<ref>[[Talk:Convert_command]]</ref>

[[File:Bits_from_ranks_formula.png]] yields the bits needed to reach a specific rank.

[[File:Ranks_from_bits_formula.png]] yields the rank a number of bits would reach.

==Experience pools and pulses==
===Experience pools===
Every skill has its own individual pool, which fills with field experience as you obtain it. The current amount of field experience in your pool ranges from clear (empty) to mind lock (full).

Factors that determine maximum pool size (in descending order of importance):
#whether the skill is in your primary, secondary, or tertiary skillset
#the number of ranks you have in the skill
#{{stat|Intelligence}}
#{{stat|Discipline}} (Note: It was planned for 3.0 to remove discipline from the experience pool effects, but as posted by Socharis on 1/18/13, "...So I looked into this, and Discipline was never taken out - It's not as significant as intelligence, but it definitely increases your <nowiki>[</nowiki>experience<nowiki>]</nowiki> pool size."

{| class="wikitable"
|-
!Amount Learning
!Mindstate Fraction
!Amount Learning
!Mindstate Fraction
|-
|clear||0/34||analyzing||18/34
|-
|dabbling||1/34||studious||19/34
|-
|perusing||2/34||focused||20/34
|-
|learning||3/34||very focused||21/34
|-
|thoughtful||4/34||engaged||22/34
|-
|thinking||5/34||very engaged||23/34
|-
|considering||6/34||cogitating||24/34
|-
|pondering||7/34||fascinated||25/34
|-
|ruminating||8/34||captivated||26/34
|-
|concentrating||9/34||engrossed||27/34
|-
|attentive||10/34||riveted||28/34
|-
|deliberative||11/34||very riveted||29/34
|-
|interested||12/34||rapt||30/34
|-
|examining||13/34||very rapt||31/34
|-
|understanding||14/34||enthralled||32/34
|-
|absorbing||15/34||nearly locked||33/34
|-
|intrigued||16/34||mind lock||34/34
|-
|scrutinizing||17/34
|}

===Experience pulses===
This field experience is gradually converted into actual ranks. When field experience is converted to ranks, it is called a pulse. The size of the pulse is calculated as a fraction of your total pool size. The primary factor affecting this fraction is whether the skill is primary, secondary, or tertiary; higher Wisdom also increases this fraction. However, secondary skills under 50 ranks will drain like primary skills<ref>[[Post:Low_level_ranks,_EXP,_and_you!_-_7/11/2008_-_8:58:48]]</ref><ref>[[Post:Minor_exp_change_-_02/05/2015_-_20:51]]</ref>, and tertiary skills under 25 ranks will drain like secondary skills.<ref>[[Post:Minor_exp_change_-_02/06/2015_-_10:57]]</ref>

{|class=wikitable
|-
!Skillset
!Time to Pulse From Mind Lock to Clear
|-
|Primary||40-60 minutes
|-
|Secondary||50-80 minutes
|-
|Tertiary||70-100 minutes
|}

Skills pulse in groups every 200 seconds, with each group being offset from the previous one by 20 seconds. These skill groupings are arranged by skillset in the order they appear in the experience list in game, with the exception of certain guild-only skills which are located with their historical group. The order and timing of the pulses is fixed, meaning the pulses happen at the exact same time for the same skills for every single player in the game.

{|class=wikitable
|-
!Relative Time Offset
!Skill Group
|-
|0 sec.||Shield Usage, Light Armor, Chain Armor, Brigandine, Plate Armor, Defending
|-
|20 sec.||Parry Ability, Small Edged, Large Edged, Twohanded Edged
|-
|40 sec.||Small Blunt, Large Blunt, Twohanded Blunt, Slings, Bow, Crossbow
|-
|60 sec.||Staves, Polearms, Light Thrown, Heavy Thrown, Brawling, Offhand Weapon, Melee Mastery
|-
|80 sec.||Missile Mastery, Primary Magic, Attunement, Arcana, Targeted Magic, Augmentation
|-
|100 sec.||Debilitation, Utility, Warding, Sorcery, Evasion, Athletics, Perception, ''Scouting''
|-
|120 sec.||Stealth, Locksmithing, Thievery, First Aid, Outdoorsmanship
|-
|140 sec.||Skinning, ''Backstab''
|-
|160 sec.||Forging, Engineering, Outfitting, Alchemy, Enchanting, Scholarship, Mechanical Lore, Appraisal, ''Bardic Lore'', ''Trading''
|-
|180 sec.||Performance, Tactics, ''Astrology'', ''Empathy'', ''Thanatology'', ''Expertise'', ''Summoning'', ''Theurgy'', ''Conviction''
|-
|}

==Stats and learning==
Mental statistics have a significant effect on the experience system. Intelligence and Wisdom affect all skills equally and have diminishing returns that are not logarithmically diminishing. (Every TDP spent on these stats provides a benefit.)

*'''{{stat|Intelligence}}''': Maximum size of experience pools
*'''{{stat|Wisdom}}''': Pulse size
*'''{{stat|Discipline}}''': Experience pool size (10% efficiency)

The effect of Intelligence and Wisdom is a percentage and not dependent on how many ranks you have in the skill. The effects of these stats can't be "tested" in an hour. This is something that assists you over the course of your entire career.

On 12/10/2015, GM [[Armifer]] shared some hard numbers on how intelligence and wisdom affect learning.<ref>[[Post:Experience Pool Size - Bug Fix - 12/10/2015 - 19:03]]</ref> Using 10 as the baseline (100%), here is the magnitude of the effect of training those stats:

{|class=wikitable
|-
!Stat!!Value!!Effect (Compared to 10)
|-
|Intelligence/Wisdom||30||112%
|-
|Intelligence/Wisdom||60||121%
|-
|Intelligence/Wisdom||90||125%
|-
|Intelligence/Wisdom||120||130%
|}
"Discipline also increases pool size, at 10% efficacy, thus continuing its trend of doing just a little bit of everything." --GM [[Armifer]]

==Rested Experience System==
Regular Subscribers, Premium Subscribers, and F2P accounts with a unlock purchased with Simucoins can utilize the Rested Experience System (REXP). When active, this system provides a bonus when field experience is converted to ranks. The actual EXP pools are unchanged, but when you drain experience from the pools it will simply be worth more actual ranks by a factor of 3.

There are three mechanical components to the system: pool cap, usage cap and cycle. Information about these features is available in the EXP command.

*The pool cap is how much rested exp you can have banked on your character at any time. Simple enough. At this time, the pool cap depends upon your subscription type. Standard accounts will be able to bank up to 4 hours of REXP. Premium accounts will store up to 6 hours, and in the Platinum instance the pool can hold 8 hours. This time will accumulate after 5 consecutive minutes of not draining experience. This is whether offline, online without any EXP in your pools, or with the help of deep sleep. The rested experience pool is filled at a rate of 2:1 (for every 2 minutes of not draining experience, 1 minute of rested experience is earned).

*The usage cap is how much rested exp you can use. For now, regardless of how frequently you fill the storage cap, you can only use up to 4/6/8 rested experience during one cycle (dependent upon account type).

*The cycle is how long it takes for the usage cap to reset. After 23:30 hours your usage cap will refresh and you can spend additional rested exp. The timing of the cycle is personal rather than universal: it starts when you, personally, do something with the rested exp system and then runs its course.

In addition to changes to how experience is converted under REXP, a modification to the sleep verb was provided. In "Light Sleep" you will stop gaining new experience but continue to drain experience from your pools. You will use REXP in this state. In "Deep Sleep" you will not gain experience NOR will you drain experience. Your REXP is not used, and you will start to accumulate time in your rested experience pool again.

Each time one of the 10 skill groups drain that has experience in it for any single, or multiple skills, 20 seconds is removed from your REXP time. If a skill group pulses and there isn't any experience in any of the skills for that group the 20 seconds remains. This makes it possible to focus on specific skill groups and stretch out the REXP time for any targeted skills in them. For Example, if you are only training skills in 5 of the 10 skill groups, your REXP time would take twice the amount of time to be used up. 4 hours could be 8 hours of focused training, or 6 hours could be 12.

==Experience drain at login==
Experience drain at login is based on when you last logged out of the game. Starting at 30 minutes, you will drain a percentage of your experience equal to the number of minutes that you have been logged out divided by 360 (or 480 if you received a warning within the last six months).

When you're logged out, experience drains at a static rate, regardless of skillset placement, ranks, or stats. Technically, the experience doesn't actually pulse until you log back in. Previously, if one were to log in then log out before the pulse it would reset the timer. With the addition of Rested EXP, this is no longer true.

{|class=wikitable
|-
!Time Logged Out
!%Pulsed (Clean)
!%Pulsed (Warning)
|-
|30 minutes||8.33%||6.25%
|-
|1 hour||16.67%||12.5%
|-
|2 hours||33.33%||25%
|-
|3 hours||50%||37.5%
|-
|4 hours||66.67%||50%
|-
|5 hours||83.33%||62.5%
|-
|6 hours||100%||75%
|-
|7 hours||100%||87.5%
|-
|8 hours||100%||100%
|}

*'''Note: [[Free to play]] players do not receive offline drain without a pass from the [[Simucoin]] store. See [[Idle experience drain]] for more details.'''
*As of 03/12/2015, players who have received a warning within the last six months drain over eight hours instead of not being able to drain experience at login.<ref>[[Post:Login Experience Drain - 03/12/2015 - 21:32]]</ref>

==RP messaging==
Ranks in each skill are numerical. However, there is also a role-playing system of nomenclature set up for skills, to make it easier to integrate into game-play.

;Ranks 1-49 / Novice
''Within the above range:''
*+ 0-09 = Lowly
*+ 10-19 = Promising
*+ 20-29 = Able
*+ 30-39 = Trained
*+ 40-49 = Full

;Ranks 50-99 / Practitioner

;Ranks 100-149 / Dilettante

;Ranks 150-199 / Aficionado

''Within the above ranges:''
*+ 0-09 = Beginning
*+ 10-19 = Competent
*+ 20-29 = Proficient
*+ 30-39 = Experienced
*+ 40-49 = Skilled

;Ranks 200-299 / Adept

;Ranks 300-399 / Expert

''Within the above ranges:''
*Rated by degrees 0-99

;Ranks 400-499 / Professional

;Ranks 500-599 / Authority

;Ranks 600-699 / Genius

''Within the above ranges:''
*+ 20-39 = Exceptional
*+ 40-59 = Outstanding
*+ 60-79 = Renowned
*+ 80-99 = True

;Ranks 700-799 / Savant

;Ranks 800-899 / Master

;Ranks 900-999 / Grand Master

''Within the above ranges:''
*+ 20-39 = Distinguished
*+ 40-59 = Venerated
*+ 60-79 = Exalted
*+ 80-99 = Transcendent

;Ranks 1000-1249 / Guru

;Ranks 1250+ / Legend

==Bonus experience pools==
During [[experience 3.0]], when skills were combined, the "lost" experience bits were moved into the bonus pools, one for each skillset. When experience is absorbed through the normal method, an equal amount is removed from the appropriate bonus pool and added to permanent experience. This effectively doubles learning rates in the skillset so long as experience remains in the bonus pools.

The metric used is an arbitrary unit, a multiple of the amount of bits that it takes to move a skill from 0 to 200 (60,300 bits) plus the number of ranks any remaining bits would teach. As an example:

{|
|<pre>Your Lore pool could fill 14 empty skills to 200 ranks and one empty skill to 57 ranks.</pre>
|}

===Syntax===
To view how much experience is left use {{com|experience}} {{tt|bonus}}. When there is no longer any experience left, you will receive the message "You do not have any experience in your bonus pools."

To toggle absorption, use {{tt|experience bonus toggle}} ''<skillset>''.

{{RefAl|a=y|r=y}}
*[http://www.elanthia.org/Learning/ Demystifying the Experience System]: [[User:Isharon|Isharon]]'s explanation of the experience system (a good link to share with new players)
*[[Experience (obsolete)]] has information on the obsolete experience system prior to the 3.0 release.
*[[:Category:Skills]] has a listing of all skills in game.
*[[Skillsets]] for how skills are grouped in game.
*[[Time Development Points]] are calculated based on earned ranks in a skill.

{{cat|Skills|*}}[[page type is::concept| ]]

Lich script repository

2019-08-05T19:11:34Z

ARCHIMEDIAN: /* List autostart scripts */

{{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
}}

== 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</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.}}
}}

== 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=
}}

== 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=
}}

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

== 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=lumber_buddy_tree_list|desc=List of woods that you wish to chop.}}^{{Lich setting|name=lumber_implement|desc=axe, greataxe, or hatchet type weapons}}^{{Lich setting|name=lumber_use_packet|desc=Set to true to carry and use a deed packet, otherwise stow found wood}}
|uservars=
|children=safe-room
}}

== 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. Large weapons require prime, etc. Swappable weapons are not supported for this option either. Also, it works in conjunction with the setting 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=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: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: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=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
}}

== 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=It is intended to be used in [[RanikMap1|The Crossing]].
|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=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
}}

== dusk-labyrinth ==
{{Lich script
|description=Searches and loots the Duskruin Ratacombs/Labyrinth. Written for Duskruin 422
|usage=
|args=
|settings=
|uservars=
|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=
}}

== 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=
}}

== first-aid ==
{{Lich script
|description=Trains the First Aid skill by reading compendiums or textbooks
|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.}}
|uservars=
|children=
}}

== 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=
}}

== 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.
|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: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=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
}}

== 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=
}}

== 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=
}}

== 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=
}}

== 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.}}
|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.
}}

== 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.}}
|uservars=
|children=healme
}}

== sanowret-crystal ==
{{Lich script
|description= Runs in the background, gazing or exhaling your sanowret crystal. Checks for concentration and current mindstate.
|usage=
|args={{Lich setting|name=run|desc=If present, only run the script once (instead of in passive mode).}}
|settings={{Lich setting|name=sanowret_adjective|desc=The adjective of your sanowret crystal. Default setting is sanowret. Only needed if your crystal has a different adjective.}}
|uservars=
|children=
}}

== 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=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=
|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=
}}

== 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:
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:weapons:preferred_weapon|desc=The name of the weapon you wish to backstab with.}}^
{{Lich setting|name=stabbity:weapons:alternate_weapon|desc=The name of the weapon you wish to use for mobs defined in use_alternate_on.}}^
{{Lich setting|name=stabbity:weapons:thrown_weapon|desc=The name of the weapon you wish to use for mobs defined in use_alternate_on.}}^
{{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=
}}

== 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.
|usage=
|args={{Lich setting|name=source|desc=Source container.}}{{Lich setting|name=destination|desc=Destination container.}}
|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 and that Piercing Gaze is up. If 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
|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.}}
|uservars=
|children=smith, shape, sew
}}

{{cat|Lich scripts}}

Lich script repository

2019-08-05T19:11:14Z

ARCHIMEDIAN: /* Autostart */

{{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 ==
;e echo(list_autostarts) will show you the files being autostarted on a given character
;e echo list_autostarts
== 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
}}

== 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</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.}}
}}

== 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=
}}

== 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=
}}

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

== 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=lumber_buddy_tree_list|desc=List of woods that you wish to chop.}}^{{Lich setting|name=lumber_implement|desc=axe, greataxe, or hatchet type weapons}}^{{Lich setting|name=lumber_use_packet|desc=Set to true to carry and use a deed packet, otherwise stow found wood}}
|uservars=
|children=safe-room
}}

== 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. Large weapons require prime, etc. Swappable weapons are not supported for this option either. Also, it works in conjunction with the setting 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=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: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: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=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
}}

== 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=It is intended to be used in [[RanikMap1|The Crossing]].
|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=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
}}

== dusk-labyrinth ==
{{Lich script
|description=Searches and loots the Duskruin Ratacombs/Labyrinth. Written for Duskruin 422
|usage=
|args=
|settings=
|uservars=
|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=
}}

== 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=
}}

== first-aid ==
{{Lich script
|description=Trains the First Aid skill by reading compendiums or textbooks
|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.}}
|uservars=
|children=
}}

== 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=
}}

== 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.
|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: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=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
}}

== 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=
}}

== 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=
}}

== 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=
}}

== 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.}}
|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.
}}

== 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.}}
|uservars=
|children=healme
}}

== sanowret-crystal ==
{{Lich script
|description= Runs in the background, gazing or exhaling your sanowret crystal. Checks for concentration and current mindstate.
|usage=
|args={{Lich setting|name=run|desc=If present, only run the script once (instead of in passive mode).}}
|settings={{Lich setting|name=sanowret_adjective|desc=The adjective of your sanowret crystal. Default setting is sanowret. Only needed if your crystal has a different adjective.}}
|uservars=
|children=
}}

== 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=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=
|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=
}}

== 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:
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:weapons:preferred_weapon|desc=The name of the weapon you wish to backstab with.}}^
{{Lich setting|name=stabbity:weapons:alternate_weapon|desc=The name of the weapon you wish to use for mobs defined in use_alternate_on.}}^
{{Lich setting|name=stabbity:weapons:thrown_weapon|desc=The name of the weapon you wish to use for mobs defined in use_alternate_on.}}^
{{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=
}}

== 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.
|usage=
|args={{Lich setting|name=source|desc=Source container.}}{{Lich setting|name=destination|desc=Destination container.}}
|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 and that Piercing Gaze is up. If 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
|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.}}
|uservars=
|children=smith, shape, sew
}}

{{cat|Lich scripts}}

Lich script repository

2019-08-05T19:08:40Z

ARCHIMEDIAN: /* Remove an autostart */

{{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
== 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
}}

== 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</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.}}
}}

== 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=
}}

== 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=
}}

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

== 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=lumber_buddy_tree_list|desc=List of woods that you wish to chop.}}^{{Lich setting|name=lumber_implement|desc=axe, greataxe, or hatchet type weapons}}^{{Lich setting|name=lumber_use_packet|desc=Set to true to carry and use a deed packet, otherwise stow found wood}}
|uservars=
|children=safe-room
}}

== 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. Large weapons require prime, etc. Swappable weapons are not supported for this option either. Also, it works in conjunction with the setting 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=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: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: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=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
}}

== 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=It is intended to be used in [[RanikMap1|The Crossing]].
|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=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
}}

== dusk-labyrinth ==
{{Lich script
|description=Searches and loots the Duskruin Ratacombs/Labyrinth. Written for Duskruin 422
|usage=
|args=
|settings=
|uservars=
|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=
}}

== 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=
}}

== first-aid ==
{{Lich script
|description=Trains the First Aid skill by reading compendiums or textbooks
|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.}}
|uservars=
|children=
}}

== 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=
}}

== 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.
|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: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=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
}}

== 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=
}}

== 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=
}}

== 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=
}}

== 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.}}
|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.
}}

== 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.}}
|uservars=
|children=healme
}}

== sanowret-crystal ==
{{Lich script
|description= Runs in the background, gazing or exhaling your sanowret crystal. Checks for concentration and current mindstate.
|usage=
|args={{Lich setting|name=run|desc=If present, only run the script once (instead of in passive mode).}}
|settings={{Lich setting|name=sanowret_adjective|desc=The adjective of your sanowret crystal. Default setting is sanowret. Only needed if your crystal has a different adjective.}}
|uservars=
|children=
}}

== 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=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=
|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=
}}

== 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:
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:weapons:preferred_weapon|desc=The name of the weapon you wish to backstab with.}}^
{{Lich setting|name=stabbity:weapons:alternate_weapon|desc=The name of the weapon you wish to use for mobs defined in use_alternate_on.}}^
{{Lich setting|name=stabbity:weapons:thrown_weapon|desc=The name of the weapon you wish to use for mobs defined in use_alternate_on.}}^
{{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=
}}

== 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.
|usage=
|args={{Lich setting|name=source|desc=Source container.}}{{Lich setting|name=destination|desc=Destination container.}}
|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 and that Piercing Gaze is up. If 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
|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.}}
|uservars=
|children=smith, shape, sew
}}

{{cat|Lich scripts}}

Lich script repository

2019-08-05T19:07:55Z

ARCHIMEDIAN: /* Remove an autostart */

{{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
== 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>
;e echo(list_autostarts) will show you the files being autostarted on a given character
;e autostart(['sanowret-crystal', 'textsubs', 'roomnumbers']) to add many scripts at once

= 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
}}

== 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</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.}}
}}

== 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=
}}

== 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=
}}

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

== 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=lumber_buddy_tree_list|desc=List of woods that you wish to chop.}}^{{Lich setting|name=lumber_implement|desc=axe, greataxe, or hatchet type weapons}}^{{Lich setting|name=lumber_use_packet|desc=Set to true to carry and use a deed packet, otherwise stow found wood}}
|uservars=
|children=safe-room
}}

== 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. Large weapons require prime, etc. Swappable weapons are not supported for this option either. Also, it works in conjunction with the setting 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=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: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: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=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
}}

== 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=It is intended to be used in [[RanikMap1|The Crossing]].
|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=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
}}

== dusk-labyrinth ==
{{Lich script
|description=Searches and loots the Duskruin Ratacombs/Labyrinth. Written for Duskruin 422
|usage=
|args=
|settings=
|uservars=
|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=
}}

== 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=
}}

== first-aid ==
{{Lich script
|description=Trains the First Aid skill by reading compendiums or textbooks
|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.}}
|uservars=
|children=
}}

== 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=
}}

== 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.
|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: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=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
}}

== 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=
}}

== 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=
}}

== 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=
}}

== 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.}}
|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.
}}

== 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.}}
|uservars=
|children=healme
}}

== sanowret-crystal ==
{{Lich script
|description= Runs in the background, gazing or exhaling your sanowret crystal. Checks for concentration and current mindstate.
|usage=
|args={{Lich setting|name=run|desc=If present, only run the script once (instead of in passive mode).}}
|settings={{Lich setting|name=sanowret_adjective|desc=The adjective of your sanowret crystal. Default setting is sanowret. Only needed if your crystal has a different adjective.}}
|uservars=
|children=
}}

== 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=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=
|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=
}}

== 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:
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:weapons:preferred_weapon|desc=The name of the weapon you wish to backstab with.}}^
{{Lich setting|name=stabbity:weapons:alternate_weapon|desc=The name of the weapon you wish to use for mobs defined in use_alternate_on.}}^
{{Lich setting|name=stabbity:weapons:thrown_weapon|desc=The name of the weapon you wish to use for mobs defined in use_alternate_on.}}^
{{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=
}}

== 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.
|usage=
|args={{Lich setting|name=source|desc=Source container.}}{{Lich setting|name=destination|desc=Destination container.}}
|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 and that Piercing Gaze is up. If 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
|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.}}
|uservars=
|children=smith, shape, sew
}}

{{cat|Lich scripts}}

Lich script repository

2019-08-05T19:06:27Z

ARCHIMEDIAN: /* Autostart */ update

{{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
== Remove an autostart ==

Usage examples of dependency autostart are shown below:
<pre>
;e autostart('script-name') will start the script called 'script-name' for all of your characters
;e autostart('script-name', false) will start the script for only this character
;e echo(list_autostarts) will show you the files being autostarted on a given character
;e stop_autostart('script-name') will remove an autostarted file from the list
;e autostart(['sanowret-crystal', 'textsubs', 'roomnumbers']) to add many scripts at once
</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
}}

== 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</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.}}
}}

== 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=
}}

== 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=
}}

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

== 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=lumber_buddy_tree_list|desc=List of woods that you wish to chop.}}^{{Lich setting|name=lumber_implement|desc=axe, greataxe, or hatchet type weapons}}^{{Lich setting|name=lumber_use_packet|desc=Set to true to carry and use a deed packet, otherwise stow found wood}}
|uservars=
|children=safe-room
}}

== 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. Large weapons require prime, etc. Swappable weapons are not supported for this option either. Also, it works in conjunction with the setting 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=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: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: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=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
}}

== 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=It is intended to be used in [[RanikMap1|The Crossing]].
|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=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
}}

== dusk-labyrinth ==
{{Lich script
|description=Searches and loots the Duskruin Ratacombs/Labyrinth. Written for Duskruin 422
|usage=
|args=
|settings=
|uservars=
|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=
}}

== 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=
}}

== first-aid ==
{{Lich script
|description=Trains the First Aid skill by reading compendiums or textbooks
|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.}}
|uservars=
|children=
}}

== 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=
}}

== 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.
|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: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=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
}}

== 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=
}}

== 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=
}}

== 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=
}}

== 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.}}
|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.
}}

== 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.}}
|uservars=
|children=healme
}}

== sanowret-crystal ==
{{Lich script
|description= Runs in the background, gazing or exhaling your sanowret crystal. Checks for concentration and current mindstate.
|usage=
|args={{Lich setting|name=run|desc=If present, only run the script once (instead of in passive mode).}}
|settings={{Lich setting|name=sanowret_adjective|desc=The adjective of your sanowret crystal. Default setting is sanowret. Only needed if your crystal has a different adjective.}}
|uservars=
|children=
}}

== 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=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=
|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=
}}

== 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:
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:weapons:preferred_weapon|desc=The name of the weapon you wish to backstab with.}}^
{{Lich setting|name=stabbity:weapons:alternate_weapon|desc=The name of the weapon you wish to use for mobs defined in use_alternate_on.}}^
{{Lich setting|name=stabbity:weapons:thrown_weapon|desc=The name of the weapon you wish to use for mobs defined in use_alternate_on.}}^
{{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=
}}

== 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.
|usage=
|args={{Lich setting|name=source|desc=Source container.}}{{Lich setting|name=destination|desc=Destination container.}}
|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 and that Piercing Gaze is up. If 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
|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.}}
|uservars=
|children=smith, shape, sew
}}

{{cat|Lich scripts}}

Lich script repository

2019-08-05T18:58:38Z

ARCHIMEDIAN: /* Autostart */

{{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.

Usage examples of dependency autostart are shown below:
<pre>
;e autostart('script-name') will start the script called 'script-name' for all of your characters
;e autostart('script-name', false) will start the script for only this character
;e echo(list_autostarts) will show you the files being autostarted on a given character
;e stop_autostart('script-name') will remove an autostarted file from the list
;e autostart(['sanowret-crystal', 'textsubs', 'roomnumbers']) to add many scripts at once
</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
}}

== 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</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.}}
}}

== 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=
}}

== 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=
}}

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

== 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=lumber_buddy_tree_list|desc=List of woods that you wish to chop.}}^{{Lich setting|name=lumber_implement|desc=axe, greataxe, or hatchet type weapons}}^{{Lich setting|name=lumber_use_packet|desc=Set to true to carry and use a deed packet, otherwise stow found wood}}
|uservars=
|children=safe-room
}}

== 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. Large weapons require prime, etc. Swappable weapons are not supported for this option either. Also, it works in conjunction with the setting 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=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: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: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=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
}}

== 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=It is intended to be used in [[RanikMap1|The Crossing]].
|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=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
}}

== dusk-labyrinth ==
{{Lich script
|description=Searches and loots the Duskruin Ratacombs/Labyrinth. Written for Duskruin 422
|usage=
|args=
|settings=
|uservars=
|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=
}}

== 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=
}}

== first-aid ==
{{Lich script
|description=Trains the First Aid skill by reading compendiums or textbooks
|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.}}
|uservars=
|children=
}}

== 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=
}}

== 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.
|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: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=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
}}

== 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=
}}

== 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=
}}

== 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=
}}

== 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.}}
|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.
}}

== 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.}}
|uservars=
|children=healme
}}

== sanowret-crystal ==
{{Lich script
|description= Runs in the background, gazing or exhaling your sanowret crystal. Checks for concentration and current mindstate.
|usage=
|args={{Lich setting|name=run|desc=If present, only run the script once (instead of in passive mode).}}
|settings={{Lich setting|name=sanowret_adjective|desc=The adjective of your sanowret crystal. Default setting is sanowret. Only needed if your crystal has a different adjective.}}
|uservars=
|children=
}}

== 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=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=
|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=
}}

== 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:
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:weapons:preferred_weapon|desc=The name of the weapon you wish to backstab with.}}^
{{Lich setting|name=stabbity:weapons:alternate_weapon|desc=The name of the weapon you wish to use for mobs defined in use_alternate_on.}}^
{{Lich setting|name=stabbity:weapons:thrown_weapon|desc=The name of the weapon you wish to use for mobs defined in use_alternate_on.}}^
{{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=
}}

== 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.
|usage=
|args={{Lich setting|name=source|desc=Source container.}}{{Lich setting|name=destination|desc=Destination container.}}
|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 and that Piercing Gaze is up. If 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
|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.}}
|uservars=
|children=smith, shape, sew
}}

{{cat|Lich scripts}}

Lich script repository

2019-08-05T18:54:32Z

ARCHIMEDIAN: clarify autostart

{{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.

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.

Usage examples of dependency autostart are shown below:
<pre>
;e autostart('script-name') will start the script called 'script-name' for all of your characters
;e autostart('script-name', false) will start the script for only this character
;e echo(list_autostarts) will show you the files being autostarted on a given character
;e stop_autostart('script-name') will remove an autostarted file from the list
;e autostart(['sanowret-crystal', 'textsubs', 'roomnumbers']) to add many scripts at once
</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
}}

== 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</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.}}
}}

== 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=
}}

== 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=
}}

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

== 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=lumber_buddy_tree_list|desc=List of woods that you wish to chop.}}^{{Lich setting|name=lumber_implement|desc=axe, greataxe, or hatchet type weapons}}^{{Lich setting|name=lumber_use_packet|desc=Set to true to carry and use a deed packet, otherwise stow found wood}}
|uservars=
|children=safe-room
}}

== 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. Large weapons require prime, etc. Swappable weapons are not supported for this option either. Also, it works in conjunction with the setting 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=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: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: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=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
}}

== 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=It is intended to be used in [[RanikMap1|The Crossing]].
|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=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
}}

== dusk-labyrinth ==
{{Lich script
|description=Searches and loots the Duskruin Ratacombs/Labyrinth. Written for Duskruin 422
|usage=
|args=
|settings=
|uservars=
|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=
}}

== 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=
}}

== first-aid ==
{{Lich script
|description=Trains the First Aid skill by reading compendiums or textbooks
|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.}}
|uservars=
|children=
}}

== 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=
}}

== 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.
|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: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=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
}}

== 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=
}}

== 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=
}}

== 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=
}}

== 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.}}
|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.
}}

== 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.}}
|uservars=
|children=healme
}}

== sanowret-crystal ==
{{Lich script
|description= Runs in the background, gazing or exhaling your sanowret crystal. Checks for concentration and current mindstate.
|usage=
|args={{Lich setting|name=run|desc=If present, only run the script once (instead of in passive mode).}}
|settings={{Lich setting|name=sanowret_adjective|desc=The adjective of your sanowret crystal. Default setting is sanowret. Only needed if your crystal has a different adjective.}}
|uservars=
|children=
}}

== 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=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=
|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=
}}

== 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:
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:weapons:preferred_weapon|desc=The name of the weapon you wish to backstab with.}}^
{{Lich setting|name=stabbity:weapons:alternate_weapon|desc=The name of the weapon you wish to use for mobs defined in use_alternate_on.}}^
{{Lich setting|name=stabbity:weapons:thrown_weapon|desc=The name of the weapon you wish to use for mobs defined in use_alternate_on.}}^
{{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=
}}

== 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.
|usage=
|args={{Lich setting|name=source|desc=Source container.}}{{Lich setting|name=destination|desc=Destination container.}}
|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 and that Piercing Gaze is up. If 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
|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.}}
|uservars=
|children=smith, shape, sew
}}

{{cat|Lich scripts}}

Lich script repository

2019-08-05T18:49:15Z

ARCHIMEDIAN: /* Autostart */

{{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.

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.

Usage examples of dependency autostart are shown below:
<pre>
;e autostart('script-name') will start the script called 'script-name' for all of your characters
;e autostart('script-name', false) will start the script for only this character
;e echo(list_autostarts) will show you the files being autostarted on a given character
;e stop_autostart('script-name') will remove an autostarted file from the list
;e autostart(['sanowret-crystal', 'textsubs', 'roomnumbers']) to add many scripts at once
</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
}}

== 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</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.}}
}}

== 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=
}}

== 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=
}}

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

== 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=lumber_buddy_tree_list|desc=List of woods that you wish to chop.}}^{{Lich setting|name=lumber_implement|desc=axe, greataxe, or hatchet type weapons}}^{{Lich setting|name=lumber_use_packet|desc=Set to true to carry and use a deed packet, otherwise stow found wood}}
|uservars=
|children=safe-room
}}

== 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. Large weapons require prime, etc. Swappable weapons are not supported for this option either. Also, it works in conjunction with the setting 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=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: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: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=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
}}

== 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=It is intended to be used in [[RanikMap1|The Crossing]].
|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=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
}}

== dusk-labyrinth ==
{{Lich script
|description=Searches and loots the Duskruin Ratacombs/Labyrinth. Written for Duskruin 422
|usage=
|args=
|settings=
|uservars=
|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=
}}

== 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=
}}

== first-aid ==
{{Lich script
|description=Trains the First Aid skill by reading compendiums or textbooks
|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.}}
|uservars=
|children=
}}

== 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=
}}

== 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.
|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: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=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
}}

== 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=
}}

== 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=
}}

== 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=
}}

== 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.}}
|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.
}}

== 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.}}
|uservars=
|children=healme
}}

== sanowret-crystal ==
{{Lich script
|description= Runs in the background, gazing or exhaling your sanowret crystal. Checks for concentration and current mindstate.
|usage=
|args={{Lich setting|name=run|desc=If present, only run the script once (instead of in passive mode).}}
|settings={{Lich setting|name=sanowret_adjective|desc=The adjective of your sanowret crystal. Default setting is sanowret. Only needed if your crystal has a different adjective.}}
|uservars=
|children=
}}

== 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=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=
|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=
}}

== 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:
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:weapons:preferred_weapon|desc=The name of the weapon you wish to backstab with.}}^
{{Lich setting|name=stabbity:weapons:alternate_weapon|desc=The name of the weapon you wish to use for mobs defined in use_alternate_on.}}^
{{Lich setting|name=stabbity:weapons:thrown_weapon|desc=The name of the weapon you wish to use for mobs defined in use_alternate_on.}}^
{{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=
}}

== 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.
|usage=
|args={{Lich setting|name=source|desc=Source container.}}{{Lich setting|name=destination|desc=Destination container.}}
|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 and that Piercing Gaze is up. If 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
|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.}}
|uservars=
|children=smith, shape, sew
}}

{{cat|Lich scripts}}

Lich script repository

2019-07-10T11:12:13Z

ARCHIMEDIAN: /* researcher */

{{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> and <code>;e autostart</code>. The first is lich autostart and the second is dependency autostart. Use dependency autostart for any script on this page. This means you should use <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.

Usage examples of dependency autostart are shown below:
<pre>
;e autostart('script-name') will start the script called 'script-name' for all of your characters
;e autostart('script-name', false) will start the script for only this character
;e echo(list_autostarts) will show you the files being autostarted on a given character
;e stop_autostart('script-name') will remove an autostarted file from the list
;e autostart(['sanowret-crystal', 'textsubs', 'roomnumbers']) to add many scripts at once
</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
}}

== 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</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.}}
}}

== 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=
}}

== 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=
}}

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

== 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=lumber_buddy_tree_list|desc=List of woods that you wish to chop.}}^{{Lich setting|name=lumber_implement|desc=axe, greataxe, or hatchet type weapons}}^{{Lich setting|name=lumber_use_packet|desc=Set to true to carry and use a deed packet, otherwise stow found wood}}
|uservars=
|children=safe-room
}}

== 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. Large weapons require prime, etc. Swappable weapons are not supported for this option either. Also, it works in conjunction with the setting 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=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: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: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=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
}}

== 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=It is intended to be used in [[RanikMap1|The Crossing]].
|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=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
}}

== dusk-labyrinth ==
{{Lich script
|description=Searches and loots the Duskruin Ratacombs/Labyrinth. Written for Duskruin 422
|usage=
|args=
|settings=
|uservars=
|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=
}}

== 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=
}}

== first-aid ==
{{Lich script
|description=Trains the First Aid skill by reading compendiums or textbooks
|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.}}
|uservars=
|children=
}}

== 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=
}}

== 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.
|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: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=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
}}

== 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=
}}

== 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=
}}

== 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=
}}

== 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.}}
|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.
}}

== 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.}}
|uservars=
|children=healme
}}

== sanowret-crystal ==
{{Lich script
|description= Runs in the background, gazing or exhaling your sanowret crystal. Checks for concentration and current mindstate.
|usage=
|args={{Lich setting|name=run|desc=If present, only run the script once (instead of in passive mode).}}
|settings={{Lich setting|name=sanowret_adjective|desc=The adjective of your sanowret crystal. Default setting is sanowret. Only needed if your crystal has a different adjective.}}
|uservars=
|children=
}}

== 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=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=
|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=
}}

== 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:
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:weapons:preferred_weapon|desc=The name of the weapon you wish to backstab with.}}^
{{Lich setting|name=stabbity:weapons:alternate_weapon|desc=The name of the weapon you wish to use for mobs defined in use_alternate_on.}}^
{{Lich setting|name=stabbity:weapons:thrown_weapon|desc=The name of the weapon you wish to use for mobs defined in use_alternate_on.}}^
{{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=
}}

== 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).}}
|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.
|usage=
|args={{Lich setting|name=source|desc=Source container.}}{{Lich setting|name=destination|desc=Destination container.}}
|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 and that Piercing Gaze is up. If 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
|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.}}
|uservars=
|children=smith, shape, sew
}}

{{cat|Lich scripts}}

Lich script repository

2019-07-10T11:11:50Z

ARCHIMEDIAN: /* researcher */

{{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> and <code>;e autostart</code>. The first is lich autostart and the second is dependency autostart. Use dependency autostart for any script on this page. This means you should use <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.

Usage examples of dependency autostart are shown below:
<pre>
;e autostart('script-name') will start the script called 'script-name' for all of your characters
;e autostart('script-name', false) will start the script for only this character
;e echo(list_autostarts) will show you the files being autostarted on a given character
;e stop_autostart('script-name') will remove an autostarted file from the list
;e autostart(['sanowret-crystal', 'textsubs', 'roomnumbers']) to add many scripts at once
</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
}}

== 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</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.}}
}}

== 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=
}}

== 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=
}}

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

== 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=lumber_buddy_tree_list|desc=List of woods that you wish to chop.}}^{{Lich setting|name=lumber_implement|desc=axe, greataxe, or hatchet type weapons}}^{{Lich setting|name=lumber_use_packet|desc=Set to true to carry and use a deed packet, otherwise stow found wood}}
|uservars=
|children=safe-room
}}

== 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. Large weapons require prime, etc. Swappable weapons are not supported for this option either. Also, it works in conjunction with the setting 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=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: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: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=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
}}

== 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=It is intended to be used in [[RanikMap1|The Crossing]].
|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=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
}}

== dusk-labyrinth ==
{{Lich script
|description=Searches and loots the Duskruin Ratacombs/Labyrinth. Written for Duskruin 422
|usage=
|args=
|settings=
|uservars=
|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=
}}

== 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=
}}

== first-aid ==
{{Lich script
|description=Trains the First Aid skill by reading compendiums or textbooks
|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.}}
|uservars=
|children=
}}

== 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=
}}

== 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.
|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: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=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
}}

== 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=
}}

== 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=
}}

== 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=
}}

== 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.}}
|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. Specify the subject as an argument, e.g. ;researcher augmentation
|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.
}}

== 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.}}
|uservars=
|children=healme
}}

== sanowret-crystal ==
{{Lich script
|description= Runs in the background, gazing or exhaling your sanowret crystal. Checks for concentration and current mindstate.
|usage=
|args={{Lich setting|name=run|desc=If present, only run the script once (instead of in passive mode).}}
|settings={{Lich setting|name=sanowret_adjective|desc=The adjective of your sanowret crystal. Default setting is sanowret. Only needed if your crystal has a different adjective.}}
|uservars=
|children=
}}

== 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=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=
|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=
}}

== 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:
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:weapons:preferred_weapon|desc=The name of the weapon you wish to backstab with.}}^
{{Lich setting|name=stabbity:weapons:alternate_weapon|desc=The name of the weapon you wish to use for mobs defined in use_alternate_on.}}^
{{Lich setting|name=stabbity:weapons:thrown_weapon|desc=The name of the weapon you wish to use for mobs defined in use_alternate_on.}}^
{{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=
}}

== 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).}}
|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.
|usage=
|args={{Lich setting|name=source|desc=Source container.}}{{Lich setting|name=destination|desc=Destination container.}}
|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 and that Piercing Gaze is up. If 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
|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.}}
|uservars=
|children=smith, shape, sew
}}

{{cat|Lich scripts}}

Lich script repository

2019-07-10T11:10:20Z

ARCHIMEDIAN: /* researcher */

{{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> and <code>;e autostart</code>. The first is lich autostart and the second is dependency autostart. Use dependency autostart for any script on this page. This means you should use <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.

Usage examples of dependency autostart are shown below:
<pre>
;e autostart('script-name') will start the script called 'script-name' for all of your characters
;e autostart('script-name', false) will start the script for only this character
;e echo(list_autostarts) will show you the files being autostarted on a given character
;e stop_autostart('script-name') will remove an autostarted file from the list
;e autostart(['sanowret-crystal', 'textsubs', 'roomnumbers']) to add many scripts at once
</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
}}

== 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</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.}}
}}

== 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=
}}

== 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=
}}

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

== 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=lumber_buddy_tree_list|desc=List of woods that you wish to chop.}}^{{Lich setting|name=lumber_implement|desc=axe, greataxe, or hatchet type weapons}}^{{Lich setting|name=lumber_use_packet|desc=Set to true to carry and use a deed packet, otherwise stow found wood}}
|uservars=
|children=safe-room
}}

== 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. Large weapons require prime, etc. Swappable weapons are not supported for this option either. Also, it works in conjunction with the setting 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=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: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: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=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
}}

== 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=It is intended to be used in [[RanikMap1|The Crossing]].
|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=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
}}

== dusk-labyrinth ==
{{Lich script
|description=Searches and loots the Duskruin Ratacombs/Labyrinth. Written for Duskruin 422
|usage=
|args=
|settings=
|uservars=
|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=
}}

== 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=
}}

== first-aid ==
{{Lich script
|description=Trains the First Aid skill by reading compendiums or textbooks
|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.}}
|uservars=
|children=
}}

== 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=
}}

== 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.
|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: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=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
}}

== 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=
}}

== 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=
}}

== 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=
}}

== 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.}}
|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. Specify the subject as an argument, e.g. ;researcher augmentation
|usage=missing
|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.
}}

== 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.}}
|uservars=
|children=healme
}}

== sanowret-crystal ==
{{Lich script
|description= Runs in the background, gazing or exhaling your sanowret crystal. Checks for concentration and current mindstate.
|usage=
|args={{Lich setting|name=run|desc=If present, only run the script once (instead of in passive mode).}}
|settings={{Lich setting|name=sanowret_adjective|desc=The adjective of your sanowret crystal. Default setting is sanowret. Only needed if your crystal has a different adjective.}}
|uservars=
|children=
}}

== 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=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=
|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=
}}

== 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:
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:weapons:preferred_weapon|desc=The name of the weapon you wish to backstab with.}}^
{{Lich setting|name=stabbity:weapons:alternate_weapon|desc=The name of the weapon you wish to use for mobs defined in use_alternate_on.}}^
{{Lich setting|name=stabbity:weapons:thrown_weapon|desc=The name of the weapon you wish to use for mobs defined in use_alternate_on.}}^
{{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=
}}

== 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).}}
|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.
|usage=
|args={{Lich setting|name=source|desc=Source container.}}{{Lich setting|name=destination|desc=Destination container.}}
|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 and that Piercing Gaze is up. If 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
|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.}}
|uservars=
|children=smith, shape, sew
}}

{{cat|Lich scripts}}

Lich script repository

2019-07-10T11:09:04Z

ARCHIMEDIAN: /* Scripts */ Add researcher documentation

{{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> and <code>;e autostart</code>. The first is lich autostart and the second is dependency autostart. Use dependency autostart for any script on this page. This means you should use <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.

Usage examples of dependency autostart are shown below:
<pre>
;e autostart('script-name') will start the script called 'script-name' for all of your characters
;e autostart('script-name', false) will start the script for only this character
;e echo(list_autostarts) will show you the files being autostarted on a given character
;e stop_autostart('script-name') will remove an autostarted file from the list
;e autostart(['sanowret-crystal', 'textsubs', 'roomnumbers']) to add many scripts at once
</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
}}

== 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</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.}}
}}

== 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=
}}

== 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=
}}

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

== 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=lumber_buddy_tree_list|desc=List of woods that you wish to chop.}}^{{Lich setting|name=lumber_implement|desc=axe, greataxe, or hatchet type weapons}}^{{Lich setting|name=lumber_use_packet|desc=Set to true to carry and use a deed packet, otherwise stow found wood}}
|uservars=
|children=safe-room
}}

== 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. Large weapons require prime, etc. Swappable weapons are not supported for this option either. Also, it works in conjunction with the setting 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=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: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: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=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
}}

== 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=It is intended to be used in [[RanikMap1|The Crossing]].
|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=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
}}

== dusk-labyrinth ==
{{Lich script
|description=Searches and loots the Duskruin Ratacombs/Labyrinth. Written for Duskruin 422
|usage=
|args=
|settings=
|uservars=
|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=
}}

== 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=
}}

== first-aid ==
{{Lich script
|description=Trains the First Aid skill by reading compendiums or textbooks
|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.}}
|uservars=
|children=
}}

== 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=
}}

== 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.
|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: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=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
}}

== 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=
}}

== 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=
}}

== 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=
}}

== 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.}}
|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=Missing
|usage=missing
|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.
}}

== 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.}}
|uservars=
|children=healme
}}

== sanowret-crystal ==
{{Lich script
|description= Runs in the background, gazing or exhaling your sanowret crystal. Checks for concentration and current mindstate.
|usage=
|args={{Lich setting|name=run|desc=If present, only run the script once (instead of in passive mode).}}
|settings={{Lich setting|name=sanowret_adjective|desc=The adjective of your sanowret crystal. Default setting is sanowret. Only needed if your crystal has a different adjective.}}
|uservars=
|children=
}}

== 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=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=
|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=
}}

== 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:
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:weapons:preferred_weapon|desc=The name of the weapon you wish to backstab with.}}^
{{Lich setting|name=stabbity:weapons:alternate_weapon|desc=The name of the weapon you wish to use for mobs defined in use_alternate_on.}}^
{{Lich setting|name=stabbity:weapons:thrown_weapon|desc=The name of the weapon you wish to use for mobs defined in use_alternate_on.}}^
{{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=
}}

== 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).}}
|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.
|usage=
|args={{Lich setting|name=source|desc=Source container.}}{{Lich setting|name=destination|desc=Destination container.}}
|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 and that Piercing Gaze is up. If 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
|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.}}
|uservars=
|children=smith, shape, sew
}}

{{cat|Lich scripts}}

Lich script repository

2019-01-13T13:55:17Z

ARCHIMEDIAN: /* Scripts */ Add placeholder for coordinator

{{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> and <code>;e autostart</code>. The first is lich autostart and the second is dependency autostart. Use dependency autostart for any script on this page. This means you should use <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.

Usage examples of dependency autostart are shown below:
<pre>
;e autostart('script-name') will start the script called 'script-name' for all of your characters
;e autostart('script-name', false) will start the script for only this character
;e echo(list_autostarts) will show you the files being autostarted on a given character
;e stop_autostart('script-name') will remove an autostarted file from the list
;e autostart(['sanowret-crystal', 'textsubs', 'roomnumbers']) to add many scripts at once
</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
}}

== 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</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.}}
}}

== 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.}}
}}

== 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=
}}

== 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=
}}

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

== 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=lumber_buddy_tree_listt|desc=List of woods that you wish to chop.}}^{{Lich setting|name=lumber_implement|desc=axe, greataxe, or hatchet type weapons}}^{{Lich setting|name=lumber_use_packet|desc=Set to true to carry and use a deed packet, otherwise stow found wood}}
|uservars=
|children=safe-room
}}

== 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. Large weapons require prime, etc. Swappable weapons are not supported for this option either. Also, it works in conjunction with the setting 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=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: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: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=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
}}

== 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=It is intended to be used in [[RanikMap1|The Crossing]].
|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=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
}}

== dusk-labyrinth ==
{{Lich script
|description=Searches and loots the Duskruin Ratacombs/Labyrinth. Written for Duskruin 422
|usage=
|args=
|settings=
|uservars=
|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=
}}

== 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=
}}

== first-aid ==
{{Lich script
|description=Trains the First Aid skill by reading compendiums or textbooks
|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.}}
|uservars=
|children=
}}

== 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=
}}

== 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.
|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: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=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
}}

== 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=
}}

== 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=
}}

== 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=
}}

== 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.}}
|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.
}}

== 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.
}}

== 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.}}
|uservars=
|children=healme
}}

== sanowret-crystal ==
{{Lich script
|description= Runs in the background, gazing or exhaling your sanowret crystal. Checks for concentration and current mindstate.
|usage=
|args={{Lich setting|name=run|desc=If present, only run the script once (instead of in passive mode).}}
|settings=
|uservars=
|children=
}}

== 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=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=
|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=
}}

== 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=
}}

== 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=
}}

== 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).}}
|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.
|usage=
|args={{Lich setting|name=source|desc=Source container.}}{{Lich setting|name=destination|desc=Destination container.}}
|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 and that Piercing Gaze is up. If 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
|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.}}
|uservars=
|children=smith, shape, sew
}}

{{cat|Lich scripts}}

Lich script repository

2019-01-09T19:10:40Z

ARCHIMEDIAN: /* Scripts */ add titlecheck

{{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> and <code>;e autostart</code>. The first is lich autostart and the second is dependency autostart. Use dependency autostart for any script on this page. This means you should use <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.

Usage examples of dependency autostart are shown below:
<pre>
;e autostart('script-name') will start the script called 'script-name' for all of your characters
;e autostart('script-name', false) will start the script for only this character
;e echo(list_autostarts) will show you the files being autostarted on a given character
;e stop_autostart('script-name') will remove an autostarted file from the list
;e autostart(['sanowret-crystal', 'textsubs', 'roomnumbers']) to add many scripts at once
</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
}}

== 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</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.}}
}}

== 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.}}
}}

== 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=
}}

== 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=
}}

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

== 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=lumber_buddy_tree_listt|desc=List of woods that you wish to chop.}}^{{Lich setting|name=lumber_implement|desc=axe, greataxe, or hatchet type weapons}}^{{Lich setting|name=lumber_use_packet|desc=Set to true to carry and use a deed packet, otherwise stow found wood}}
|uservars=
|children=safe-room
}}

== 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=
}}

== 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. Large weapons require prime, etc. Swappable weapons are not supported for this option either. Also, it works in conjunction with the setting 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=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: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: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=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
}}

== 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=It is intended to be used in [[RanikMap1|The Crossing]].
|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=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
}}

== dusk-labyrinth ==
{{Lich script
|description=Searches and loots the Duskruin Ratacombs/Labyrinth. Written for Duskruin 422
|usage=
|args=
|settings=
|uservars=
|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=
}}

== 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=
}}

== first-aid ==
{{Lich script
|description=Trains the First Aid skill by reading compendiums or textbooks
|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.}}
|uservars=
|children=
}}

== 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=
}}

== 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.
|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: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=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
}}

== 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=
}}

== 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=
}}

== 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=
}}

== 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.}}
|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.
}}

== 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.
}}

== 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.}}
|uservars=
|children=healme
}}

== sanowret-crystal ==
{{Lich script
|description= Runs in the background, gazing or exhaling your sanowret crystal. Checks for concentration and current mindstate.
|usage=
|args={{Lich setting|name=run|desc=If present, only run the script once (instead of in passive mode).}}
|settings=
|uservars=
|children=
}}

== 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=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=
|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=
}}

== 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=
}}

== 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=
}}

== 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).}}
|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.
|usage=
|args={{Lich setting|name=source|desc=Source container.}}{{Lich setting|name=destination|desc=Destination container.}}
|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 and that Piercing Gaze is up. If 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
|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.}}
|uservars=
|children=smith, shape, sew
}}

{{cat|Lich scripts}}

Lich script repository

2018-07-23T17:19:44Z

ARCHIMEDIAN: /* safe-room */ Document wound threshold setting

{{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].

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> and <code>;e autostart</code>. The first is lich autostart and the second is dependency autostart. Use dependency autostart for any script on this page. This means you should use <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.

Usage examples of dependency autostart are shown below:
<pre>
;e autostart('script-name') will start the script called 'script-name' for all of your characters
;e autostart('script-name', false) will start the script for only this character
;e echo(list_autostarts) will show you the files being autostarted on a given character
;e stop_autostart('script-name') will remove an autostarted file from the list
;e autostart(['sanowret-crystal', 'textsubs', 'roomnumbers']) to add many scripts at once
</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 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=
}}

== 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
}}

== 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</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.}}
}}

== 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.}}
}}

== 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=
}}

== 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=
}}

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

== 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=lumber_buddy_tree_listt|desc=List of woods that you wish to chop.}}^{{Lich setting|name=lumber_implement|desc=axe, greataxe, or hatchet type weapons}}^{{Lich setting|name=lumber_use_packet|desc=Set to true to carry and use a deed packet, otherwise stow found wood}}
|uservars=
|children=safe-room
}}

== 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=
}}

== 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. Large weapons require prime, etc. Swappable weapons are not supported for this option either. Also, it works in conjunction with the setting 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=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: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: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: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=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
}}

== 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=It is intended to be used in [[RanikMap1|The Crossing]].
|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=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
}}

== dusk-labyrinth ==
{{Lich script
|description=Searches and loots the Duskruin Ratacombs/Labyrinth. Written for Duskruin 422
|usage=
|args=
|settings=
|uservars=
|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=
}}

== 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=
}}

== first-aid ==
{{Lich script
|description=Trains the First Aid skill by reading compendiums or textbooks
|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.}}
|uservars=
|children=
}}

== 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=
}}

== 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.
|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: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=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
}}

== 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=
}}

== 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=
}}

== 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=
}}

== 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.}}
|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.
}}

== 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.
}}

== 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. You can customize the values to your skill level:
rezz:
Resurrection:
abbrev: rezz
mana: 17
Rejuvenation:
abbrev: rejuv
mana: 10
prep_time: 10
cambrinth:
- 15
- 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.}}
|uservars=
|children=healme
}}

== sanowret-crystal ==
{{Lich script
|description= Runs in the background, gazing or exhaling your sanowret crystal. Checks for concentration and current mindstate.
|usage=
|args={{Lich setting|name=run|desc=If present, only run the script once (instead of in passive mode).}}
|settings=
|uservars=
|children=
}}

== 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=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=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=
|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=
}}

== 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=
}}

== 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=
}}

== 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).}}
|uservars=
|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.
|usage=
|args={{Lich setting|name=source|desc=Source container.}}{{Lich setting|name=destination|desc=Destination container.}}
|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=
}}

== 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
|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.}}
|uservars=
|children=smith, shape, sew
}}

{{cat|Lich scripts}}

Lich script repository

2018-07-12T19:04:11Z

ARCHIMEDIAN: /* Scripts */ Add sell pouches script

{{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].

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> and <code>;e autostart</code>. The first is lich autostart and the second is dependency autostart. Use dependency autostart for any script on this page. This means you should use <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.

Usage examples of dependency autostart are shown below:
<pre>
;e autostart('script-name') will start the script called 'script-name' for all of your characters
;e autostart('script-name', false) will start the script for only this character
;e echo(list_autostarts) will show you the files being autostarted on a given character
;e stop_autostart('script-name') will remove an autostarted file from the list
;e autostart(['sanowret-crystal', 'textsubs', 'roomnumbers']) to add many scripts at once
</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 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=
}}

== 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
}}

== 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</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.}}
}}

== 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.}}
}}

== 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=
}}

== 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=
}}

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

== 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=lumber_buddy_tree_listt|desc=List of woods that you wish to chop.}}^{{Lich setting|name=lumber_implement|desc=axe, greataxe, or hatchet type weapons}}^{{Lich setting|name=lumber_use_packet|desc=Set to true to carry and use a deed packet, otherwise stow found wood}}
|uservars=
|children=safe-room
}}

== 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=
}}

== 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. Large weapons require prime, etc. Swappable weapons are not supported for this option either. Also, it works in conjunction with the setting 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=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: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: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: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=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
}}

== craft ==
{{Lich script
|description=Crafts one item.
|args={{Lich setting|name=outfitting|desc=Knit.}}^{{Lich setting|name=forge|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=It is intended to be used in [[RanikMap1|The Crossing]].
|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=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
}}

== dusk-labyrinth ==
{{Lich script
|description=Searches and loots the Duskruin Ratacombs/Labyrinth. Written for Duskruin 422
|usage=
|args=
|settings=
|uservars=
|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=
}}

== 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=
}}

== first-aid ==
{{Lich script
|description=Trains the First Aid skill by reading compendiums or textbooks
|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.}}
|uservars=
|children=
}}

== 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=
}}

== 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.
|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: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=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
}}

== 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=
}}

== 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=
}}

== 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=
}}

== 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.}}
|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.
}}

== 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.
}}

== 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. You can customize the values to your skill level:
rezz:
Resurrection:
abbrev: rezz
mana: 17
Rejuvenation:
abbrev: rejuv
mana: 10
prep_time: 10
cambrinth:
- 15
- 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=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.}}
|uservars=
|children=healme
}}

== sanowret-crystal ==
{{Lich script
|description= Runs in the background, gazing or exhaling your sanowret crystal. Checks for concentration and current mindstate.
|usage=
|args={{Lich setting|name=run|desc=If present, only run the script once (instead of in passive mode).}}
|settings=
|uservars=
|children=
}}

== 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=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=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=
|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=
}}

== 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=
}}

== 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=
}}

== 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).}}
|uservars=
|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.
|usage=
|args={{Lich setting|name=source|desc=Source container.}}{{Lich setting|name=destination|desc=Destination container.}}
|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=
}}

== 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
|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.}}
|uservars=
|children=smith, shape, sew
}}

{{cat|Lich scripts}}

Lich script repository

2018-01-26T01:38:45Z

ARCHIMEDIAN: /* mm */

{{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].

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.

== What all can I configure? ==
That's a good question! Take a look at the [https://github.com/rpherbig/dr-scripts/wiki/List-of-All-Character-Settings List of All Character Settings.]

== 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> and <code>;e autostart</code>. The first is lich autostart and the second is dependency autostart. Use dependency autostart for any script on this page. This means you should use <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.

Usage examples of dependency autostart are shown below:
<pre>
;e autostart('script-name') will start the script called 'script-name' for all of your characters
;e autostart('script-name', false) will start the script for only this character
;e echo(list_autostarts) will show you the files being autostarted on a given character
;e stop_autostart('script-name') will remove an autostarted file from the list
;e autostart(['sanowret-crystal', 'textsubs', 'roomnumbers']) to add many scripts at once
</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 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=
}}

== 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>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
}}

== 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</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
|settings={{Lich setting|name=have_climbing_rope|desc=Set this to true to use a magic climbing rope for training. This currently requires zills.}}
}}

== 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.}}
}}

== 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=
}}

== 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=
}}

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

== 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=lumber_buddy_tree_listt|desc=List of woods that you wish to chop.}}^{{Lich setting|name=lumber_implement|desc=axe, greataxe, or hatchet type weapons}}^{{Lich setting|name=lumber_use_packet|desc=Set to true to carry and use a deed packet, otherwise stow found wood}}
|uservars=
|children=safe-room
}}

== 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, and kertigen commune quests if you are the right level.
|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=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_train_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: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=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=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: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: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: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_weapons|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=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
}}

== crossing-repair ==
{{Lich script
|description=Repair items in your gear list.
|usage=It is intended to be used in [[RanikMap1|The Crossing]].
|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=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
}}

== dusk-labyrinth ==
{{Lich script
|description=Searches and loots the Duskruin Ratacombs/Labyrinth. Written for Duskruin 422
|usage=
|args=
|settings=
|uservars=
|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=
}}

== 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=
}}

== first-aid ==
{{Lich script
|description=Trains the First Aid skill by reading compendiums or textbooks
|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.}}
|uservars=
|children=
}}

== 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=
}}

== 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.
|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.}}
}}

== 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: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_buddies|desc=List of PC's that you're ok to share a hunting room 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
}}

== 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=
}}

== 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=
}}

== 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=
}}

== pay-debt ==
{{Lich script
|description=Pays your debt. Optionally retrieves your sack of belongings from the guard house.
|usage=
|args=
|settings=
|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=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.}}
|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.
}}

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

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

== 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 room and wait for 45 seconds for a player empath to heal you. 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=safe_room_empath|desc=Name of PC empath healer.}}^{{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.}}
|uservars=
|children=healme
}}

== sanowret-crystal ==
{{Lich script
|description= Runs in the background, gazing or exhaling your sanowret crystal. Checks for concentration and current mindstate.
|usage=
|args={{Lich setting|name=run|desc=If present, only run the script once (instead of in passive mode).}}
|settings=
|uservars=
|children=
}}

== 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=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=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=
}}

== 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
* <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>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=
|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=
}}

== 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=
}}

== 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=
}}

== 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).}}
|uservars=
|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.
|usage=
|args={{Lich setting|name=source|desc=Source container.}}{{Lich setting|name=destination|desc=Destination container.}}
|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=
}}

== 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
|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.}}
|uservars=
|children=smith, shape, sew
}}

{{cat|Lich scripts}}

Lich script repository

2018-01-26T01:37:23Z

ARCHIMEDIAN: /* mm */

{{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].

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.

== What all can I configure? ==
That's a good question! Take a look at the [https://github.com/rpherbig/dr-scripts/wiki/List-of-All-Character-Settings List of All Character Settings.]

== 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> and <code>;e autostart</code>. The first is lich autostart and the second is dependency autostart. Use dependency autostart for any script on this page. This means you should use <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.

Usage examples of dependency autostart are shown below:
<pre>
;e autostart('script-name') will start the script called 'script-name' for all of your characters
;e autostart('script-name', false) will start the script for only this character
;e echo(list_autostarts) will show you the files being autostarted on a given character
;e stop_autostart('script-name') will remove an autostarted file from the list
;e autostart(['sanowret-crystal', 'textsubs', 'roomnumbers']) to add many scripts at once
</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 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=
}}

== 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>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
}}

== 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</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
|settings={{Lich setting|name=have_climbing_rope|desc=Set this to true to use a magic climbing rope for training. This currently requires zills.}}
}}

== 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.}}
}}

== 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=
}}

== 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=
}}

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

== 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=lumber_buddy_tree_listt|desc=List of woods that you wish to chop.}}^{{Lich setting|name=lumber_implement|desc=axe, greataxe, or hatchet type weapons}}^{{Lich setting|name=lumber_use_packet|desc=Set to true to carry and use a deed packet, otherwise stow found wood}}
|uservars=
|children=safe-room
}}

== 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, and kertigen commune quests if you are the right level.
|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=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_train_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: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=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=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: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: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: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_weapons|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=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
}}

== crossing-repair ==
{{Lich script
|description=Repair items in your gear list.
|usage=It is intended to be used in [[RanikMap1|The Crossing]].
|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=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
}}

== dusk-labyrinth ==
{{Lich script
|description=Searches and loots the Duskruin Ratacombs/Labyrinth. Written for Duskruin 422
|usage=
|args=
|settings=
|uservars=
|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=
}}

== 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=
}}

== first-aid ==
{{Lich script
|description=Trains the First Aid skill by reading compendiums or textbooks
|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.}}
|uservars=
|children=
}}

== 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=
}}

== 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.
|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.}}
}}

== 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: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_buddies|desc=List of PC's that you're ok to share a hunting room 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
}}

== 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=
}}

== 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=
}}

== 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=Rifts the given name to your current room. Checks if the moons are up}}
|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=
}}

== pay-debt ==
{{Lich script
|description=Pays your debt. Optionally retrieves your sack of belongings from the guard house.
|usage=
|args=
|settings=
|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=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.}}
|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.
}}

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

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

== 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 room and wait for 45 seconds for a player empath to heal you. 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=safe_room_empath|desc=Name of PC empath healer.}}^{{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.}}
|uservars=
|children=healme
}}

== sanowret-crystal ==
{{Lich script
|description= Runs in the background, gazing or exhaling your sanowret crystal. Checks for concentration and current mindstate.
|usage=
|args={{Lich setting|name=run|desc=If present, only run the script once (instead of in passive mode).}}
|settings=
|uservars=
|children=
}}

== 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=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=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=
}}

== 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
* <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>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=
|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=
}}

== 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=
}}

== 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=
}}

== 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).}}
|uservars=
|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.
|usage=
|args={{Lich setting|name=source|desc=Source container.}}{{Lich setting|name=destination|desc=Destination container.}}
|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=
}}

== 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
|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.}}
|uservars=
|children=smith, shape, sew
}}

{{cat|Lich scripts}}

Lich script repository

2018-01-26T01:37:05Z

ARCHIMEDIAN: /* mm */ fix formatting

{{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].

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.

== What all can I configure? ==
That's a good question! Take a look at the [https://github.com/rpherbig/dr-scripts/wiki/List-of-All-Character-Settings List of All Character Settings.]

== 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> and <code>;e autostart</code>. The first is lich autostart and the second is dependency autostart. Use dependency autostart for any script on this page. This means you should use <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.

Usage examples of dependency autostart are shown below:
<pre>
;e autostart('script-name') will start the script called 'script-name' for all of your characters
;e autostart('script-name', false) will start the script for only this character
;e echo(list_autostarts) will show you the files being autostarted on a given character
;e stop_autostart('script-name') will remove an autostarted file from the list
;e autostart(['sanowret-crystal', 'textsubs', 'roomnumbers']) to add many scripts at once
</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 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=
}}

== 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>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
}}

== 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</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
|settings={{Lich setting|name=have_climbing_rope|desc=Set this to true to use a magic climbing rope for training. This currently requires zills.}}
}}

== 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.}}
}}

== 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=
}}

== 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=
}}

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

== 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=lumber_buddy_tree_listt|desc=List of woods that you wish to chop.}}^{{Lich setting|name=lumber_implement|desc=axe, greataxe, or hatchet type weapons}}^{{Lich setting|name=lumber_use_packet|desc=Set to true to carry and use a deed packet, otherwise stow found wood}}
|uservars=
|children=safe-room
}}

== 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, and kertigen commune quests if you are the right level.
|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=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_train_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: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=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=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: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: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: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_weapons|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=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
}}

== crossing-repair ==
{{Lich script
|description=Repair items in your gear list.
|usage=It is intended to be used in [[RanikMap1|The Crossing]].
|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=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
}}

== dusk-labyrinth ==
{{Lich script
|description=Searches and loots the Duskruin Ratacombs/Labyrinth. Written for Duskruin 422
|usage=
|args=
|settings=
|uservars=
|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=
}}

== 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=
}}

== first-aid ==
{{Lich script
|description=Trains the First Aid skill by reading compendiums or textbooks
|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.}}
|uservars=
|children=
}}

== 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=
}}

== 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.
|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.}}
}}

== 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: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_buddies|desc=List of PC's that you're ok to share a hunting room 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
}}

== 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=
}}

== 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=
}}

== 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=Rifts the given name to your current room. Checks if the moons are up}}
|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 locate 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=
}}

== pay-debt ==
{{Lich script
|description=Pays your debt. Optionally retrieves your sack of belongings from the guard house.
|usage=
|args=
|settings=
|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=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.}}
|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.
}}

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

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

== 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 room and wait for 45 seconds for a player empath to heal you. 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=safe_room_empath|desc=Name of PC empath healer.}}^{{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.}}
|uservars=
|children=healme
}}

== sanowret-crystal ==
{{Lich script
|description= Runs in the background, gazing or exhaling your sanowret crystal. Checks for concentration and current mindstate.
|usage=
|args={{Lich setting|name=run|desc=If present, only run the script once (instead of in passive mode).}}
|settings=
|uservars=
|children=
}}

== 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=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=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=
}}

== 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
* <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>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=
|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=
}}

== 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=
}}

== 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=
}}

== 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).}}
|uservars=
|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.
|usage=
|args={{Lich setting|name=source|desc=Source container.}}{{Lich setting|name=destination|desc=Destination container.}}
|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=
}}

== 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
|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.}}
|uservars=
|children=smith, shape, sew
}}

{{cat|Lich scripts}}

Lich script repository

2018-01-26T01:34:49Z

ARCHIMEDIAN: /* mm */ add rift

{{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].

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.

== What all can I configure? ==
That's a good question! Take a look at the [https://github.com/rpherbig/dr-scripts/wiki/List-of-All-Character-Settings List of All Character Settings.]

== 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> and <code>;e autostart</code>. The first is lich autostart and the second is dependency autostart. Use dependency autostart for any script on this page. This means you should use <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.

Usage examples of dependency autostart are shown below:
<pre>
;e autostart('script-name') will start the script called 'script-name' for all of your characters
;e autostart('script-name', false) will start the script for only this character
;e echo(list_autostarts) will show you the files being autostarted on a given character
;e stop_autostart('script-name') will remove an autostarted file from the list
;e autostart(['sanowret-crystal', 'textsubs', 'roomnumbers']) to add many scripts at once
</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 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=
}}

== 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>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
}}

== 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</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
|settings={{Lich setting|name=have_climbing_rope|desc=Set this to true to use a magic climbing rope for training. This currently requires zills.}}
}}

== 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.}}
}}

== 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=
}}

== 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=
}}

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

== 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=lumber_buddy_tree_listt|desc=List of woods that you wish to chop.}}^{{Lich setting|name=lumber_implement|desc=axe, greataxe, or hatchet type weapons}}^{{Lich setting|name=lumber_use_packet|desc=Set to true to carry and use a deed packet, otherwise stow found wood}}
|uservars=
|children=safe-room
}}

== 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, and kertigen commune quests if you are the right level.
|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=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_train_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: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=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=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: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: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: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_weapons|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=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
}}

== crossing-repair ==
{{Lich script
|description=Repair items in your gear list.
|usage=It is intended to be used in [[RanikMap1|The Crossing]].
|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=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
}}

== dusk-labyrinth ==
{{Lich script
|description=Searches and loots the Duskruin Ratacombs/Labyrinth. Written for Duskruin 422
|usage=
|args=
|settings=
|uservars=
|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=
}}

== 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=
}}

== first-aid ==
{{Lich script
|description=Trains the First Aid skill by reading compendiums or textbooks
|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.}}
|uservars=
|children=
}}

== 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=
}}

== 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.
|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.}}
}}

== 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: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_buddies|desc=List of PC's that you're ok to share a hunting room 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
}}

== 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=
}}

== 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=
}}

== 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=Rifts the given name to your current room. Checks if the moons are up}}
|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 locate 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=
}}

== pay-debt ==
{{Lich script
|description=Pays your debt. Optionally retrieves your sack of belongings from the guard house.
|usage=
|args=
|settings=
|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=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.}}
|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.
}}

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

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

== 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 room and wait for 45 seconds for a player empath to heal you. 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=safe_room_empath|desc=Name of PC empath healer.}}^{{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.}}
|uservars=
|children=healme
}}

== sanowret-crystal ==
{{Lich script
|description= Runs in the background, gazing or exhaling your sanowret crystal. Checks for concentration and current mindstate.
|usage=
|args={{Lich setting|name=run|desc=If present, only run the script once (instead of in passive mode).}}
|settings=
|uservars=
|children=
}}

== 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=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=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=
}}

== 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
* <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>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=
|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=
}}

== 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=
}}

== 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=
}}

== 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).}}
|uservars=
|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.
|usage=
|args={{Lich setting|name=source|desc=Source container.}}{{Lich setting|name=destination|desc=Destination container.}}
|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=
}}

== 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
|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.}}
|uservars=
|children=smith, shape, sew
}}

{{cat|Lich scripts}}

Lich script repository

2018-01-25T23:29:27Z

ARCHIMEDIAN: Add mm script

{{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].

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.

== What all can I configure? ==
That's a good question! Take a look at the [https://github.com/rpherbig/dr-scripts/wiki/List-of-All-Character-Settings List of All Character Settings.]

== 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> and <code>;e autostart</code>. The first is lich autostart and the second is dependency autostart. Use dependency autostart for any script on this page. This means you should use <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.

Usage examples of dependency autostart are shown below:
<pre>
;e autostart('script-name') will start the script called 'script-name' for all of your characters
;e autostart('script-name', false) will start the script for only this character
;e echo(list_autostarts) will show you the files being autostarted on a given character
;e stop_autostart('script-name') will remove an autostarted file from the list
;e autostart(['sanowret-crystal', 'textsubs', 'roomnumbers']) to add many scripts at once
</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 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=
}}

== 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>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
}}

== 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</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
|settings={{Lich setting|name=have_climbing_rope|desc=Set this to true to use a magic climbing rope for training. This currently requires zills.}}
}}

== 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.}}
}}

== 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=
}}

== 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=
}}

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

== 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=lumber_buddy_tree_listt|desc=List of woods that you wish to chop.}}^{{Lich setting|name=lumber_implement|desc=axe, greataxe, or hatchet type weapons}}^{{Lich setting|name=lumber_use_packet|desc=Set to true to carry and use a deed packet, otherwise stow found wood}}
|uservars=
|children=safe-room
}}

== 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, and kertigen commune quests if you are the right level.
|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=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_train_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: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=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=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: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: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: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_weapons|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=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
}}

== crossing-repair ==
{{Lich script
|description=Repair items in your gear list.
|usage=It is intended to be used in [[RanikMap1|The Crossing]].
|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=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
}}

== dusk-labyrinth ==
{{Lich script
|description=Searches and loots the Duskruin Ratacombs/Labyrinth. Written for Duskruin 422
|usage=
|args=
|settings=
|uservars=
|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=
}}

== 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=
}}

== first-aid ==
{{Lich script
|description=Trains the First Aid skill by reading compendiums or textbooks
|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.}}
|uservars=
|children=
}}

== 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=
}}

== 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.
|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.}}
}}

== 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: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_buddies|desc=List of PC's that you're ok to share a hunting room 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
}}

== 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=
}}

== 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=
}}

== 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}}
|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.}}
|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=
}}

== pay-debt ==
{{Lich script
|description=Pays your debt. Optionally retrieves your sack of belongings from the guard house.
|usage=
|args=
|settings=
|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=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.}}
|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.
}}

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

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

== 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 room and wait for 45 seconds for a player empath to heal you. 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=safe_room_empath|desc=Name of PC empath healer.}}^{{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.}}
|uservars=
|children=healme
}}

== sanowret-crystal ==
{{Lich script
|description= Runs in the background, gazing or exhaling your sanowret crystal. Checks for concentration and current mindstate.
|usage=
|args={{Lich setting|name=run|desc=If present, only run the script once (instead of in passive mode).}}
|settings=
|uservars=
|children=
}}

== 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=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=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=
}}

== 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
* <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>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=
|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=
}}

== 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=
}}

== 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=
}}

== 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).}}
|uservars=
|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.
|usage=
|args={{Lich setting|name=source|desc=Source container.}}{{Lich setting|name=destination|desc=Destination container.}}
|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=
}}

== 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
|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.}}
|uservars=
|children=smith, shape, sew
}}

{{cat|Lich scripts}}

Lich script repository

2018-01-21T10:42:30Z

ARCHIMEDIAN: /* bescort */ Add citizenship uservar

{{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].

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.

== What all can I configure? ==
That's a good question! Take a look at the [https://github.com/rpherbig/dr-scripts/wiki/List-of-All-Character-Settings List of All Character Settings.]

== 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> and <code>;e autostart</code>. The first is lich autostart and the second is dependency autostart. Use dependency autostart for any script on this page. This means you should use <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.

Usage examples of dependency autostart are shown below:
<pre>
;e autostart('script-name') will start the script called 'script-name' for all of your characters
;e autostart('script-name', false) will start the script for only this character
;e echo(list_autostarts) will show you the files being autostarted on a given character
;e stop_autostart('script-name') will remove an autostarted file from the list
;e autostart(['sanowret-crystal', 'textsubs', 'roomnumbers']) to add many scripts at once
</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 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=
}}

== 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>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
}}

== 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</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
|settings={{Lich setting|name=have_climbing_rope|desc=Set this to true to use a magic climbing rope for training. This currently requires zills.}}
}}

== 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.}}
}}

== 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=
}}

== 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=
}}

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

== 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=lumber_buddy_tree_listt|desc=List of woods that you wish to chop.}}^{{Lich setting|name=lumber_implement|desc=axe, greataxe, or hatchet type weapons}}^{{Lich setting|name=lumber_use_packet|desc=Set to true to carry and use a deed packet, otherwise stow found wood}}
|uservars=
|children=safe-room
}}

== 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, and kertigen commune quests if you are the right level.
|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=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_train_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: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=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=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: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: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: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_weapons|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=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
}}

== crossing-repair ==
{{Lich script
|description=Repair items in your gear list.
|usage=It is intended to be used in [[RanikMap1|The Crossing]].
|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=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
}}

== dusk-labyrinth ==
{{Lich script
|description=Searches and loots the Duskruin Ratacombs/Labyrinth. Written for Duskruin 422
|usage=
|args=
|settings=
|uservars=
|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=
}}

== 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=
}}

== first-aid ==
{{Lich script
|description=Trains the First Aid skill by reading compendiums or textbooks
|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.}}
|uservars=
|children=
}}

== 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=
}}

== 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.
|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.}}
}}

== 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: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_buddies|desc=List of PC's that you're ok to share a hunting room 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
}}

== 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=
}}

== 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=
}}

== 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=
}}

== 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=
}}

== pay-debt ==
{{Lich script
|description=Pays your debt. Optionally retrieves your sack of belongings from the guard house.
|usage=
|args=
|settings=
|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=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.}}
|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.
}}

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

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

== 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 room and wait for 45 seconds for a player empath to heal you. 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=safe_room_empath|desc=Name of PC empath healer.}}^{{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.}}
|uservars=
|children=healme
}}

== sanowret-crystal ==
{{Lich script
|description= Runs in the background, gazing or exhaling your sanowret crystal. Checks for concentration and current mindstate.
|usage=
|args={{Lich setting|name=run|desc=If present, only run the script once (instead of in passive mode).}}
|settings=
|uservars=
|children=
}}

== 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=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=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=
}}

== 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
* <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>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=
|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=
}}

== 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=
}}

== 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=
}}

== 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).}}
|uservars=
|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.
|usage=
|args={{Lich setting|name=source|desc=Source container.}}{{Lich setting|name=destination|desc=Destination container.}}
|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=
}}

== 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
|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.}}
|uservars=
|children=smith, shape, sew
}}

{{cat|Lich scripts}}

Lich script repository

2018-01-02T15:47:44Z

ARCHIMEDIAN: Add trade script

{{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].

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.

== What all can I configure? ==
That's a good question! Take a look at the [https://github.com/rpherbig/dr-scripts/wiki/List-of-All-Character-Settings List of All Character Settings.]

== 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> and <code>;e autostart</code>. The first is lich autostart and the second is dependency autostart. Use dependency autostart for any script on this page. This means you should use <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.

Usage examples of dependency autostart are shown below:
<pre>
;e autostart('script-name') will start the script called 'script-name' for all of your characters
;e autostart('script-name', false) will start the script for only this character
;e echo(list_autostarts) will show you the files being autostarted on a given character
;e stop_autostart('script-name') will remove an autostarted file from the list
;e autostart(['sanowret-crystal', 'textsubs', 'roomnumbers']) to add many scripts at once
</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 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=
}}

== appraisal ==
{{Lich script
|description=Trains the Appraisal skill by appraising your gear, zills, 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
- 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>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>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
}}

== 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</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
|settings={{Lich setting|name=have_climbing_rope|desc=Set this to true to use a magic climbing rope for training. This currently requires zills.}}
}}

== 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.}}
}}

== 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=
}}

== 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=
|children=
}}

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

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

== 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=lumber_buddy_tree_listt|desc=List of woods that you wish to chop.}}^{{Lich setting|name=lumber_implement|desc=axe, greataxe, or hatchet type weapons}}^{{Lich setting|name=lumber_use_packet|desc=Set to true to carry and use a deed packet, otherwise stow found wood}}
|uservars=
|children=safe-room
}}

== 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=
}}

== 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=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_train_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: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=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=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: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: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: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_weapons|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=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
}}

== crossing-repair ==
{{Lich script
|description=Repair items in your gear list.
|usage=It is intended to be used in [[RanikMap1|The Crossing]].
|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=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
}}

== dusk-labyrinth ==
{{Lich script
|description=Searches and loots the Duskruin Ratacombs/Labyrinth. Written for Duskruin 422
|usage=
|args=
|settings=
|uservars=
|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=
}}

== 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=
}}

== 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=
}}

== first-aid ==
{{Lich script
|description=Trains the First Aid skill by reading compendiums or textbooks
|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.}}
|uservars=
|children=
}}

== 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=
}}

== 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=
}}

== 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.
|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.}}
}}

== 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: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_buddies|desc=List of PC's that you're ok to share a hunting room 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
}}

== jail-buddy ==
{{Lich script
|description= Handles being arrested in the crossing
|usage= Keep running.
|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=
}}

== 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=
}}

== 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=
}}

== pay-debt ==
{{Lich script
|description=Pays your debt. Optionally retrieves your sack of belongings from the guard house.
|usage=
|args=
|settings=
|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=
|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=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.}}
|uservars={{Lich setting|name=lockpick_debug|desc=Turns on debugging messages.}}
|children=
}}

== 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 beused as a during: in combat but works anywhere as long as you are stationary.

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

== 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 room and wait for 45 seconds for a player empath to heal you. 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=safe_room_empath|desc=Name of PC empath healer.}}^{{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.}}
|uservars=
|children=healme
}}

== sanowret-crystal ==
{{Lich script
|description= Runs in the background, gazing or exhaling your sanowret crystal. Checks for concentration and current mindstate.
|usage=
|args={{Lich setting|name=run|desc=If present, only run the script once (instead of in passive mode).}}
|settings=
|uservars=
|children=
}}

== 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=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=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=
}}

== 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>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>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>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=
|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=
}}

== 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=
}}

== 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=
}}

== 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).}}
|uservars=
|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.
|usage=
|args={{Lich setting|name=source|desc=Source container.}}{{Lich setting|name=destination|desc=Destination container.}}
|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=
}}

== 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
|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.}}
|uservars=
|children=smith, shape, sew
}}

{{cat|Lich scripts}}