A procedural dungeon map generator for tabletop RPGs
Project description
Dungeongen
A procedural dungeon generation and rendering system for tabletop RPG maps.
Quick Start
pip install dungeongen
python -m dungeongen.webview.app
Then open http://localhost:5050 in your browser to generate dungeons interactively.
Features
Layout Generation
- Procedural room placement with configurable room sizes and shapes (rectangular, circular)
- Intelligent passage routing that connects rooms with hallways
- Symmetry modes: None, Bilateral (mirror)
- Configurable density: Sparse, Normal, Tight packing
- Automatic door placement with open/closed states
- Stairs and dungeon exits
Rendering
- Hand-drawn aesthetic with crosshatch shading and organic lines
- Water features with procedural shorelines and ripple effects
- Room decorations: columns, altars, fountains, dais platforms, rocks
- High-quality SVG and PNG output
- Grid overlay for tabletop play
Water System
Procedural water generation using noise-based field generation:
- Depth levels: Dry, Puddles, Pools, Lakes, Flooded
- Organic shorelines using marching squares with Chaikin smoothing
- Ripple effects that follow contour curves
Project Structure
dungeongen/
├── src/dungeongen/ # Main package
│ ├── layout/ # Dungeon layout generation
│ │ ├── generator.py # Main procedural generator
│ │ ├── models.py # Room, Passage, Door data models
│ │ ├── params.py # Generation parameters
│ │ └── validator.py # Layout validation
│ │
│ ├── map/ # Map rendering system
│ │ ├── map.py # Main renderer
│ │ ├── room.py # Room rendering
│ │ ├── passage.py # Passage rendering
│ │ ├── water_layer.py # Water generation
│ │ └── _props/ # Decorations (columns, altars, etc.)
│ │
│ ├── drawing/ # Drawing utilities
│ │ ├── crosshatch.py # Crosshatch shading
│ │ └── water.py # Water rendering
│ │
│ ├── algorithms/ # Generic algorithms
│ │ ├── marching_squares.py # Contour extraction
│ │ ├── chaikin.py # Curve smoothing
│ │ └── poisson.py # Poisson disk sampling
│ │
│ ├── graphics/ # Graphics utilities
│ │ ├── noise.py # Perlin noise, FBM
│ │ └── shapes.py # Shape primitives
│ │
│ └── webview/ # Interactive web preview
│ ├── app.py # Flask application
│ └── templates/ # HTML templates
│
├── tests/ # Test suite
├── docs/ # Documentation
└── pyproject.toml # Package configuration
Installation
From PyPI
pip install dungeongen
From Source (for development)
git clone https://github.com/benjcooley/dungeongen.git
cd dungeongen
pip install -e .
Dependencies
- Python 3.10+
- skia-python (rendering)
- numpy (noise generation)
- Flask (web preview)
- rich (logging)
Usage
Web Preview
python -m dungeongen.webview.app
Then open http://localhost:5050 in your browser.
Python API
from dungeongen.layout import DungeonGenerator, GenerationParams, DungeonSize, SymmetryType
from dungeongen.webview.adapter import convert_dungeon
from dungeongen.map.water_layer import WaterDepth
# Configure generation
params = GenerationParams()
params.size = DungeonSize.MEDIUM
params.symmetry = SymmetryType.BILATERAL
# Generate layout
generator = DungeonGenerator(params)
dungeon = generator.generate(seed=42)
# Convert to renderable map with water
dungeon_map = convert_dungeon(dungeon, water_depth=WaterDepth.POOLS)
# Render to PNG or SVG
dungeon_map.render_to_png('my_dungeon.png')
dungeon_map.render_to_svg('my_dungeon.svg')
Configuration Options
Dungeon Size
TINY- 4-6 roomsSMALL- 6-10 roomsMEDIUM- 10-20 roomsLARGE- 20-35 roomsXLARGE- 35-50 rooms
Symmetry Types
NONE- Asymmetric layoutBILATERAL- Mirror symmetry (left/right)RADIAL_2- 180° rotational symmetry (future)RADIAL_4- 90° rotational symmetry (future)
Water Depth
DRY- No waterPUDDLES- ~45% coveragePOOLS- ~65% coverageLAKES- ~82% coverageFLOODED- ~90% coverage
Acknowledgments
This project was inspired by watabou's One Page Dungeon, a fantastic procedural dungeon generator. The hand-drawn crosshatch aesthetic and overall visual style draw heavily from watabou's work.
- One Page Dungeon Generator: https://watabou.itch.io/one-page-dungeon
- watabou's other generators: https://watabou.itch.io/
Differences from One Page Dungeon
This is a complete rewrite in Python, not a port. Options do not work identically as this is a completely different codebase. Key differences:
Not yet implemented:
- Only bilateral (mirror) symmetry is supported; linear, radial, and other layout modes are planned
- Some props are missing (casket, star, podium, curtains, barrels)
- Various bugs and edge cases - not everything works perfectly
Will not be added:
- Auto-rotate transform for diagonal map views - this library outputs maps for further processing
- Auto-generated text, titles, and descriptions - this is a map generator, not a complete document generator. That being said you're welcome to add your own dungeon bits. That being said you're welcome to add your own dungeon bits
License
MIT License - See LICENSE file for details.
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file dungeongen-0.1.9.tar.gz.
File metadata
- Download URL: dungeongen-0.1.9.tar.gz
- Upload date:
- Size: 468.9 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/6.2.0 CPython/3.9.6
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
b4b8fb83e64f72d3f0a5422f7b6c9adbd748e86a3cfc4fe43895b73280ed93a8
|
|
| MD5 |
a8ff579b16ddd206584fee4117f12e77
|
|
| BLAKE2b-256 |
d3fff386c9c39f133bb9cb1b3b79b2b506b9e211c5cd4ef6d41600ae20aaa8c3
|
File details
Details for the file dungeongen-0.1.9-py3-none-any.whl.
File metadata
- Download URL: dungeongen-0.1.9-py3-none-any.whl
- Upload date:
- Size: 501.1 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/6.2.0 CPython/3.9.6
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
f5c40512d96fb32074583be132e2a77b7b815f6c882585b5d312f5ade773b69a
|
|
| MD5 |
0a8ba8cf2d7aeee486f682382c880bea
|
|
| BLAKE2b-256 |
ff78c39077c6b945dec24b158829f6670e6bfa30edceb618e62e5ecc0de1ba7c
|