Learn PlayWeld with Lantern Workshop

Try projects, discussions, chat, and search with a small Godot game.

On this page

Lantern Workshop is a small Godot game for learning PlayWeld at your own pace. Use a new folder so you can follow the examples and try the features without touching your own game.

Download the example files

Download Lantern Workshop (ZIP). Installed-app users do not need a PlayWeld source checkout. Extract the ZIP into a new temporary folder; it contains docs/ and game/ folders plus license and source information. Keep this extracted copy separate from your own game.

After creating the practice project below, copy the extracted docs/ contents into the new project's docs/ folder and the extracted game/ contents into its game/ folder. Keep PlayWeld's generated identity manifest, AGENTS.md, and service-owned state; do not replace the project root wholesale.

If you already use a source checkout, docs/examples/lantern-workshop/ is an alternative source for these files. The archive and historical source reference are learning material, not proof of compatibility with every current feature.

Prepare your practice environment

Install or build PlayWeld and install Godot 4 separately. When using the source checkout, select separate profile and Theia configuration directories before launching. GAMECRAFTER_PROFILE_DIR selects service state; THEIA_CONFIG_DIR selects application preferences and layout. Changing a new shell's environment does not reconfigure an already running process.

Create and populate the project

  1. In Project Home, create a Godot project named Lantern Workshop.
  2. Choose a new parent folder, confirm the engine, and open the registered workspace.
  3. Use the extracted ZIP from above, or find docs/examples/lantern-workshop/ in your source checkout.
  4. Transfer the example's design files into your project's docs/ folder, then place its native Godot files in your project's game/ folder.
  5. Keep the identity manifest, AGENTS.md, and service-owned state created by PlayWeld.

Lantern Workshop registered in Project Home

Real Control Room screen using example data in an isolated service.

Open game/project.godot with Godot. The example uses arrow-key movement and R to reset. Its design defines three collectible lanterns and checks for collection and reset. Seeing those files in PlayWeld does not prove you ran the game; record engine execution separately.

Explore the workflow

Create a Discussion Board thread about a change to the collection rule. Record your proposal before adopting it as a binding decision. Configure your own eligible model provider, then ask Chat to explain the design or active source file. The repository's captured conversations use a scripted provider whose temporary address is not a usable account for your installation.

In Knowledge, select the project, run Reconcile, and wait for indexing to settle. Choose Lexical, source docs, and search for a distinctive term from DESIGN.md. Read the resulting path and citation against the source document.

Knowledge returning the example design document

This capture demonstrates lexical retrieval. It does not demonstrate a live embedding provider.

Continue with an inspectable change

Try a bounded documentation task first: describe a timing challenge in the design without claiming it has been implemented. Use supervised agent work to inspect questions, approvals, changed files, and integration. Validate gameplay changes in Godot before treating them as accepted.

More detail

Your first Godot project ยท Step 3 of 6

Did this guide help?

Report a missing or incorrect detail
Mention your PlayWeld or engine version if it matters. Leave out private project details.

100%

Use left and right arrow keys to browse. Press Escape to close.