Installation

pip install tilemap-parser

Current release is v5.2.0. The package needs Python >= 3.10 and pulls in pygame-ce >= 2.5 automatically, the only dependency.

THE EDITOR COMPANION

Maps and collision files are authored in tilemap-editor; the parser reads its JSON directly.

pip install tilemap-editor

You don't need the editor to use the parser. You can hand-write a map.json and a .collision.json, but the editor is how the JSON formats stay consistent. See JSON Formats.

VERIFY IT WORKS

python -c "import pygame; from tilemap_parser import load_map, PhysicsWorld, CollisionRunner; print('ok')"

USE A VIRTUAL ENV

Game dev dependency roulette is real. Keep it isolated:

python -m venv .venv
source .venv/bin/activate      # Windows: .venv\Scripts\activate
pip install tilemap-parser

RUN THE EXAMPLES

The examples live in the repository and import the source directly. Clone, install editable, run:

git clone https://github.com/FluffyBrudy/tilemap-parser
cd tilemap-parser
pip install -e .
cd examples/physics-crate
python main.py          # push some crates