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

Studies a scholarship tome (the books sold in shops like Tomes of Lore) to train Scholarship. It works in one of two ways:

• Passive. It stays running in the background. It only studies while one of your passive_scripts is running and it's safe to, getting the tome out and putting it away as needed.
• Active. It sits down and studies over and over until Scholarship reaches your goal, then stands up and exits.

All of these go under tome_settings: unless noted.

Set every key you care about. base.yaml comes with a tome_settings block, but as soon as you add your own tome_settings (and you must, to set tome_name), yours replaces it completely. Anything you leave out gets the script's own default, shown in the tables below, not the base.yaml value. In particular, leaving out passive means active mode, and leaving out quit_early means it's off. The Full example below is the base.yaml block, ready to copy.

tome_settings:
  tome_name: spiritwood tome
gear:
- :adjective: spiritwood
  :name: tome

tome_settings:
  scholarship_limit: 30
  quit_early: true
  second_to_last_page:

Without quit_early, it reads to the end ("Having finished your studies,"). With it, it watches for the start of the second-to-last page, and these tomes are built in:

With quit_early: true, a tome_name that isn't in this table, and no second_to_last_page, the script errors as soon as it starts.

tome_settings:
  passive: true
  passive_scripts:
    - appraisal
    - attunement
    - first-aid
    - outdoorsmanship
    - crossing-repair
    - task-forage

In passive mode, it studies only when all of these are true:

• Scholarship is below scholarship_limit.
• You aren't hidden or invisible.
• You have a hand free, or the tome is already in one.
• You aren't in a room on your sanowret_no_use_rooms list.
• One of your passive_scripts is running.
• Your concentration is full.

If any of these stops being true while you're reading (for example, the passive script finishes), it puts the tome away and waits again. Your other scripts are paused for a moment each time it gets the tome out, starts studying or puts it away, so they don't trip over each other. Passive mode never exits by itself.

In active mode, it sits down (unless ;safe-room is running) and waits only for full concentration before each study. It doesn't check your hands, the room or other scripts, so start it with a hand free, somewhere it's safe to study. Once Scholarship reaches scholarship_limit it stands up and exits. If it's already there when you start, it exits right away.

sanowret_no_use_rooms:
  - Carousel Chamber
  - Carousel Booth
  - 1900
  - Knife Clan, Triage

Top level, and shared with sanowret-crystal. In passive mode, it won't study in these rooms. Each entry is part of a room title, or a room id. The list above is the base.yaml default; if you set your own, it replaces this one, so copy any entries you want to keep.

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

1. Waits until it should study and your concentration is full.
2. Gets your tome out and STUDYs it.
3. If the game says you can't study right now (you're unable to focus, in combat, in the middle of magical research, short of concentration, or somewhere that isn't allowed), it puts the tome away, waits 10 seconds and tries again.
4. Reads for at least 10 seconds. Then it keeps reading until the tome is finished (or the second-to-last page, with quit_early), until your concentration is full again, or until it should stop.
5. Puts the tome away and starts over.

If it can't get your tome out, it tries again straight away, over and over. Make sure get my <tome_name> works, and keep a hand free in active mode.

tome_settings:
  tome_name: spiritwood tome
  quit_early: true
  scholarship_limit: 30
  passive: true
  passive_scripts:
    - appraisal
    - attunement
    - first-aid
    - outdoorsmanship
    - crossing-repair
    - task-forage
# add this to your existing gear list
gear:
- :adjective: spiritwood
  :name: tome

tome_settings: debug, which is in base.yaml, isn't read. Use the debug argument instead.

;tome

;tome active

;tome debug

With passive: true, start ;tome once and leave it running. It studies whenever one of your passive_scripts is running, and puts the tome away when none are.

Study while you wait to be healed:

tome_while_healing: true

While ;safe-room waits for healing, it runs ;tome active, and stops it afterwards if safe-room started it.

- skill: Scholarship
  start: 10
  scripts:
  - tome active