Quickstart¶

PentaTile is a Godot 4.6 addon centered on one node: PentaTileMapLayer.
You paint with Godot's normal set_cell() and erase_cell() APIs; the layer
generates autotiled visuals through its layout Resource.
Fast path¶
- Copy
addons/penta_tile/into a Godot 4.6 project. - Enable the plugin in Project > Project Settings > Plugins.
- Add a
PentaTileMapLayernode to a scene. - Pick a
PentaTileLayoutResource in thelayoutproperty. - Leave
tile_setempty to use the layout's bundled fallback art, or assign your ownTileSetthat matches the selected layout. - Paint with Godot's TileMap tools or call
set_cell()from code.
For the shipped example, open res://addons/penta_tile/demo/penta_tile_demo.tscn.
What to read next¶
- Installation for release-zip setup.
- Layouts overview to choose the atlas convention that matches your art.
- What is a Penta tileset? for the 5-archetype format.
- Authoring Custom Layouts if you need a new convention.
- LLM Docs for agent-friendly single-file docs.
Local checks¶
The test suite lives outside the addon package:
.\tests\run_tests.ps1 -NoPause
On Linux or CI:
bash tests/run_tests.sh