Use the v6.1.0 guides for current projects. The v5.0.12 section covers the legacy 5.x line for existing 5.x projects — 6.0 is a different architecture, not an in-place upgrade.
Start here
New to the addon? Read these four guides in order, then stop until your game needs more:
- Getting Started — install, wire one session, and place the first object. Includes the minimal scene tree, the resources to create, how to link them, and the settings to check first.
- Placement Workflow — preview, validate, commit, then manipulate or demolish.
- Choosing Terrain vs Objects — decide between 2D terrain cells and placeable scene objects.
- Surface & Brush Reference — support matrix and 2D brush semantics.
Minimal scene setup
A working 2D scene needs five pieces. Names are yours; types and links are what matter:
- Nodes: a
GridPlacementHost(registers the session, routes input), a level with thePlacementLevelContextscript, a player with thePlacementOwnerscript, aGridPositioner2Dfor grid targeting, and the shipped selection UI on aCanvasLayer. - Resources: one
PlacementSession(bundle, settings, actions, catalog) plus oneScenePlacementEntryper placeable object pointing at its scene. - Linking: call
host.configure(session)with the same session assigned to the positioner; point the level context at yourTileMapLayer(target_map) and a separateNode2D(objects_parent); point the owner at your player (owner_root). - Settings: install the default input actions, keep collision layers and masks consistent across targeting, validation, and objects, and size the indicator to your tiles.
Learn from the demos
Five reference demos ship with the plugin (top-down, isometric, platformer, hex, and 3D) and follow exactly this wiring. Open the top-down demo first and read Getting Started alongside it.
- Use the v6.1.0 guides and API for the current release.
- Use the v5.0.12 guides only for the legacy 5.x line — 6.0 is a different architecture, so moving over means reworking setup, not just updating.
- New projects should use the v6.1.0 API exclusively.