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

Description

Researches one magic research topic, or one symbiosis, until it's finished, then exits. It keeps Gauge Flow up while you research, and starts the research again if something interrupts it.

You must know Gauge Flow. Without it, the script says "Gauge Flow is required to research. Exiting."
If you're already researching a different topic, that project is cancelled before the new one starts.

Settings

YAML Settings

Topic

research:
  topic: fundamental
  debug: false
Setting Default Purpose
research: topic What to research when you don't give a topic on the command line. One of the topics below, or symbiosis <type>. Any case.
research: debug false Show debug messages. The debug argument does the same for one run.

If there's no topic on the command line or in your yaml, the script says so and stops.

Topics
fundamental
stream (attunement also works)
augmentation
utility
warding
sorcery
energy
field
spell
plane (or planes)
road
wild

Anything else stops the script with "Invalid research topic" and the list of valid topics.

Symbiosis

research:
  topic: symbiosis heal

To research a symbiosis, use symbiosis followed by its type. On the command line the type must be one of these:

activate, avoid, cast, discern, endure, examine, explore, harness, harvest, heal, impress, learn, perform, remember, resolve, spell, spring, strengthen, watch

On the command line, symbiosis with no type stops the script and lists the types. A type in your yaml isn't checked against this list; a wrong one is caught by the game instead.

Gauge Flow

waggle_sets:
  gaf:
    Gauge Flow:
      mana: 15

Whenever Gauge Flow isn't up, it's cast before researching. If you have a gaf waggle set with Gauge Flow in it, that's used, so you can set the mana, cambrinth and so on. Otherwise it's cast at 5 mana.

What a run does

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

  1. Checks you know Gauge Flow and that the topic is valid.
  2. Checks RESEARCH STATUS. If you're researching a different topic, it cancels that project (RESEARCH CANCEL three times, to be sure).
  3. Casts Gauge Flow if it isn't up, then runs RESEARCH <topic> 300.
  4. Every 5 seconds, it checks on the research:
    • If it's interrupted (you're distracted by combat or your spellcasting, lose your focus, forget what you were doing, or there's still more to learn), it starts the research again.
    • If Gauge Flow has dropped, it recasts it. If it still isn't up after that, the script stops.
  5. On a breakthrough (or when a symbiosis is committed to memory), it exits.
  • If the game says you can't begin the project, it cancels whatever you're researching and tries again.
  • If the game doesn't recognize the topic ("Usage:" or "You do not know how to research"), it says "Invalid research option" and stops.

Argument Settings

Arguments override your yaml for this run.

Argument Purpose
topic Research this topic instead of research: topic. Any topic from the table above, or attunement for stream.
symbiosis type Research this symbiosis instead.
debug Show debug messages.

Usage

;researcher

;researcher fundamental

;researcher augmentation debug

;researcher symbiosis heal

;researcher help

crossing-training's use_research and research_skills settings do their own research and don't use this script.
⚠️ **GitHub.com Fallback** ⚠️