https://github.com/h4kor/dungeon-planner

Dungeon Planning tool for (tabletop) games
https://github.com/h4kor/dungeon-planner

dungeons-and-dragons rpg tabletop tabletop-rpgs

Last synced: 2 months ago
JSON representation

Dungeon Planning tool for (tabletop) games

• Host: GitHub
• URL: https://github.com/h4kor/dungeon-planner
• Owner: H4kor
• License: agpl-3.0
• Created: 2023-11-02T08:15:34.000Z (about 1 year ago)
• Default Branch: main
• Last Pushed: 2024-10-17T19:45:30.000Z (3 months ago)
• Last Synced: 2024-10-20T05:55:20.965Z (3 months ago)
• Topics: dungeons-and-dragons, rpg, tabletop, tabletop-rpgs
• Language: Rust
• Homepage: https://h4kor.github.io/dungeon-planner/
• Size: 466 KB
• Stars: 3
• Watchers: 3
• Forks: 0
• Open Issues: 3
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
[![Run Tests](https://github.com/H4kor/dungeon-planner/actions/workflows/test.yml/badge.svg)](https://github.com/H4kor/dungeon-planner/actions/workflows/test.yml)

# Dungeon Planner

Dungeon Planner is a small and simple tool to plan and organize dungeons for tabletop games.

Dungeons are composed out of chambers and doors, for which notes can be added.

The application is game system agnostic and can be used for any system.

Dungeons can be exported as PDF.

The [User Documentation](https://h4kor.github.io/dungeon-planner/quickstart/) can be found on the [project website](https://h4kor.github.io/dungeon-planner/).



  



## Tools

- **Add Chamber**: Creates a new chamber to the dungeon. The chamber will appear in the Chamber list.

- **Selection**: Select chambers or doors by clicking on them in the canvas. Some tools only work with an active chamber or door.

- **Cut Tool**: Used to split a chamber wall in half, adding a new corner to the chamber.

- **Draw Tool**: Used to draw a chamber. This tool will always continue from the last corner of the chamber.

- **Add Door**: Allows adding a door to the selected chamber. Door are always placed on walls.

- **Chamber List**: Lists all chambers. Allows selection of chambers.

- **Chamber Details**: Change the name and notes of a chamber

- **Door List**: Lists all doors. Allows selection of doors.

- **Door Details**: Change name and notes of a door. You can also define to which chamber a door leads.

## Roadmap / Feature List to Version 0.1.0

- [x] Grid

- [x] Drawing chambers using straight edges

- [x] Grid Snapping

- [x] Assign doors/properties to edges

    - [x] hidden doors and chambers

- [x] GM Notes on chambers

- [x] Prints

    - [x] Full map with numbers assigned to chambers

        - [x] GM Notes

    - [x] Chambers seperated to cut out 

    - [x] Player Map

- [x] Placing object markers (stairs, chests)

## Developmnet

### Setup

[Install GTK dependencies](https://gtk-rs.org/gtk4-rs/stable/latest/book/installation.html). This project requires at least GTK 4.6 (standard for Ubuntu 22.04).

### Tests

```

cargo test

```

### Run Development Version

```

cargo run

```

### Build Release Version

```

cargo build --release

```