Don't forget, you can log in with your Play.net account

Lich script repository

From Elanthipedia
Revision as of 14:20, 7 January 2025 by RANGERMAHTRA (talk | contribs)
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)
Jump to navigation Jump to search


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

Setup and Installation

Lich install instructions

Come to the Lich Discord #install channel if you need help

For script-specific documentation, see the appropriate section, below. For YAML documentation, see GitHub's YAML and Guides.

For any bugs, please see us on GitHub 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 train_with_spells: true, that means that the train_with_spells setting is being assigned a value of true. This may also be referred to as a hash in which train_with_spells is mapped to true. 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 loot_additions of item nouns that you want to loot:

loot_additions:
- card
- dira
- bolt
- arrow
- stone

A comment is any line that starts with a #. 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 some of these.

Loading YAML Files

YAML files are loaded in a predefined order. base.yaml is loaded first, then YourCharacterName-setup.yaml. If any arguments are given to a script (for example, ;combat-trainer BacktrainWeapons), then YourCharacterName-BacktrainWeapons.yaml 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 dance_threshold to be 1 in YourCharacterName-setup.yaml and then redefine it to be 0 in YourCharacterName-BacktrainWeapons.yaml.

base.yaml provides defaults for many (but not all) of the settings. You should never modify base.yaml directly; instead override settings in YourCharacterName-setup.yaml or YourCharacterName-SomethingElse.yaml. If you think something should be changed in base.yaml, please contact us in-game or open a 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

Many users prefer to have certain scripts automatically start every time their character loads. To do that, use the below commands to designate scripts to start for every character or character-specific.

Add an autostart

;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

List autostart scripts

;e echo list_autostarts will show you the files being autostarted on a given character

Remove an autostart

;e stop_autostart('script-name') will remove an autostarted file from the list

The other autostart

There are two autostart scripts. The above commands are for normal use. Advanced options found below under autostart script details.

Scripts

accept-sell

Accepts an outstanding trade offer for a pouch/bundle, appraises it and sells it. Returning coins, item, and a profit report to the owner.


addroom

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.


afk

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.


almanac

Uses an almanac every 10 minutes. Pauses all other scripts, stows your left hand, studies it, then unpauses everything.


appraisal

Trains the Appraisal skill by appraising your gear, zills, bundles, gem pouches, and studying the art in the Crossing art gallery. Use the appraisal_training setting to specify a training regimen.


arrows

Creates shaft, arrowheads, and arrows all in one script.


astrology

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.


athletics

Athletics training script


attunement

Trains attunement via power walking or perceiving in a single room. Empaths can optionally train empathy via health walking.


autocontingency

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

The other method is autocontingency invoke. When run in this manner, typically after a hunt or a long athletics trip to the far side of Elanthia, the script will invoke the Contingency to bring you back to your point of origin.


automap

Mapping assistance script


autostart

Advanced core lich autostart option - Please be sure you have read the earlier Autostart section explaining the different autostart options before reading this.


avtalia

Traders only. When run, it watches cambrinth defined in avtalia_array:. It maintains a running list of how much mana is in those cambrinth and allows it to be pulled by scripts like combat-trainer when mana is low.


bankbot

Have a character act as a banker


bescort

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.


bolts

Creates shaft, boltheads, and bolts all in one script. Syntax: ;bolts type lumber yes

  • Examples:
;bolts drake-fang maple
;bolts drake-fang balsa yes
;bolts continue


buff

Casts waggle sets defined in your yaml. Casts the default: waggle set if no args are given.


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

burgle

Breaking and Entering - Used to train Thievery, Stealth, and depending on entry method, 1 of Athletics (rope) / Locksmithing(lockpick). Extremely high fines if you are caught. Be sure to read the Breaking and Entering page to understand how the system works prior to using this script.


carve


carve-bead

Automates the creation of a prayer bead, either from a held block or foraged and crafted block.


carve-lockpicks

Carves lockpicks from keyblanks on your person, then puts those lockpicks on rings.


cast

Automates command line casting.


charge-holy-weapon

Charges holy weapon if below 200 estimated remaining uses. Usable in Crossing or Shard Chadatru temples, or in a player-specified room using a holy icon. There is a large cooldown, and if too low circle & charisma, this could be bad. Best used independently on lower circle Paladins.


chop-wood

Chops trees in a room while watching for danger


circlecheck

Circle check tells you how far you are from your next or target circle.


cleric-quests

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.


coordinator

Training manager script


combat-trainer

Train combat skills in your current room.


corn-maze

Runs the Hollow Eve corn maze.


craft

Crafts one item.


crossing-repair

Repair items in your gear list.


crossing-training

Trains non-combat skills. Despite the name, crossing-trainer this works in other towns using the hometown setting.


crowns

Plays the Hollow Eve's game dice/crowns.


dusk-labyrinth

Searches for pets, bloodscrip, and loot in Duskruin Labyrinth.


echo


edityaml


empathylink

Will link to your hunting_buddies while in combat running combat-trainer. Will attempt to link with Hodierna, if known, or Unity if not.


equipmanager


expreset

Resets your EXP window in Wrayth. This is useful for removing erroneous game output that gets 'stuck' in your exp window (usually during connection).


faux-atmo

Bring your verby items to life! Turn toys and items with fun verbs into atmospherics by periodically performing a random verb on a random item based on your settings.


favor

Gets one favor by rubbing an orb repeatedly.


fill-dirt

Fills a dirt stacker with dirt.


find

Finds an NPC in The Crossing.


find-darkbox

Finds and plays the Hollow Eve's game Darkbox.


first-aid

Trains the First Aid skill by reading compendiums or textbooks More in-depth look at first-aid.lic: https://github.com/elanthia-online/dr-scripts/wiki/First-Aid-Strategy


faskinner

Trains the First Aid skill with training items such as a small blue-belly crocodile with prominently stitched seams or a small fuzzy caracal with tufted ears and double-stitched seams.


feed-cloak

Feeds living vine cloaks that you are wearing so that they stay refreshed and healthy.


forge

Forges an item. Adapted from a script by Mallitek.


gbox

Hand all boxes from a container (the first argument) to a character (the second argument).


glyph-of-mana

A script that will keep glyph of mana up always.


gmoney

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.


heal-remedy

Uses crafted remedies for healing


healme

A self healing script for empaths.


herb-stock

Restocks herbs for healing with herbs in combat


horse-trainer

Teaches all skills to a horse.


hunting-buddy

Trains combat skills (using combat-trainer) in defined hunting areas


inventory-manager

Stores current "inv list" data in a YAML file for searching from any character... works across multiple accounts.


invoke-rune

Use to cast spells from runestones. The runestones are the ones purchased from Sierack's Reagents, https://elanthipedia.play.net/Sierack%27s_Reagents, in Shard. Can add more from Enchanting or other places.


jail-buddy

Handles being arrested in the crossing


join-thieves

Joins the thieves guild in Crossing.


journal

A script to use an epistemic journal. Best used as an after:


lamprey

Plays the Hollow Eve's game lamprey. Can only play this game once every 10 minutes if you get a lamprey or prize.


levelup

Walks to your guild leader and levels up as many times as you can.


locksmithing

Trains locksmithing independently or with crossing-training. Can use unlimited training boxes, daily charge training boxes, or limited use disposable training items such as corn maze pouches, liquor cabinets, or burgled keepsake boxes. Also trains performance while picking.


makesteel

Makes steel ingots. The script will handle acquiring the needed materials.


mine

Mines a room while watching for danger


mining-buddy

Perform a single pass through the mines


mining-manager

repeatedly mines in defined mining areas (using mining-buddy)


mm

A general purpose moon mage utility script


moonwatch

populates UserVars.moons with data related to the moons


multi

Executes a series of actions or scripts multiple times.


newbie-gear

Crafts a set of gear for a new character.


offload-items

Offloads all items from one source container to a destination container. Differs from transfer-items, because you can change the preposition. (I.e. on, in, under, behind, etc.) It may need to be run multiple times if you have a lot of stuff. If you use an adjective you must type it completely in double quotes, e.g. "hide sack", not "h sack".


oshu_manor

Navigates you through the Oshu Manor. Used to hunt Seordhevor kartais. Note there is an underscore in this script's name, not a dash.


paladin-quests

Completes the paladin Glyph quests for you.


pattern-hues

Casts Warrior Mage Pattern Hues cantrip at set intervals.


pay-debt

Pays your debt. Optionally retrieves your sack of belongings from the guard house.


performance

Script to train performance. Defaults to worn instrument but accepts an instrument setting


performance-monitor

Logs combat-related events such as damage, roundtime, etc. for later parsing.


pick

Disarms, unlocks, and loots monster boxes


release_cyclic

Releases all cyclic spells.


ranger-companion

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

Does research on a single subject.


register

A script for searching your deed register.


remedy

A script for crafting remedies using alchemy.


repeat

A script for repeating a sequence of up to 10 commands. Does not take scripts.


restock

A script for restocking your supply of stackable and nonstackable items.


rezz

A script to rezz corpses


roomnumbers

Adapted from a script by Geldan for Gemstone. Appends the Lich room ID# to your in-game room look.


rummage

Standalone script that reformats the contents of a container as a table.


safe-room

Heals at a PC or NPC empath and shares items between characters by taking and dropping them in a safe room


sanowret-crystal

Runs in the background, gazing or exhaling your sanowret crystal to train Arcana. Checks for concentration and current mindstate to run only when necessary. Supports worn crystals or stored in a container.


schedule

Executes a series of actions or scripts (via multi script) if at least N minutes have elapsed since the last time they were done.


scroll-search

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.


sell-loot

Sells gems and bundles; then deposits coin. Defaults to keeping 3 silver on hand (the maximum amount that cannot be stolen by a Thief).


sell-pouches

Sell gem pouches for trading experience


setupaliases

Adds a useful selection of aliases to the global list:


sew


shape


sigilharvest

Script for sigil harvesting


sigilrecorder


skill-recorder


slackbot

If the status-monitor script detects an problem, it will use this script to send you a Direct Message on Slack.


smartlisten

If someone teaches you an approved class you'll start listening.


smarttransfer

safely transfer wounds from the target, avoiding useless injuries in fatal areas


smash-pumpkins

Travel to the pumpkin vat, buy one, go one room away to smash and repeat until too injured. Then return to the safe room.


smelt

Smelt the contents of a crucible. Assumes that material has already been placed into the crucible. Smelt refine, to refine metals.


smelt-deeds

combines deeds of like metals to save inventory space


smith


smoke

Automates smoking pipes, cigars, and cigarillos.


sorcery


sort-scrolls

This is an alternative to stack-scrolls. This script uses all scroll stackers of the same noun, labeled with the guild.


sorter

Runs in the background and reformats the contents when you look in/on/behind/under items.


spin

This script is intended to be used in The Crossing.


stabbity

Stabbity is designed for thieves, and relies on backstab and thrown weapons to kill things quickly. It's useful in invasions and events.


stack-scrolls

Scroll stacker manager script that stores and retrieves scrolls using stackers.


status-monitor

Informs user of high-frequency game output and characters current health via a small window. Useful for keeping tabs on multiple characters.


steal


study-art

Walks through the Crossing art gallery and appraises each piece on display. Trains scholarship and appraisal.


su-helmas

Runs catacombs tasks (empath) until you're out of tickets or out of room in your bag


summoning

Trains summoning via summoning and breaking a magical weapon. Summons admittance to build up charges to summon a weapon. Warrior Mages must have already ALIGNed to an element.


t2

An alternative trainer script that runs sub-scripts to train skills based on thresholds and conditions. Supplemental information: https://github.com/elanthia-online/dr-scripts/wiki/T2-Tutorial


task-forage

Completes foraging tasks given by Mags in the Crossing, and the flower peddler in Shard, in order to train Trading.


tarantula

Manages the automated usage of the biomechanical tarantula, a gift handed out for patrons of Hollow Eve 432.


tendme

Automatic wound tender for self. On start, checks HEALTH for bleeding wounds and tends them, then watches for messages to unbind or retend wounds.


tendother

Automatic wound tender for another player. On start, looks for bleeding wounds and tends them, then watches for messages to unbind or retend wounds.


tessera

Uses the Tessera item every 6 minutes, 15 second (default). Runs in the background and handles safe pausing and unpausing running scripts.


textsubs

Provides in-game text substitution capabilities; comes with many defaults (e.g. appraisal and combat messages).


theurgy

train theurgy by working up devotion and doing communes


titlecheck

Checks for new titles since the last time you ran the script.


trade

Do caravan trading in Zoluren


|usage=

  • ;trade closeup

will deliver all remaining crates, then return your caravan to avoid fees.

  • ;trade hunt

will occasionally run a hunt defined in your charactername-caravanhunt.yaml file (see Quillith-caravanhunt.yaml) whenever you stop in your hometown and your Trading exp is high enough.

  • ;trade duration

will run for X minutes before locking down new contracts and closing up.

  • ;trade roomid

will take your caravan to a particular room.

train

Train the given attributes. It is intended to be used in The Crossing.


training-manager

High level script for managing combat and non combat training


transfer-items

Transfers all items from one container to another. It may need to be run multiple times if you have a lot of stuff. If you use an adjective you must type it completely in double quotes, e.g. "hide sack", not "h sack".


truffenyi-commune-quest

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.


validate

Checks character yamls for common mistakes.


vanity-pet

Some vanity pets, like hogs and monkeys, can be set on the ground to follow you. At times, these pets need to be stowed away for safe keeping, such as before burgling so that they aren't lost when a room unloads. When stowing, the script will wait for pet to arrive in your room (sometimes the pet may lag behind, especially if you move fast and far).


wait

Designed for use with the multi script to pause N seconds between commands.


walkingastro

Runs as a background script whose aim is to keep your prediction pools filling and the Astrology Skill moving.


wand-watcher

Activates wands automatically based on cooldown timer


weave-cloth

This script is intended to be used in The Crossing.


workorders

completes a workorder for the given discipline. Supplemental information: https://github.com/elanthia-online/dr-scripts/wiki/Crafting-Setup