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

Lich script repository: Difference between revisions

From Elanthipedia
Jump to navigation Jump to search
No edit summary
Line 4: Line 4:


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

Revision as of 03:20, 27 August 2018


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

For script-specific documentation, see the appropriate section, below. For YAML documentation, see 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 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

There are two autostart scripts. ;autostart and ;e autostart. 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 ;e autostart('scriptname') instead of ;autostart add scriptname

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

Usage examples of dependency autostart are shown below:

;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

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.


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.


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 in perceiving in a single room. Power walking rooms are based on your hometown setting unless the attunement_rooms setting is filled out. Moon mages will not powerwalk, but use perceive mana instead. This script will cast spells listed in the waggle_set called 'attunement' when it starts.


automap

Mapping assistance script


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.


buff

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


carve


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.


combat-trainer

Train combat skills in your current room.


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.


dusk-labyrinth

Searches and loots the Duskruin Ratacombs/Labyrinth. Written for Duskruin 422


echo


edityaml


equipmanager


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


favor

Gets one favor by rubbing an orb repeatedly.


fill-dirt

Fills a dirt stacker with dirt.


find

Finds an NPC in The Crossing.


first-aid

Trains the First Aid skill by reading compendiums or textbooks


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


horse-trainer

Teaches all skills to a horse.


hunting-buddy

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


jail-buddy

Handles being arrested in the crossing


join-thieves

Joins the thieves guild in Crossing.


levelup

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


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


newbie-gear

Crafts a set of gear for a new character.


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.


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, harvests, and unlocks 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.


register

A script for searching your deed register.


remedy

A script for crafting remedies using alchemy.


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. Example:

[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


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. Checks for concentration and current mindstate.


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:

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


sew


shape


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-deeds

combines deeds of like metals to save inventory space


smith


sorcery


spin

This script is intended to be used in The Crossing.


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.


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.


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


trade

Do caravan trading in Zoluren


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.


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.


weave-cloth

This script is intended to be used in The Crossing.


workorders

completes a workorder for the given discipline