Sort Scrolls Settings

Description

Files loose spell scrolls into scroll stackers ("cases") labeled by guild, one case per guild plus one for overflow. It can also pull a copy of a spell out of your cases, or unleash a spell straight from its scroll.

An alternative to stack-scrolls, which uses its own stack_scrolls: settings and doesn't need labeled cases.

Setup

You need 10 scroll stackers that all share the same noun. Put a wax label on each and label it with a guild name, so they look like this:

a striking felwood scroll case topped with a trio of silver-infused Gnomish kocho labeled "Bard"
a striking felwood scroll case topped with a trio of silver-infused Gnomish kocho labeled "Cleric"
a vibrant pink leather scroll case lined with spun rainbow labeled "Empath"
a vibrant pink leather scroll case lined with spun rainbow labeled "Moon Mage"
a vibrant pink leather scroll case lined with spun rainbow labeled "Necromancer"
a striking felwood scroll case topped with a trio of silver-infused Gnomish kocho labeled "Paladin"
a vibrant pink leather scroll case lined with spun rainbow labeled "Ranger"
a cerulean watersilk scroll case secured with a silver clasp labeled "Trader"
a vibrant pink leather scroll case lined with spun rainbow labeled "Warrior Mage"
a cerulean watersilk scroll case secured with a silver clasp labeled "Extras"

The labels must match the guild names exactly. The "Extras" case takes the overflow when a guild's case is full. Keep all the cases in your stacker_container.

Settings

YAML Settings

default_container: backpack
scroll_sorter:
  stacker: scroll case
  stacker_container: haversack
  unleash_mana: 30
  unleash_harnesses: 2
  close_container: false

Setting	Default	Purpose
default_container		Where to look for loose scrolls. The container argument overrides it.
scroll_sorter: stacker		The noun (or adjective and noun) your cases share, e.g. scroll case.
scroll_sorter: stacker_container		Where your cases are kept. They're put back there afterwards. Required: there's no fallback.
scroll_sorter: unleash_mana		Mana to harness up to before casting, with unleash.
scroll_sorter: unleash_harnesses	1	How many harnesses to split that mana across.
scroll_sorter: close_container	false	Close stacker_container when the script ends.

Unleashing

unleash runs your unleash waggle set (;buff unleash), which should start preparing the spell. Once it's preparing, the script harnesses up to unleash_mana, then casts. If no spell is being prepared, it says the unleash failed. Either way, the scroll is filed back into its case.

waggle_sets:
  unleash:

How scrolls are sorted

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

• Finding the guild. A labeled scroll is sorted by its label. An unlabeled scroll is read to find out which spell it holds.
• Full cases. When a guild's case is full, the scroll goes into the "Extras" case.
• Analogous Pattern scrolls can't be stored, so they're thrown away.
• Unknown spells. If a scroll's spell isn't in base-spells.yaml (for example a newly released spell), the script says so and stops.

Argument Settings

Argument	Purpose
container	Sort the scrolls in this container (one word) instead of default_container.
find spell	Pull one copy of a spell out of your cases. If it isn't in its guild's case, the "Extras" case is checked too.
unleash spell	Pull a copy of the spell, cast it with unleash, and file the scroll back.

For find and unleash, give the spell's full name or its abbreviation. Put a name with more than one word in double quotes.

Usage

;sort-scrolls

;sort-scrolls haversack

;sort-scrolls find "Fire Shards"

;sort-scrolls unleash etf