Home - hpf3/dungeon-generator-release GitHub Wiki

introduction

Welcome to the Dungeon Generator wiki!

this project is a hobby project of mine that started from wanting to try and digitize the systems and rules for some of the deck/card based dungeons out there and eventually it morphed into being a more general room-based dungeon generator.

features:

use the built-in packs or create your own, asset packs are collections of images and points that define what a card looks like and where it can be connected to.
use any* size of image for cards, the only rules are that connections are on the sides, and that your hardware can handle it. asset packs can have a mixture of sizes for images.

*image sizes aren't limited by the program, but im not a miracle worker, you still have to be able to handle loading all of the images in a pack
transparency support: if you use an image format that supports transparency, you can have the generator ignore transparent areas when checking if it can place a card in a certain spot.
most importantly, the generator! create a random maze of cards, and save it as a webp, png, or jpg

beware that it can be easy to underestimate just how big the image you are saving is, use the size references and image-render toggle to help see how far you can reduce the size/resolution of the dungeon

getting started:

the program is distributed as a single file and has default settings set, for a basic first run just do the following: download, run, click start,wait for ui on the right to say done, click Save Image

further info can be found in the respective pages for each section of the program.

user files location:

this wiki will sometimes refer to either user:// or "the user folder", the program uses godots default folder location for this purpose, below you can find the paths for windows and linux:

since different operating systems use different filesystem structures, this allows for things to be cross-platform while worrying less about os specific file paths