Documentation
Documentation
Guides and reference material for the Cade Runtime.
Get Started
- Getting Started
Install Cade, write and validate your first table, and explore it in the interactive console.
- Table Design Basics
Build a scoring element and a mode from scratch to learn the shape of every table.
- Glossary
Short definitions of the core Cade terms, each linked to its full reference.
Tutorials & Demos
- Tutorials →
Guided, end-to-end walkthroughs that build one working thing from an empty file — with the reasoning behind each step.
- Demos →
Short recordings showing Cade features in action.
Building Tables
- Expressions →
The formulas inside .cade attributes that make points, conditions, and values depend on live game state.
- Concepts →
How Cade's runtime behaves — events and signals, modes and game flow, devices, scoring safety, and state sync.
- Reusing Config with Assemblies
Turn repeated blocks of devices, variables, and scoring into one parameterized assembly you instantiate per flipper, target, or lane.
- Audio & Sound
Attach sound effects to devices and scoring, set levels, and generate sound with synth patches.
- Routing & Selection
Attach sound to devices and scoring with owner-addressed route and selection blocks — candidate sources, weights, and how one is chosen per trigger.
- Recipes →
Short, copy-pasteable HCL for common pinball features — bumpers, multiball, combos, multipliers, and more.
Tools & Testing
- CLI Reference
Every cade command — run a table, open the console, validate, test, migrate, and diagnose — with their flags.
- Console →
The interactive TUI/REPL for debugging live games — evaluate expressions, fire events, inspect state, trace cascades.
- Operating & Deployment
Run Cade on a real cabinet — start it at boot, capture logs, monitor health, and apply updates.
- Web Dashboard & Observability
Monitor a running table over HTTP — a live health dashboard, health endpoints for uptime checks, and an event-flow debugger.
- Testing & Scenarios
Pin down how a table should behave with .cade.test files that run against the real scoring engine.
Showcade Editors
Hardware & Drivers
- Drivers →
Connect the same table to FAST Pinball hardware, Visual Pinball X, or the in-memory virtual driver.
- Migrating from Visual Pinball
Move a VPX/VBScript table to Cade — what to stop writing in script, and how it maps to declarative HCL.