Almanac Settings - elanthia-online/dr-scripts GitHub Wiki

Description

Studies your almanac whenever its 10-minute cooldown is up, for as long as the script runs. If you have a "pick a skill" almanac, it turns it to the skill that needs training most before each study.

It's meant to run in the background alongside your other scripts. While it studies, it pauses the other scripts so they don't interfere, then resumes them.

Your almanac must be listed in your `gear:`, or the script won't start. Anything you hold in your hands should be in `gear:` so it isn't lost.

Settings

YAML Settings

Your almanac

almanac_noun: almanac
almanac_startup_delay: 15
almanac_report_details: false

Setting	Default	Purpose
almanac_noun	almanac	Your almanac's noun (almanac, tome, treatise, monograph, ...).
almanac_startup_delay	15	Seconds to wait before the first study.
almanac_report_details	false	After each study, say which skill it picked and how much it gained.

Choosing the skill

Only for an almanac you can turn to a skill. Leave almanac_skills blank otherwise.

almanac_skills:
  - Appraisal
  - Scholarship
  - Mechanical Lore
almanac_priority_skills:
  - Scholarship

Before each study it picks, in this order:

The almanac_priority_skills skill with the lowest mindstate (then lowest rank), counting only skills below mindstate 18.
Otherwise, the same from almanac_skills.
Otherwise, your skill with the lowest mindstate overall (skipping capped skills, untrained skills and Mechanical Lore).

When not to study

almanac_no_use_scripts:
  - combat-trainer
  - burgle
  - pick
almanac_no_use_rooms:
  - !ruby/regexp /\b(Carousel|Vault|Item Registration Office|Registrar's Office)\b/

Setting	Default	Purpose
almanac_no_use_scripts	a long list (see below)	Don't study while any of these scripts is running.
almanac_no_use_rooms	the vaults and registration offices	Room ids, room titles or regular expressions where it won't study.

The default script list is: alchemy, astrology, athletics, bescort, burgle, carve, clean-leather, clean-lumber, combat-trainer, corn-maze, craft, enchant, feed-cloak, forge, get2, go2, locksmithing, mech-lore, outdoorsmanship, pick, remedy, scouting, sew, shape, smelt, smith, stabbity, steal, tinker and workorders. Setting the list in your own profile replaces it.

It also waits while you're hidden or invisible, or while both your hands are full.

combat-trainer is on the default list, but its `Almanac` training ability uses this script to study when it's running. See training abilities.

How studying is handled

There are no settings for these; this is what to expect.

Cooldown. After a study, it waits 10 minutes. If the almanac says you've gleaned all you can, or its pages seem worn, it tries again a minute later.
Closed almanac. It opens it and studies.
Hands full. If it can't get the almanac into your hands, it tries again later.
Stopping. It stops if your almanac can't be found, if a Premium almanac is used on a non-Premium account, or if all your skills are capped.

Argument Settings

None.

Usage

;almanac

Autostart

The simplest way to keep it running is to have it start every time you log in. Add it to the autostarts: list in your setup YAML:

autostarts:
  - almanac

or add it with Lich's autostart command: ;autostart add almanac.