vedaloivdocs
Asset Store page for Easy Dungeon Generator (opens in a new tab)

Quick Start

Easy Dungeon Generator Quick Start

Documentation for v1.1.0Unity 6000.5.0+namespace DungeonGen

This is the shortest path to a generated dungeon: one theme, one painted room, one template, and one DungeonManager in your scene. Each step links to the guide that explains it in full.

On this page
  1. Before you start
  2. Build a dungeon
  3. Next steps

Before you start#

  • Import the package and keep its folder at Assets/DungeonGenerator/.
  • Install AI Navigation 2.0.13, Burst 1.8.30, Collections 6.5.0, and Mathematics 1.4.0 from the Package Manager. Alchemy is bundled.
  • Create a content folder such as Assets/MyDungeonContent/. Save all your assets there, never inside the package folder.

Build a dungeon#

  1. Create a theme. Choose Assets › Create › DungeonGen › DungeonTheme in your content folder, assign your floor, wall, and door prefabs, and check the tile size with the Tools › DungeonGen › Dungeon Theme Wizard.

    See Themes.

  2. Paint two rooms. Open Tools › DungeonGen › Room Designer, paint floor cells with the Floor brush, and add doors on the walls. Set the Room Type to Entrance for the first room and to Exit for the second. Assign the theme to each, and click Save Prefab to save both in your content folder.

    See Room Designer.

  3. Build a template. Open Tools › DungeonGen › Dungeon Template Designer. The root node is the Entrance. Add an Exit node, connect it to the Entrance, and click Validate until the result is clean.

    See Templates and generation.

  4. Create the manager. Open Tools › DungeonGen › Dungeon Setup and click Create Template Dungeon. This adds a DungeonManager to the scene.

  5. Assign the template and the rooms. In the DungeonManager Inspector, assign the template. Drag your saved room prefabs onto the Room Pool drop zone. Each dropped prefab gets weight 1 and all placement contexts.

  6. Click Generate Dungeon. Use Clear Generated to remove the result. Generate the dungeon again after each change.

Next steps#

Room DesignerBrushes, room doors, stairs, socket types, and saving prefabs. Templates and generationExact or seeded random layouts, progression requirements, and wall mode. Decoration and themesTheme Wizard, decoration profiles, and runtime decoration. Chunk streamingAn endless world that streams around the player. Culling and NavMeshPortal culling, runtime NavMesh, and the Burst planner option. Demo scenesRun the four demos to see each feature working.

Problems during setup? See Troubleshooting.