# PentaTile

> Lightweight dual-grid autotiling addon for Godot 4.6

PentaTile is a lightweight dual-grid autotiling addon for Godot 4.6+.
Users paint with the native TileMapLayer set_cell / erase_cell API;
the addon dispatches those logic cells into visual cells through
_update_cells. A pluggable PentaTileLayout resource defines mask
topology and slot resolution, with native support for Penta,
DualGrid16, Wang2Edge, Wang2Corner, Minimal3x3, Blob47Godot, and
PixelLab top-down/side-scroller layouts.


## Getting Started

- [Quickstart](https://shilo.github.io/PentaTile/index.md): Quickstart and core concepts
- [Installation](https://shilo.github.io/PentaTile/installation/index.md): Install via GitHub Release zip into addons/

## Layouts

- [Overview](https://shilo.github.io/PentaTile/layouts/index.md): Layout overview and selection guide
- [Penta](https://shilo.github.io/PentaTile/layouts/penta/index.md): Penta — the project's native 5-archetype format
- [DualGrid 16](https://shilo.github.io/PentaTile/layouts/dual-grid-16/index.md): DualGrid16 — 16-tile corner-mask atlas
- [Wang 2-Edge](https://shilo.github.io/PentaTile/layouts/wang-2-edge/index.md): Wang2Edge — 16-tile edge-mask atlas
- [Wang 2-Corner](https://shilo.github.io/PentaTile/layouts/wang-2-corner/index.md): Wang2Corner — 16-tile corner-mask atlas
- [Minimal 3x3](https://shilo.github.io/PentaTile/layouts/minimal-3x3/index.md): Minimal3x3 — 9-tile single-grid edge-mask
- [Blob 47 Godot](https://shilo.github.io/PentaTile/layouts/blob-47-godot/index.md): Blob47Godot — BorisTheBrave 47-blob convention
- [PixelLab Top-Down](https://shilo.github.io/PentaTile/layouts/pixellab-top-down/index.md): PixelLab Top-Down — 8x8 corner-mask
- [PixelLab Side-Scroller](https://shilo.github.io/PentaTile/layouts/pixellab-side-scroller/index.md): PixelLab Side-Scroller — 8x8 corner-mask

## Reference

- [What is a Penta tileset?](https://shilo.github.io/PentaTile/penta-tileset/index.md): What is a Penta tileset? — codename definition
- [Authoring Custom Layouts](https://shilo.github.io/PentaTile/custom-layouts/index.md): Authoring a custom PentaTileLayout subclass
- [API Reference](https://shilo.github.io/PentaTile/api-reference/index.md): Full GDScript API extracted from GDScript documentation comments

## About

- [LLM Docs](https://shilo.github.io/PentaTile/llm-docs/index.md): How LLMs and agents should consume these docs