Build first-time guidance without embedding popup state into every gameplay script
Ponzool Tutorial Flow is a Godot addon for event-driven tutorials. Your game decides when an enemy encounter, item pickup, unlock, or other event occurs, then calls:
TutorialFlow.trigger("first_enemy_encounter")
Ponzool looks up the matching Resource, displays its pages, pauses the game when configured, and restores the pause state when the sequence ends.
Included
- Resource-based tutorial pages, definitions, and Catalog
- Multiple text pages and optional Texture2D images
- High-priority-first queue with trigger-order stability and duplicate suppression
- Always, once-per-session, and persistent global display scopes
- ConfigFile history at
user://ponzool_tutorials.cfg - Versioned Dictionary export/import for connection to your save system
- Catalog validation and clear warnings
- Started, finished, skipped, and queue-empty signals
- Built-in popup with keyboard focus, Escape close, and custom Theme support
- Inspectable demo Resources for enemy, item, and simultaneous events
Typical setup
- Install
addons/ponzool_tutorial_flow/and enable the plugin. - Create pages and tutorials as Resources, then add them to a Catalog.
- Register the Catalog once with
TutorialFlow.set_catalog(catalog). - Call
trigger(id)from your existing gameplay events. - Optionally export GLOBAL history into each save slot.
Boundaries
Ponzool does not include enemy, item, inventory, dialogue, or save-slot systems. It does not detect gameplay events automatically. Spotlight targeting, input blocking, action-completion conditions, branching graphs, and full popup-scene replacement are not included.
Need guided, non-blocking onboarding?
Ponzool Tutorial Flow Pro adds compact objectives, markers on live UI and world targets, real-action completion requirements, save and resume, UI recovery, and diagnostics. It is a separate paid product and is not included in this MIT-licensed Free edition.
Compatibility
Verified with Godot 4.7 stable on Windows 64-bit using the Compatibility renderer. Other Godot 4.x releases, platforms, and renderers are currently unvalidated.
Changelog for version 0.1.0
No changelog provided for this version.