Waggle Sets

Waggle sets are a set of spell data sets in your YAML settings file. You can think of them like a lich spellbook. Many scripts refer to this data to know which spells to cast. You can individually cast a waggle set by using the ;buff script followed by the set name, e.g. ;buff astrology to cast the astrology waggle set.

Creating your first set

Start by adding the following to your settings file:

waggle_sets:
  default:
  prehunt_buffs:

We've created two empty sets here, nested inside of waggle_sets, one called 'default' and another called 'prehunt_buffs'. This isn't going to do much until you start adding spells to it, so lets add a spell...

waggle_sets:
  default:
    Manifest Force:
      mana: 10
      cambrinth:
      - 10
  prehunt_buffs:

Lets test it out in-game. Release the spell if its active (release maf in the above case) and run the ;buff script with no arguments. This should cast the Manifest Force spell. The default waggle set is used whenever the ;buff script is ran without arguments. When you want to cast another set with ;buff, include the set name. For example ;buff prehunt_buffs would cast the prehunt_buffs set.

Add the data for Manifest Force to the prehunt_buffs set now and try it out.

prehunt_buffs is an example of a set used by another script. ;hunting-buddy casts the spells in prehunt_buffs before it takes you hunting.

You can make up your own set names to use with ;buff. For example:

waggle_sets:
  default:
    Manifest Force:
      mana: 10
      cambrinth:
      - 10
    Lay Ward:
      mana: 10
      cambrinth:
      - 10
      - 10
  prehunt_buffs:
    Manifest Force:
      mana: 10
      cambrinth:
      - 10
  perception:
    Clear Vision:
      mana: 20   

Now you can run ;buff perception to cast any spells listed in the perception set.

Additionally you can use advanced options that allow you to control how much mana or concentration you require before casting a spell. These values below are default and deemed safe for most characters.

waggle_spells_concentration_threshold: 80
waggle_spells_mana_threshold: 40

Waggle sets used by other scripts

Set Name	Used by Scripts	Description
astrology	astrology	List of buffs to casting before and during astrology training
attunement	attunement	Buffs to cast before power-walking
burgle	burgle	Buffs to cast right before doing breaking and entering
default	buff	Default waggle set used by ;buff with no arguments
prehunt_buffs	hunting-buddy	Buffs to cast before hunting
pick	pick	Buffs to cast before opening boxes. Will not be used on pets
sew	sew	Buffs to cast before outfitting
smith	smith	Buffs to cast before forging
town-training	crossing-training	Buffs to cast at the start of crossing-training
zombie	combat-trainer	Spells related to necromancer arisen zombies. Not meant to be called via ;buff
om_create	om	List your OM spell here to automatically get orb and create an OM
om_buff	om	List the spells you want to put into your OM orb. cast: touch orb required.

Spell settings

The following spell settings can be used. If a value is left out of your spell data, then it is filled in with the default value. For example, you can leave out the recast: setting and let it be filled in by the script.

Setting	Description	Default Value
mana	Mana amount used in preparing the spell	Minimum Prep
cambrinth	A list of mana amounts to charge cambrinth with	None
skill	Magic skill used by spell (e.g. Warding)	Magic Skill
recast	Minutes left on spell timer before spell is recast	Varies by spell, usually 1
prep	Command used to prepare the spell (e.g. prepare)	Varies by spell
cast	What to cast the spell at (e.g. cast katamba)	cast
prep_time	Number of seconds to wait before casting. A value of 1 will snap cast after 1 second of prep time, a value of 5 will snap cast after 5 seconds of prep time, etc.	None
cyclic	set to true if the spell is cyclic	true if the spell is cyclic
use_auto_mana	Determines mana and cambrinth options via the discern command.	false