Lost Lily/Grid ToolkitDocs 1.0

Build grid-based games without rebuilding the foundations

Grid Toolkit is a flexible Unity toolkit for games and tools built around grids, boards, cells, and placed objects. It gives you a dependable starting point so you can spend more time designing the game and less time rebuilding coordinates, placement rules, state tracking, and visual updates.

Get started with Grid Toolkit

Make the grid serve your game

Use Grid Toolkit for tactical boards, building and placement systems, inventories, puzzles, generated maps, or other experiences where position and occupancy matter. Work with square, hex, or triangle grids and display them with World 2D, World 3D, uGUI, or a project-owned renderer.

The toolkit does not dictate what your game should be. It supplies the reusable grid foundation while your project owns its rules, art, interactions, and identity.

Begin in Unity

Create the first board visually so its assets, scene owner, view, and renderer are easy to inspect. The beginner path introduces the runtime model through one visible result before asking you to choose code-owned board or extension workflows.

The Get Started guide takes you from a blank Unity project to a visible board with its first placed structure. Projects that genuinely need code to own the board can move on to Create and own a board in code.

Grow without starting over

Start with the built-in workflows, then adapt them as the project becomes more ambitious. Grid Toolkit supports custom game rules, selections, persistence, visual renderers, editor tools, and project-specific extensions without requiring the core package to be rewritten.

Previewable actions also let gameplay check a move or placement before committing it, making it easier to explain failures to players and keep board changes consistent.

Explore the documentation

  • Get Started — create your first board and place your first structure.
  • Concepts — understand the ideas behind the toolkit when you need them.
  • How-to Guides — find focused instructions for a specific task.
  • Samples & Demos — learn from ready-made scenes and focused walkthroughs.
  • Extending Grid Toolkit — add project-owned behavior and integrations.
  • API Reference — look up individual public types and members.
  • Help and Policies — troubleshoot problems and review compatibility boundaries.

This handbook documents Grid Toolkit 1.0.0. See compatibility and dependencies when preparing a project for installation.

API stability

Grid Toolkit contains Stable, Preview, and Experimental APIs. The tier shown on each type in the API reference is authoritative for that type.