Modules and Dungeon Tools
A module is a piece of a dungeon that you create by hand. This can be anything, as long as it can connect to other modules somehow. It would most commonly be a room of some kind, with some openings that can lead to other modules.
The generator can use the same module more than once. It is recommended to create multiple modules of the same type to give the generator more options to choose from.
Creating a Module Type and Set
A Module Set is a collection of modules used by the generator to generate a dungeon. For example, you can make a Lava and Ice set, or an Earth and Moon set.
A Module Type is more of a category, for example, Spawn Room, Corridor, or Dead End. Module Types are used when defining the layout of a dungeon (Spawn Room → Corridor → Large Room). Note that both the Lava and Ice sets could have large rooms, corridors, or dead ends.
- Right-click in the Content Browser → Dungeon Generator → Create a Dungeon Module Set and a Dungeon Module Type.
- Give them a name of your choice. You might even want to create multiple Module Types.
- Open each asset and choose a fitting Display Name and Folder Name.
- The Dungeon Tools use the folder names when creating new modules.
Module Sets and Module Types can be created like this.
Creating a Module
The Dungeon Tools handle most of the module creation process (aside from the actual level design). I recommend using them as much as possible. Open them by navigating to Tools → Dungeon Tools.
Use the Dungeon Tools to set up or edit modules.
Your Module Set and Module Type should already show up in the tool's dropdowns. If you create a new set or type while the tool is open, refresh it by clicking the button in the top right corner.
Module Sets and Types automatically show up in the dropdowns.
- Select the Module Set and Module Type of the module that you want to create → Click Create new module.
- This creates and opens a new level with one Connector Marker.
- The tool uses the set's and type's folder names to save this new level at the proper location.
- For example, the set
Lavaand typeDead Endcould useRootFolder/Lava/DeadEnds. - You can change the Module Root Folder in Project Settings → Plugins → Dungeon Generator Evolved.
- Design your module, just like you would design a normal Unreal level.
- Make sure to plan for some ways where this module can connect to other modules.
- Select
ConnectorMarker1in the Outliner → Assign its Connector Type.- Place one Connector Marker in each opening that should lead to another module.
- Check out the Connectors for more information.
Creating Module Bounds
- Select the static meshes that make up your module → Click Create module bounds in the Dungeon Tools.
- This creates a hitbox that tells the generator how much space your module takes up.
- The bounds are convex. If you made an L-shaped room, you can select the two parts separately and create a bounds piece for each.
- Make sure no bounds piece extends past the start of any of the Connector Marker arrows.
- Otherwise, the generator will not be able to use this connection.
It is fine to use convex bounds for a concave module, as long as no Connector Marker starts inside the module bounds.
If you use highly detailed geometry, the generated bounds might be overly complex. You can go to Project Settings → Plugins → Dungeon Generator Evolved and enable Limit Bounds Triangles to prevent this. Alternatively, you can also just approximate your module with cubes, and select those when generating the module bounds.
This is just to demonstrate how Limit Bounds Triangles works. I do not recommend using Manny to generate your module bounds.
Saving and Editing a Module
- Make sure you have the correct Module Type and Module Set selected in the Dungeon Tools' dropdowns.
- Save the level → Click Save module data.
- This creates or updates the Module Definition and adds it to the Module Set.
- The Module Definition stores the level, Connector Markers, and bounds so the generator can place the module before loading it.
- The generator can now use this module when generating a dungeon of the selected Module Set.
- If you move a Connector Marker or make any changes to the module bounds, save the level → Click Update module data.
- If the tool removed any duplicate Connector Markers, save the level again to keep those changes.
To add variety, create multiple modules using the same Module Set and Module Type. For example, you could create a straight corridor and an L-shaped corridor. The generator can then use either one wherever your Dungeon Graph asks for a Corridor.