Dungeon generator plugin for Unreal Engine 5

[![license](https://camo.githubusercontent.com/a4612adaf2b2616ba164de56c99f5255a37a71a3de3ee0cbb2ceaf6ad79b2d58/68747470733a2f2f696d672e736869656c64732e696f2f6769746875622f6c6963656e73652f7368756e3132362f44756e67656f6e47656e657261746f72)](https://github.com/shun126/DungeonGenerator/raw/main/LICENSE) [![Unreal Engine Supported Versions](https://camo.githubusercontent.com/f19992d088087c39fe5a3fcc2d6445d1915ff892e1215c889ca91eb942ae29c2/68747470733a2f2f696d672e736869656c64732e696f2f62616467652f556e7265616c5f456e67696e652d352e317e352e372d3934353543453f6c6f676f3d756e7265616c656e67696e65)](https://www.unrealengine.com/) [![release](https://camo.githubusercontent.com/4b41fbdfb058d1c9d4fed45cfd1d7118c0ad2f558915b0d6efc4a1cca8689947/68747470733a2f2f696d672e736869656c64732e696f2f6769746875622f762f72656c656173652f7368756e3132362f44756e67656f6e47656e657261746f72)](https://github.com/shun126/DungeonGenerator/releases) [![downloads](https://camo.githubusercontent.com/a6e210df119656c41be11abd748500912d01e27f83e6786565ec7f372abcbf4b/68747470733a2f2f696d672e736869656c64732e696f2f6769746875622f646f776e6c6f6164732f7368756e3132362f44756e67656f6e47656e657261746f722f746f74616c)](https://github.com/shun126/DungeonGenerator/releases) [![stars](https://camo.githubusercontent.com/ef0b48dc592e7f0cd9c18c55093a6ef42fac4f3ab84541d4ba909490c1db334e/68747470733a2f2f696d672e736869656c64732e696f2f6769746875622f73746172732f7368756e3132362f44756e67656f6e47656e657261746f723f7374796c653d736f6369616c)](https://github.com/shun126/DungeonGenerator/stargazers) [![youtube](https://camo.githubusercontent.com/15f1276bce7244497a00a9ceef8d7724a3e0f212c325795f56e95d1962754e05/68747470733a2f2f696d672e736869656c64732e696f2f796f75747562652f76696577732f3169676434706c733578383f7374796c653d736f6369616c)](https://youtu.be/1igd4pls5x8) Please visit our website for full feature list: [https://happy-game-dev.undo.jp/](https://happy-game-dev.undo.jp/plugins/DungeonGenerator/index.html) ![Screenshot](https://github.com/shun126/DungeonGenerator/raw/main/Document/Screenshot.gif) # 🚩 Table of Contents - [Endless Adventures, Instantly Generated](https://github.com/shun126/DungeonGenerator/raw/main/#-endless-adventures-instantly-generated) - [Features](https://github.com/shun126/DungeonGenerator/raw/main/#-features) - [Requirements](https://github.com/shun126/DungeonGenerator/raw/main/#-requirements) - [License](https://github.com/shun126/DungeonGenerator/raw/main/#-license) - [Demo](https://github.com/shun126/DungeonGenerator/raw/main/#-demo) - [See also](https://github.com/shun126/DungeonGenerator/raw/main/#-see-also) - [Author](https://github.com/shun126/DungeonGenerator/raw/main/#-authors) # 👾 Endless Adventures, Instantly Generated Bring your roguelike and hack-and-slash games to life with next-level dungeon generation. Whether you’re aiming for fast-paced, loot-filled battles or deep exploration with infinite replayability, this Unreal Engine plugin gives you the power to craft unique dungeons every time. With just a few parameters—such as grid scale, number of rooms, and your own generation rules—you can instantly produce fully playable layouts. The system works seamlessly both in-editor and at runtime, and is available in both C++ and Blueprint, giving you the flexibility to integrate it into any workflow. ## Visualization of dungeon generation status The dungeon generator was based on Vazgriz's algorithm. You can read more about [Vazgriz's algorithm here](https://vazgriz.com/119/procedurally-generated-dungeons/). To vazgriz, The foundational generation algorithm you shared was a major source of inspiration and became the starting point for my development of the DungeonGenerator plugin. Without your ideas, I don't think I would have arrived at its current form. I'm truly grateful for the knowledge you made available and the impact it had on my work. ![DungeonGeneratorStatus](https://github.com/shun126/DungeonGenerator/raw/main/Document/DungeonGenerator01.gif) # 🎨 Features * DungeonGenerator is a plug-in for UnrealEngine5. * Tiled Dungeon Generation both In-Editor & Runtime. * Users can easily generate dungeons by preparing meshes for floors, walls, ceilings, and stairs. * Supports dungeon replication * Generates actors for doors and keys by MissionGraph. * The following features are supported only in the [Fab](https://fab.com/s/f5587c55bad0) version * Sub-levels can be applied as dungeon rooms * A mini-map of the dungeon can be generated. * Interior decoration. [beta version] * Foliage decoration. [beta version] * Supported Development Platforms: Windows,Android,Linux * Supported Target Build Platforms: Windows,Android,Linux (should be possible to target all platforms) # 🔧 Requirements * [Unreal Engine 5.1 ~ Unreal Engine 5.7](https://www.unrealengine.com/) * [Visual Studio 2022](https://visualstudio.microsoft.com/) # 💾 How to install * Open Unreal Engine Editor and create a project using the First Person template or Third Person template. * Install the Dungeon Generator plugin via Epic Games Launcher, or copy it to the `Plugins` directory of your project. * Enable the plugin content. * Open `Plugins/Dungeon Generator/Contents/Maps/Demonstration`. ![](https://github.com/shun126/DungeonGenerator/raw/main/Document/ContentBrowser.gif) * Run the project. # 📜 License you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or any later version. This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied arranty of MERCHANTABILITY or FITNESS FOR A ARTICULAR PURPOSE. See the GNU General Public License for more details. Or, [Fab](https://fab.com/s/f5587c55bad0) is releasing it under Epic license. If you need a license other than the GPL, please consider it. Proceeds will be used to fund the development of our game. # 👀 See also * [Issues](https://github.com/shun126/UE5-DungeonGeneratorDemo/issues) * [Discussions](https://github.com/shun126/UE5-DungeonGeneratorDemo/discussions) * [Wiki](https://github.com/shun126/UE5-DungeonGeneratorDemo/wiki) * [DeepWiki](https://deepwiki.com/shun126/DungeonGenerator) * [Doxygen](https://happy-game-dev.undo.jp/_doxygen/dungeon_generator/index.html) The [Fab](https://fab.com/s/f5587c55bad0) version includes the following enhancements. * Sub-levels can be applied as dungeon rooms * A mini-map of the dungeon can be generated. * Interior decoration. [beta version] * Foriage decoration. [beta version] ## 🎮 Demo [DungeonGenerator Demo](https://github.com/shun126/UE5-DungeonGeneratorDemo) is a sample project for first-person exploration. This is an easy to use. Simply drop the DungeonGenerateActor into your level, set the grid scale and number of rooms and start generating out your structures. Please read the [Wiki](https://github.com/shun126/UE5-DungeonGeneratorDemo/wiki) for more information. Please visit our website for full feature list: [https://happy-game-dev.undo.jp/](https://happy-game-dev.undo.jp/plugins/DungeonGenerator/index.html) # 😀 Authors * Nonbiri ([X.com](https://x.com/happy_game_dev) / [YouTube](https://www.youtube.com/channel/UCkLXe57GpUyaOoj2ycREU1Q)) * Shun Moriya ([X.com](https://x.com/monjiro1972))