# Procedural Dungeon Plugin [![Plugin version number](https://camo.githubusercontent.com/c9b82f65dd07cfb80556211d7e50de02690e427f49da3609e1eb62fe62fb5723/68747470733a2f2f696d672e736869656c64732e696f2f6769746875622f762f72656c656173652f42656e5079746f6e2f50726f6365647572616c44756e67656f6e3f6c6162656c3d56657273696f6e)](https://github.com/BenPyton/ProceduralDungeon/releases/latest) [![Unreal Engine Supported Versions](https://camo.githubusercontent.com/2fb06feebbe11262a9852cef363523700f0c1b6d7f26e0e3a14aeb5f5d8d48ca/68747470733a2f2f696d672e736869656c64732e696f2f62616467652f556e7265616c5f456e67696e652d342e32375f2537435f352e315f2537435f352e325f2537435f352e335f2537435f352e345f2537435f352e352d3934353543453f6c6f676f3d756e7265616c656e67696e65)](https://github.com/BenPyton/ProceduralDungeon/releases) [![License](https://camo.githubusercontent.com/64d3430efc0d90864bd5775c5dd89e07ae47b9e48953c745ff31b6edf857ca7d/68747470733a2f2f696d672e736869656c64732e696f2f6769746875622f6c6963656e73652f42656e5079746f6e2f50726f6365647572616c44756e67656f6e3f6c6162656c3d4c6963656e736526636f6c6f723d626c7565)](https://github.com/BenPyton/ProceduralDungeon/raw/master/LICENSE) ![Download count](https://camo.githubusercontent.com/db64825506a3cfc6457b23d907be0ed055d59dd41ca1f226bc67ddb01f7b5dfe/68747470733a2f2f696d672e736869656c64732e696f2f6769746875622f646f776e6c6f6164732f42656e5079746f6e2f50726f6365647572616c44756e67656f6e2f746f74616c3f6c6162656c3d446f776e6c6f616473) [![Discord](https://camo.githubusercontent.com/beeb4f907746c3bf198143db9ec9a5358ba466061ab1caceb2a743d1a3b75d98/68747470733a2f2f696d672e736869656c64732e696f2f646973636f72642f313138323436313430343039323035353537343f6c6f676f3d646973636f7264266c6f676f436f6c6f723d7768697465266c6162656c3d446973636f726426636f6c6f723d253233353836354632)][1] ## Overview This is an Unreal Engine plugin to create procedural dungeons by arranging procedurally a set of room like "The Binding of Isaac" or "Rogue Legacy" but in 3D. This procedural dungeon plugin uses hand-created rooms that are Unreal levels.\ You define your own rules in blueprints or C++ to generate the dungeon via an actor placed in a master world. If you have any bug or crash, please open an issue in the Github repo.\ If you have suggestions, questions or need help to use the plugin you can join the [Discord server][1] dedicated to this plugin.\ If you want to contribute, feel free to create a pull request (*contributions to the wiki are also welcomed!*). ## Features - Hand created rooms, allowing full control by the level designers. - Generation rules defined in blueprint, allowing flexible and powerful procedural generation. - Doors can be put on any Z height, allowing dungeons to be in 3D (but can do flat dungeons as well). - Defining different door types, allowing more complex dungeons. - Rooms and doors can be locked/unlocked. - Optional occlusion culling, allowing only relevant rooms rendered (and thus better performances). - A new editor mode to ease the creation and edition of the rooms. - Custom data in rooms, allowing gameplay specific code in room instances. - Working well with navmeshes and multiplayers. ## Example Some hand-made rooms defined with bounds and doors:\ Animated GIF

Some very simple generation rules: - A special room (red) used to spawn the player. - Then 10 rooms chosen randomly in a list (blue, green, yellow, cyan). - Then a special room (purple) used as an end goal for the player. - Finally 10 other rooms chosen randomly. Possible results:\ Animated GIF

[Demo Video on Youtube](http://www.youtube.com/watch?v=DmyNEd0YtDE "Procedural Dungeon Demo")
You can find an example project [here](https://github.com/BenPyton/DungeonExample) too. ## How to use it Go to the [Getting Started](https://benpyton.github.io/ProceduralDungeon/guides/Installation) page to begin to work with the plugin. If you want more details about how it works internally, you can read the [wiki](https://BenPyton.github.io/ProceduralDungeon/guides/Home). You can also join the [Discord server][1] dedicated to this plugin if you want to ask question or get help from the community. ## Installation Install it like any other Unreal Engine plugin. If you have any trouble with installation, read the [Installation](https://benpyton.github.io/ProceduralDungeon/guides/Installation) page of the wiki. ## FAQ [comment]: # (Move the FAQ in a wiki page instead?)

Can I generate levels during runtime? What I mean is if I can generate a new dungeon while the player is in it.

> Yes, you can generate during runtime.\ > If you call the `Generate` function, then the previous rooms unload, and a new dungeon generate and load new rooms.\ > There is no map travel during the process, the player remains in the master map, only the dungeon's rooms are loaded/unloaded.

How large can I make the map?

> You are only limited by the performance of the machine your game runs on.\ > Mostly, the performance of the dungeon depends on the complexity of your rooms/meshes, and the hardware of your computer. The more details and diversity of actors there are, the more resources will be consumed on the computer.\ > To be able to generate a very large map, you will need to optimize the meshes/textures for the RAM and GPU, the collisions and number of dynamic actors (enemies, etc.) for CPU, etc.\ > The simple occlusion culling system I provide in the plugin is one (rudimentary) way to optimize the GPU side (less drawing). > It is far from perfect but a good start.\ > You will need to do the other optimizations yourself.

Can I save and load dungeons?

> There is no save/load system implemented in the plugin. You will need to do it yourself.\ > I made this plugin for a rogue-like game, so I didn't made a save/load system of the dungeon.\ > A starting point will be to save the dungeon seed, and any other dynamic actors of your game.\ > You would set an ID for each actors in the room's levels that need to be saved (using the dungeon's seed). Then when you load a game you can retrieve the actors from their IDs in the generated dungeon, and apply the saved data to them.

How many different rooms can I have?

> You can have the number of room you want, there is not really a limit in the plugin.

It is pretty much up to my creativity to design whatever I want, right? If I want rooms to have enemies or anything like that, I can just create it in the level, right?

> Yes, you can design everything you want in the room. It is the purpose of the plugin: providing a generic way to generate a dungeon, without any compromise on the DA nor the game design.\ > If you want to add dynamic actors (like enemies, chests, etc.) I would suggest you to create spawners that you place in your room's levels, and spawn those actors after the dungeon generation.\ > For game save, you should provide a unique id (seed) for each spawner based on the dungeon's seed, so the random spawning of enemies or chest loot will be deterministic from the dungeon's seed.\ > For multiplayer, you should do the spawning only on the server side. The spawn command will be sent to the clients and the actors spawned will then be replicated correctly.

How does the occlusion culling work for multiplayer?

> The occlusion culling is client side. It will show only the room where the local player is and any adjacent rooms.\ > You can read further details about the occlusion culling system of this plugin from the [wiki page](https://benpyton.github.io/ProceduralDungeon/guides/Occlusion-Culling).\ > You can also disable the occlusion culling from the [plugin's settings](https://benpyton.github.io/ProceduralDungeon/guides/Plugin-Settings) and do it yourself in another way.

Is there a seed?

> Yes, there is a seed for the dungeon generation.\ > I made a parameter in the `DungeonGenerator` actor to have different types of seed: > - You can have a fixed seed you can set in the actor which will be always used (useful for testing and debugging purpose, or to set manually the seed from the game). > - You can have an incrementing seed, using the fixed seed for the first generation, then adding a value to it at each generation (useful for demonstration purpose). > - You can have a random seed generated for each generation (for released game mostly, or to test quickly a lot of dungeon generations).

Can I have some sort of flow to the dungeon? Like have a secret room spawn only once and have boss rooms only spawn 4 rooms?

> Yes, you can define the flow you want for your dungeon. It is the purpose of the plugin.\ > There is the function [`ChooseNextRoomData`](https://benpyton.github.io/ProceduralDungeon/guides/Choose-Next-Room-Data) where you define what I call your "rules" of the dungeon.\ > You can, for example, check a minimum number of room before spawning a secret room, and then don't spawn it if you already have one in the dungeon.

Can I increase the difficulty of the dungeon? Lets say room level 1 is easy and room level 5 is hard, can I tell the dungeon to not go from level 1 to level 5?

> Of course, you can. To do that sort of thing, you should create a child blueprint of `RoomData` class to add new parameters like a `DifficultyLevel`, which you can set value for each rooms in your `RoomData` assets.\ > Then for example, in your [`ChooseNextRoomData`](https://benpyton.github.io/ProceduralDungeon/guides/Choose-Next-Room-Data) function you can choose a room depending on its difficulty level compared to the difficulty level of the previous room.

## License This plugin is under [MIT license](https://github.com/BenPyton/ProceduralDungeon/raw/master/LICENSE).\ This means you are free to use this plugin for personal/free/commercial projects, you are also allowed to modify the source code and/or redistribute it.\ The only condition is to add the copyright notice and a copy of the license with your project and/or any redistribution of the source code, modified or not. ## *Support Me* If you like my plugin, please consider tipping: [![Ko-fi](https://camo.githubusercontent.com/1bcc018c03c0615c7e26aa3e38c2c1f8b7dc857bccb49e05eb52d6f0f14e8130/68747470733a2f2f696d672e736869656c64732e696f2f62616467652f4b6f2d2d66692d6666356635663f7374796c653d666f722d7468652d6261646765)](https://ko-fi.com/M4M3NW2JV) [![liberapay](https://camo.githubusercontent.com/0897ccf07332bea930d493217788711f92044337f52d99f504cec263c63286db/68747470733a2f2f696d672e736869656c64732e696f2f62616467652f6c69626572617061792d6636633931353f7374796c653d666f722d7468652d6261646765)](https://liberapay.com/BenPyton/donate) [![PayPal](https://camo.githubusercontent.com/e8a8fca013a27169b27eb23f9bcf9f2df978427d0ce3722623c2a1ae3b0596a7/68747470733a2f2f696d672e736869656c64732e696f2f62616467652f50617950616c2d3134326338653f7374796c653d666f722d7468652d6261646765)](https://www.paypal.com/donate/?hosted_button_id=9VWP66JU5DZXN) [1]: https://discord.gg/YE2dPda2CC