Samples & Demos
Use these ready-made scenes after the beginner path or when you want to inspect one focused workflow. Samples is the shipped Unity folder and menu name. This handbook uses demo for a playable learning scene inside that folder.
The 12 guides cover all 14 entries in the shipped catalog. The three Inventory scenes share one guide because they teach the same interaction on square, hexagonal, and triangular boards.
Before you begin
All Samples require Unity UI (uGUI), Input System, Universal Render Pipeline (URP), and a Universal Renderer. These are Sample dependencies, not requirements for the Grid Toolkit core. See Compatibility and dependencies for supported package versions and setup details.
If Unity warns that the active render pipeline is different, choose Open Anyway only to inspect the scene without changing project settings. Configure and assign a Universal Renderer before judging the intended presentation.
Each scene includes an on-screen status panel, called the HUD, for controls, diagnostics, and checkpoints. When a guide says to read the HUD, use that panel rather than the Unity Console.
Choose a scene
Guided tutorials
Start here for one carefully staged idea at a time.
- Inspect a first board — connect authored setup, live state, and view.
- Preview placement rules — compare valid, blocked, occupied, and out-of-bounds placement.
- Move a structure — preview and commit a structure move.
- Add and remove runtime cells — change live cells without editing the authored asset.
- Save and restore a basic board — capture, mutate, and restore a small state.
Playable examples
Choose these when you want to see several systems working together.
- Move a pawn on a hex board — follow occupancy-aware neighbors through precise World 3D hits.
- Explore a tactical hex board — combine movement ranges, terrain data, occupancy, and action previews.
- Use Inventory across three topologies — compare drag, rotate, transfer, sort, and stack behavior.
- Build a module socket network — compare module installation with network activation.
- Inspect complete snapshot restoration — restore structures, conditions, metadata, and extension data together.
- Build on a 1,000-cell board — place, rotate, and demolish structures without rendering every logical cell.
Extension example
- Extend Grid Toolkit with a cubic topology shows a project-owned topology, orientation, authoring adapter, and renderer working together.
How to use these guides
Open scenes from Tools > Lost Lily > Grid Toolkit > Samples > Open so the catalog can check dependencies and render-pipeline readiness first. Each guide repeats the exact final menu path. Enter Play Mode, follow Try it, and compare the scene to the Checkpoint before experimenting.
Sample controllers and assets are teaching material, not supported extension contracts. Build
production features against public Grid Toolkit APIs such as
GridBoardState, not types under
LostLily.GridToolkit.Demos.*.
For experiments, duplicate only the scene and the assets you intend to change into a project-owned folder. Treat the Sample scripts as reference material rather than copying them into production code.