loomgui.com ↗

Run the sample

The sample project is the fastest way to see the whole Loom loop working before you wire it into your own game.

It demonstrates:

  • Startup with LoomUI
  • Screen routing from C#
  • UI actions that call C#
  • C# state updates that rerender Solid components
  • C# events consumed by the UI
  • Mock mode for browser-only UI work
  • Player-build bundling

Requirements

  • Unity Hub with Unity 6 (6000.3 or newer)
  • Node.js 20+
  • A supported OS and graphics API from Supported platforms

Run it

  1. Open unity/sample in Unity Hub.
  2. Wait for Unity to import and compile.
  3. Run Loom -> Doctor and fix any red checks.
  4. Open Assets/Scenes/Main.unity.
  5. Press Play.

The sample UI should appear over the scene. Use the sample screens to exercise state, actions, and events.

What to inspect

  • Assets/Scripts/SampleBridge.cs shows the C# bridge surface.
  • UI/src/App.tsx routes between screens.
  • UI/src/screens/ contains the Solid screen components.
  • UI/generated/bridge.d.ts shows the generated TypeScript contract.

After you understand the sample, continue with Build your first screen.