Overworld tileset compiler for use with the pokeruby, pokefirered, and pokeemerald Pokémon Generation III decompilation projects from pret. Also compatible with pokeemerald-expansion from rh-hideout. Builds Porymap-ready assets from RGBA (or indexed) input assets.
Quick Links
- Release binaries
- Install via Homebrew
- Doxygen API documentation
- Using Porytiles - Wiki
- Introductory YouTube Tutorial (made by a community member, not a rick roll this time I promise)
Pokémon Hearth by PurrfectDoodle. Tile art inserted via Porytiles. Used with permission.
Why Should I Use This Tool?
Porytiles makes importing from-scratch tilesets (or editing existing tilesets) easier than ever. Think of it this way: Poryscript, another popular community tool, takes a .script file and generates a corresponding .inc file. Comparably, Porytiles takes a source folder containing RGBA (or indexed) tile assets and generates a corresponding metatiles.bin, metatile_attributes.bin, indexed tiles.png, indexed anim folder, and a populated palettes folder – all as part of your build!
For more info, please see this wiki page which explains what Porytiles can do in more detail.
Getting Started
TODO: replace this stub with a Quick Start walkthrough, or link out to the user docs once that page is written.
For now, install instructions live in Release Cadence below.
Release Cadence
Porytiles publishes both versioned releases and a rolling snapshot.
Versioned releases follow semantic versioning (vX.Y.Z) and are tagged on the master branch. Each tag triggers a permanent GitHub release with platform-specific zip files and updates the porytiles Homebrew formula. The CHANGELOG lists what changed in each release.
Snapshot releases are published automatically on every push to develop. They land at the rolling snapshot GitHub release and update the porytiles-snapshot Homebrew formula. Snapshots are for users who want the latest changes; they are not considered stable and the tag is force-replaced on every push.
Install the latest versioned release via Homebrew:
Install the latest rolling snapshot via Homebrew:
Alternatively, download platform-specific zip files directly from the releases page.
Either install path provides two binaries: porytiles (the modern compiler) and porytiles-legacy (the preserved pre-1.0.0 compiler). Homebrew works on Linux, macOS, and WSL. On Linux and WSL, follow the Homebrew on Linux setup instructions.
Building From Source
See the developer documentation for build instructions.
Note For Aseprite Users
GitHub user PKGaspi has created a collection of useful scripts here. Of particular interest is this export_layers script, which allows you to save each sprite layer to a different file. This may be useful, since Porytiles requires each tile layer in a separate PNG file.
