Unity Dungeon Crawler 3d Kit (Gridder)

How to Use DungeonStarter

This guide will walk you through the process of creating a new dungeon level from scratch, setting up the player, and applying materials.

Step 1: Create the Core Assets

Before building a level, you need to create the ScriptableObject that will hold the reference to your active level.

1. Create the Level Variable: In the Project window, right-click and navigate to Create > DungeonStarter > Variables > Current Level.
2. Name this new asset something memorable, like Var_CurrentLevel. This asset will act as a global pointer to whatever level is currently being played.

Step 2: Design Your Dungeon Layout

1. Open the Level Editor: In the Unity menu bar, go to DungeonStarter > Level Editor.
2. Create New Level Data: The editor window will be empty. Click the "Create New Level Data" button.
3. Save the Asset: A save dialog will appear. Name your new level (e.g., Level_01_Crypt) and save it. The editor will now display a 50x50 grid of solid white (walls).
4. Paint Your Dungeon:
   • Ensure you are in "Paint Walls" mode (the default).
   • Left-click and drag to carve out your hallways and rooms. These will appear as black squares.
   • Right-click and drag to fill areas back in with walls.
5. Set the Player Start:
   • Switch to "Set Start" mode using the toolbar at the top of the editor.
   • Choose a Start Direction from the dropdown menu.
   • Click on any open (black) tile in your grid. A green arrow will appear, marking the player's spawn point and orientation.
6. Your LevelData asset is now saved and ready to be used.

Step 3: Build the Level in the Scene

1. Create a Level Manager: In your scene, create an empty GameObject and name it "LevelManager".
2. Add the Level Component: Add the DungeonStarter/Level component to your LevelManager object.
3. Assign Assets:
   • Drag your LevelData asset (e.g., Level_01_Crypt) into the Level Data slot.
   • Drag your Var_CurrentLevel asset into the Current Level Variable slot.
   • Create and assign your Wall, Floor, and Ceiling prefabs. These can be simple cubes for now.
4. Generate the Geometry: Right-click the Level component in the Inspector and choose "Generate Level". The 3D representation of your dungeon will appear in the scene, neatly organized.
   • Alternatively, with the LevelManager selected, use the DungeonStarter > Generate Selected Level menu item.

Step 4: Set Up the Player

1. Create the Player Object: Create a new empty GameObject named "Player". Add a Camera to it so you can see.
2. Add the Player Component: Add the DungeonStarter/Player component to your Player object.
3. Assign the Level Variable: Drag your Var_CurrentLevel asset into the Current Level Variable slot on the Player component.
4. Press Play! The player will automatically find the start position from the LevelData and you can move around using the WASD/QE keys.

Step 5: Apply Shaders and Materials

1. Create Materials: Create new materials for your walls, floors, and ceilings (e.g., M_BrickWall, M_StoneFloor).
2. Assign Shaders: Select a material, and in the Inspector's shader dropdown, choose one of the DungeonStarter shaders (e.g., DungeonStarter/Brick Pattern).
3. Configure Materials: Adjust the colors, tiling, and other properties on each material to achieve your desired look.
4. Apply to Prefabs: Apply these configured materials to your Wall, Floor, and Ceiling prefabs.
5. Re-Generate: If you generate your level again, it will now be built using your styled prefabs.