Skip to content

Sequence v1.1.0 - #2310

Open
KenanMillet wants to merge 5 commits into
Roll20:masterfrom
KenanMillet:Sequence-ScriptKit
Open

Sequence v1.1.0#2310
KenanMillet wants to merge 5 commits into
Roll20:masterfrom
KenanMillet:Sequence-ScriptKit

Conversation

@KenanMillet

Copy link
Copy Markdown
Contributor

Sequence v1.1.0: ScriptKit Integration

Summary

Converts Sequence to use ScriptKit for help, man, examples, whatsnew, usage hints, and handout generation. Removes ~600 lines of manual help/example infrastructure in favor of ScriptKit's framework.

Changes

ScriptKit Integration

  • help — Full command reference with grouped commands (Recording, Playback, Management, Reference), auto-injected ScriptKit commands
  • man — All topics searchable via ScriptKit's tiered search. Dynamic items functions expose the full attribute/function/constant/easing registries for search
  • examples — Migrated 8 built-in examples to ScriptKit's example system with custom exampleHandler for recording handout generation
  • whatsnew / changes — Changelog with dates for all versions (0.2.0 through 1.1.0)
  • gen-help / gen-dev-docs — Auto-generated handouts from registered help data
  • ScriptKit.usage() — Fuzzy-matching unknown command handler; command-specific usage hints for missing arguments

Removed

  • HELP_TEXT constant and --help handler (ScriptKit handles it)
  • buildHelpHandout() function (ScriptKit generates user handout)
  • generateDevHandout() function (ScriptKit generates dev handout from topics)
  • EXT_EXAMPLES registry and registerExample() public API (replaced by ScriptKit examples)
  • registerBuiltinExamples() function
  • example / examples / example! command handlers in handleInput
  • Manual help handout creation in checkInstall

Bug Fixes

  • Rotation expression parsingrotation attribute's parse function now handles expressions (e.g. =orig + t * 360) instead of only plain numbers
  • boss-phase-2 easings — Replaced invalid easing names (ease-out-back, ease-in-quad) with registered curves (expo, quad, ~quad)

Dev Documentation

  • extensionApi topic updated: documents ScriptKit.Sequence.registerExample() with code sample showing the recording + handout pattern
  • extensions topic (user-facing): directs to !sequence man and !sequence gen-dev-docs

Dependencies

  • ScriptKit (added to script.json dependencies)

Testing

  • !sequence help — shows full command list with auto-injected ScriptKit commands + Browse Topics button
  • !sequence man — lists all topics
  • !sequence man left — finds the left attribute via dynamic items search
  • !sequence man attr — shows all registered attributes
  • !sequence examples — shows 8 built-in examples with Generate/Regen/Open buttons
  • !sequence whatsnew — shows v1.1.0 changes
  • Generated and played all 8 examples successfully (spin, hover, pulse, orbit, shake, torch-flicker, rgb-cycle, boss-phase-2)
  • Unknown command (!sequence blarg) triggers ScriptKit.usage() fuzzy suggestions
  • Missing argument (!sequence play) shows command-specific usage

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant