SugarCube Game Engine Debugger
Advanced SugarCube debug panel with UI, configuration, and real-time variable inspection.
What This Script Does
- Adds an in-game debugger overlay for SugarCube HTML games.
- Lets you inspect passage metadata, branch conditions, macro usage, and links.
- Includes a variable editor with deep path support (arrays/objects) and pinned variables.
- Adds optional history navigation controls (with force override mode).
- Includes links explorer filters and macro details on demand.
Basic Usage
- Toggle debugger:
Ctrl + D
- Close debugger:
Esc
- Move draggable toggle button anywhere on screen.
Important Setup For Local HTML Files
Because this script uses:
@match file:///*.html@match file:///*.htm
You must enable your userscript extension permission to run on local files.
Tampermonkey / Violentmonkey / Similar
- Open your browser extension page.
- Find your userscript extension.
- Enable Allow access to file URLs (wording may vary by browser).
- Reload your local game HTML.
If you skip this, the script will not run on local SugarCube games.
Running On Online SugarCube Games
If you want this script to run on web-hosted SugarCube games, edit the userscript header @match lines.
Example:
// @match https://example.com/*
// @match https://your-sugarcube-site.net/*
Then save the script and reload that site.
Note: keep matches specific when possible for safety.
Notes
- Debug logging can be disabled from Settings (
Debug Logging (Console)).
- Some history behavior depends on game configuration; debugger includes force-history options.
- Use responsibly when testing games and story branches.
