Skip to content

Getting Started

m4bwav edited this page Nov 16, 2026 · 15 revisions

Install

As a Claude Code plugin, add the repository as a marketplace or clone it and point your agent at skills/mapwright/SKILL.md. The script runs on its own too:

git clone https://github.com/m4bwav/mapwright
cd mapwright
git checkout v0.20.0
python scripts/mpw.py --version
0.20.0

v0.10.1 and v0.10.2 printed 0.10.0 here; since v0.10.3 the number matches the tag (Versions and upgrading).

Check the machine

python scripts/mpw.py doctor
mapwright 0.20.0
python        3.14.6 ok
sqlite        3.50.4
browser       C:\Program Files\Google\Chrome\Application\chrome.exe
numpy         2.5.2
shapely       2.1.2
pyproj        absent (optional)
gdal          absent (optional)
geographiclib absent (optional)
pillow        12.3.0
tesseract     absent (optional)
export        heightmaps, tiled, uvtt and mesh ready; print (PDF/PNG at a paper size) ready
aistyle       no server set (optional: pass --host or set MAPWRIGHT_COMFYUI)

Only Python is required. Without a browser, render to .svg; export says when print is skipped. Without tesseract the OCR bars print SKIP, and read marks text as not sure.

A first world

python scripts/mpw.py gen world --seed 7 --style nordic --out isles.map
wrote isles.map: 15876 cells, 48 rivers, 22 lakes, 81 settlements, 94 roads, 162 names in 1.22 s

The same seed gives byte-identical files on every run. isles.map is a folder; see Recipe format.

Zoom in and check

python scripts/mpw.py zoom isles.map --out isles-south.map
python scripts/mpw.py check isles-south.map

zoom picks the coast-richest quarter and keeps the parent's coast, rivers, settlements, roads and names. check prints 17 bars and exits 1 if any fails (Proof bars).

Render it

python scripts/mpw.py render isles.map -o isles.png --style ink-and-parchment
wrote isles.png: style ink-and-parchment, 83 labels (57 dropped), 10 legend entries, 0.63 s

Labels that find no free spot are dropped, never squeezed in.

Other kinds of map

python scripts/mpw.py gen dungeon --seed 3 --out crypt.map
python scripts/mpw.py export crypt.map -o crypt.dd2vtt
python scripts/mpw.py gen sector --seed 5 --out spin.map

Next: Generate places, Generate space, Export and Commands.

Clone this wiki locally