Coordinator Settings

Description

Plans your training from lists of tasks: hunts, things to do in town, and clean-up after each hunt. Each time round, it does the first task that's due, in this order:

1. a clean-up task, after a hunt or when it starts, if its conditions are met;
2. the first town task whose conditions are met;
3. the first hunt whose conditions are met;
4. your default hunt;
5. otherwise, it waits a minute in your safe_room, with AFK running.

A hunt runs Hunting Buddy with its hunting file. While it runs, the hunt's stop_on is checked every minute, and ends the hunt when it comes true. Afterwards, it goes back to your safe_room. See also Coordinator Tutorials.

Clean-up tasks don't run at the moment: Coordinator picks them, but never starts their script or action. Put clean-up in your hunting files' after lists instead.

It releases your cyclic spells when it starts. When it stops, it stops Hunting Buddy and Crossing Training too. It always shows its debug messages.

Settings

YAML Settings

coordinator_hunting_tasks:
- :file: back
  :default: true
  :start_on:
    any_skill_under:
      skills:
      - Small Edged
      - Brawling
      target: 10
coordinator_hunting_cleanup:
- :script: crossing-repair
  :skip_first_run: true
coordinator_town_tasks:
- :script: appraisal
  :walk_to: safe_room
  :start_on:
    and:
    - timer:
        key: appraisal
        time: 300
    - skill_under:
        skill: Appraisal
        target: 5
- :action: crossing_training
  :start_on:
    predicate: run_crossing_training?
safe_room: 851

Setting	Default	Purpose
coordinator_hunting_tasks		Your hunts.
coordinator_town_tasks		What to do in town.
coordinator_hunting_cleanup		What to do after each hunt.
safe_room	851	Where to go after a hunt, and to wait.

Task settings

Setting	For	Purpose
:file:	hunts	The hunting file for Hunting Buddy, e.g. back for <character>-back.yaml.
:default:	hunts	Do this hunt when nothing else is due.
:safe_room:	hunts	Go here afterwards instead, as id: 1234.
:no_cleanup:	hunts	Don't queue the clean-up tasks after this hunt.
:skip_first_run:	clean-up	Not when Coordinator starts; only after hunts.
:script:	town, clean-up	The script to run.
:args:	town, clean-up	A list of arguments for it.
:action:	town, clean-up	A built-in action instead of a script; see below.
:walk_to:	town, clean-up	Walk here first: safe_room or a room number.
:buff:	town, clean-up	A waggle set to cast first, with ;buff.
:play_song:	town, clean-up	Play your instrument while the script runs.
:town:	town, clean-up	Necromancers: run ;release-necro first.
:pause_sanowret:	all	Pause Sanowret Crystal during the task.
:start_on:	all	The task is due when this is true. Without it, it's always due.
:stop_on:	all	The task isn't due while this is true.

Conditions

start_on and stop_on each take one condition:

Condition	True when
skill_under (or skill_less_than)	skill's mindstate is below target.
skill_over	skill's mindstate is above target.
any_skill_under (or any_skill_less_than)	Any of skills is below target.
boxes_over, boxes_under	You carry more, or fewer, boxes than this.
encumbrance_over	Your encumbrance level is over this.
timer	time seconds have passed since the task last finished. Give it a key; with global: true, it's remembered between runs.
predicate	hunt_done? (no hunt is due) or run_crossing_training? (a skill in your crossing_training is below 28).
and, or	A list of conditions, all or any of which are true.
after_every_hunt, on_first_run	Accepted, but never true at the moment.

Actions

Action	What it does
pick_boxes	Walks to your lockpick_room_id, casts your locksmithing waggle set if you have one, and runs ;pick.
train_performance	Plays your instrument. If it can't, the task is dropped.
train_outfitting	;workorders Tailoring, then ;sell-loot.
train_alchemy	;workorders Remedies, then ;sell-loot.
train_engineering	;workorders Shaping, then ;sell-loot.
train_forging	;workorders Blacksmithing, then ;sell-loot.
crossing_training	Runs Crossing Training until every skill in your crossing_training reaches 28.
infuse_osrel	Infuses your Osrel Meraud orb with osrel_amount mana. If OM is down or osrel_amount isn't set, the task is dropped.
check_favors	Keeps your favors at favor_goal, as Checkfavors does, using the Crossing favor altar.

Argument Settings

None.

Usage

;coordinator