Run the sample

Getting Started is the sample included with Loom GUI. It supplies the C# bridge used by the bundled Solid starter and gives you a fast, customer-install proof before you add Loom to a real game.

It demonstrates:

• A generated, typed bridge
• Reactive C# state rendered by Solid
• A UI button that calls a C# action
• The project-root UI/ workspace created by Loom
• Vite hot reload in Play mode

Requirements

• A Unity 6000.3.0f1 or newer project using URP 17.3.0 or newer
• Node.js 22 or 24 LTS with npm 10 or 11
• Public npm-registry access during initial setup, or an equivalent mirror/cache
• A supported OS and graphics API from Supported platforms

Import and run it

1. Open Window > Package Management > Package Manager.
2. Select Loom GUI, open Samples, and import Getting Started.
3. Run Tools > Loom > Setup UI Project. Loom creates the project-root UI/ workspace, links its bundled UI packages, and installs the UI dependencies.
4. Open the URP scene you want to use and run Tools > Loom > Setup UI in Current Scene. Save the scene.
5. Enter Play mode. Loom starts the Vite server and renders the starter UI over the Game view.
6. While Play mode is running, run Tools > Loom > Doctor. Resolve any failed required check. The Firefox check is optional unless you want browser DevTools.
7. Click Ping the engine. The message changes from Hello from Unity. to a numbered response from HelloLoomBridge.Ping().

What to inspect

• The imported HelloLoomBridge.cs is the complete C# side of the sample.
• UI/src/App.tsx reads bridge.message and calls bridge.ping().
• UI/src/bridge.ts provides browser-only mock state and actions.
• UI/generated/bridge.d.ts is the generated TypeScript contract. Do not edit it by hand.

Edit UI/src/App.tsx or UI/src/styles.css while Play mode is running to see Vite hot reload. Then continue with Build your first screen.