# DungeonGenerator

by [Simon Moser](https://smoser.eu)

With DungeonGenerator you can generate your DSA dungeon in less than a minute. Just select how your dungeon should look like and press generate, and you get a nice dungeon with text description and a graph for visualizing.

You can make the following settings:
- Number of rooms
- Type of dungeons (natural or artificial)
- Mode of generation (long straight dungeon, branched dungeon or completely random dungeon)

The dungeon includes the following features:
- short description of rooms and exits
- traps in rooms and exits
- enemies in rooms
- big variety of treasures in rooms
- magical and special phenomenons in rooms
- random encounters for using at  the dungeon masters will

### Tech

DungeonGenerator uses a number of open source projects to work properly:

* [JGraph 0.9.2](https://www.jgraph.com/) - Library for graph creation and visualization
* [iText 2.1.7](http://itextpdf.com/) - Library for creating pdf documents
* [Apache PDFBox 2.0.2](https://pdfbox.apache.org/) - Library for merging pdf documents

And of course DungeonGenerator itself is open source with a [public repository]( https://naclador.de/mosers/DungeonGenerator) on my private Gitea instance.

### Development

Want to contribute? Great! 
Maybe the [Javadoc](https://naclador.de/mosers/DungeonGenerator/src/branch/master/docs) is useful?

### Building

#### Using the build script (recommended)

```bash
# Build the JAR
./build.sh jar

# Clean build artifacts
./build.sh clean

# Build and run
./build.sh run

# Clean and rebuild
./build.sh all
```

#### Using Gradle

If you have Gradle installed:

```bash
# Build the JAR
gradle jar

# Run the application
gradle run
```

#### Requirements

- Java JDK 11 or higher
- All dependencies are included in the `lib/` folder

### Todos

 - Implement more random stuff
 - Fix bugs
 - Imagine more possibilities

License
----

The MIT License (MIT)

Copyright (c) 2025 Simon Moser IT

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.


**Free Software, Hell Yeah!**
