Porytiles User Documentation
Welcome to the Porytiles user documentation! Porytiles is a command-line tool for creating and editing overworld tilesets for Pokémon Generation III decompilation projects.
Note
This documentation is for Porytiles 1.0.0. For documentation matching an older release,
checkout the corresponding git tag
and build locally with cd docsrc && uv run make html.
About This Documentation
This guidebook is organized according to the Diataxis framework, a systematic approach to technical documentation that distinguishes four types of content based on the reader’s needs:
Explanation (Background) — understanding-oriented content that clarifies concepts, context, and the “why” behind the system. Read these pages when you want to build a mental model of how tilesets and Porytiles work.
Tutorials (Getting Started) — learning-oriented, step-by-step walkthroughs that guide you through a complete task from start to finish. Follow these when you are new to Porytiles.
How-to Guides — task-oriented instructions for accomplishing specific goals. Consult these when you already understand the basics and need practical guidance for an unfamiliar workflow.
Reference — information-oriented, precise descriptions of configuration values, CLI commands, and data formats. Look things up here when you need exact details.
The Topics section is a pragmatic hybrid of explanation and reference for Porytiles subsystems (palette packing, tile sharing, animations, diagnostics) that are too complex for a pure reference listing but too detailed for a pure conceptual overview.
The Quick Start page deliberately sits outside the four Diataxis types. It exists so you can install Porytiles and do something real without first learning how the documentation is organized. Check it out if you want just enough to start tinkering, and follow its cross-references when you want more details.
Quick Start
Background
Getting Started
How-to Guides
Topics
Reference