Getting started with Cauldron
Cauldron is invite-only for now. If you don't have access yet, request it on castle.xyz.
Create a deck
On the web: sign in at castle.xyz/create and click New Deck. Give the deck a name, choose a starting point, and click Create Deck.
In the Castle app: open the Create tab, tap New Deck, choose Cauldron, then pick a starting point. You can name the deck later: on the Create tab, tap the deck, then tap Share your deck.
If the app shows Update Castle instead of the editor, your version of the Castle app is too old to open the Cauldron editor. Update it from the App Store or Google Play.
The starting point is a kit. If you're not sure which one to pick, choose Scene Editor (Recommended). It works like classic Castle, with actors, blueprints, behaviors, drawing tools and physics.
It takes a moment for Castle to set up your deck's workspace, and then the editor opens.
The editor
The editor is made of panels you can arrange and group. Add one with the + button, which also lists your kit's editors, like Scene and Sprite, and your deck's files:
- Operator: chat with Castle's AI assistant. See Operator below.
- Play: runs your deck. Restart picks up changes made since the current run started, and Logs shows the deck's console output. When a deck has more than one scene, a menu picks which one to play. Cover makes the current frame the deck's cover image (see Choosing a deck's cover). Snap attaches a screenshot of the running deck to your next message to Operator (see Snap).
- Files: your deck's files. Open one to edit it. Files that a kit has an editor for, like scenes and sprites, open in that editor; a switch in the editor flips the file between the editor and its code.
- Code: a code editor.
- Parameters: the deck's tunable values, as number controls, toggles and color pickers. See Tunable values.
- Terminal: a command line in your deck's workspace, if you want one.
On desktop, Mod+B toggles Files, Mod+J toggles Play, Ctrl+` toggles the Terminal, Mod+P opens a file by name, and Mod+Shift+P opens the command palette.
Operator
Operator is how most creators build a Cauldron deck. Tell it what you want in plain words ("make the ball bounce higher", "add a start screen", "turn this into a two-player game"), and it plans the work and makes the changes.
Operator works in background tasks, sometimes several at once, so you can keep using the editor while it builds. The Tasks view shows what's in progress. Tasks can also playtest your deck on their own, tapping, pressing keys and taking screenshots to check their work; you can turn Playtest checks off in Operator's settings.
You can keep typing while Operator works, and it reads new messages once it finishes what it's doing. You can attach images too, like a sketch or a screenshot of a bug, and Snap in the Play panel attaches a screenshot of the running deck in one click. And you can edit any file yourself at any time: Operator works from whatever is there.
Operator reads your deck's guide, which comes from its kit, before it changes a deck, so asking it is also the quickest way to learn how a kit works: "How do I add a new behavior?" or "Explain what this scene file does."
Save and publish
The editor saves your work as a draft automatically. The status next to the deck's name tells you when a draft is saving or saved, and warns you if it couldn't save.
A draft isn't published. To put your deck on Castle, click Push to Castle (in the app, tap Save). Each push publishes the current version.
A new deck starts out Private, so only you can play it. To share it, open the deck's settings and change its visibility. In the editor on the web, click the deck's name on desktop; on a phone-sized screen, open the Castle menu and choose Deck settings. In the settings you can:
- change the title, and add a caption and #tags;
- set Visibility to Private (only you), Unlisted (anyone with the link) or Public (listed on Castle);
- see the deck's share link, once it has been pushed;
- reset the deck's Player data, once it has been pushed (see below).
The Castle app's editor doesn't open these settings. In the app, go to the Create tab, tap the deck, and tap Share your deck (Sharing settings once it's shared) to change its title, caption and visibility.
Each push also tries to take a new cover image for the deck, from a screenshot of it running. If the screenshot can't be taken, the deck keeps the cover it already had. A cover you choose yourself with Cover in the Play panel always shows instead of the automatic one.
Resetting player data
Player data → Reset… in the deck's settings on the web gives every player a fresh start. Choose what to reset:
- Saved data: everything the deck has stored with
Store,StorageandSharedStorage, both its shared data and every player's saves. - Leaderboards: every score on the deck's leaderboards.
Players see the reset right away. For 24 hours you can Undo reset to bring everything back, but anything players saved in between is lost when you do.
A multiplayer deck needs to be Unlisted or Public for other players to join it. While it's Private, everyone plays it alone.
Versions
Files → Version history keeps saved versions of your deck. Describe your changes and click Save to record a version, or Restore to go back to one. Restoring never overwrites unsaved work, and the versions after it stay in the list, so you can move forward again. Operator can also restore a version for you.
View source, remix and import
View deck source, in the Castle app's deck menu, opens a Cauldron deck's source in a read-only editor, unless its creator has hidden it.
Remix, in the Castle app's deck menu, opens the Cauldron editor on your own copy of a deck. It's available for your own decks and for decks whose creator allows remixing.
Files → Import adds another deck or a kit to yours as a read-only dependency. You can pick one of your own decks, a deck you've saved, a kit, or paste a deck's link. It's how a deck builds on a kit, and how you can share code or art between decks without copying it. The Updates tab shows imports that have a newer version.
To change a file that came from an import, open it and choose Fork. Your deck gets its own editable copy of that file, and Drop fork goes back to the imported one.
Next steps
- Learn how the card, assets, fonts and touch controls work.
- Browse the SDK reference to save data, add leaderboards, or sell passes.
- Make a multiplayer deck.
- Ask questions and share what you made in our Discord.
Next: Kits · Back to What is Cauldron?