GitLab

Procedurally generated dungeons are built using rooms. They consist of a schematic and a set of configurable options. This article will explore some details on setting up a room.

Basic Options

Weight
This is the likelihood of this room being selected during generation. The higher the weight, the more likely this room will generate.

This is relative to the other rooms in this dungeon, so if all rooms have a weight of 5, they'll be equally likely to spawn. But if one room has a weight of 1, it'll be far less likely to spawn than the others.

Spawn Point
This is where the players will spawn if this room is selected as the starting room of the dungeon. The dungeon will ONLY use rooms with a spawn point configure when choosing a starting room.

If you don't have any rooms with a spawn point, the dungeon will choose from any of the valid rooms and try to find a safe spawn point, but this is ill-advised as the player could be placed in an unsafe or trapped position.

Allowed Rooms
This is a whitelist that lets you control what rooms can generate attached to this one. It opens a UI that lets you add and remove rooms from a list. You can also configure how likely a room is to be generated next to this one.

Room Rules

Generation Limits
This controls how many times a room is allowed to appear in a dungeon. It supports ranged values so you can require a room appear at least a certain number of times, while also preventing it from appearing TOO many times. Here are some example values:

• 0-3 - There will be anywhere from 0 to 3 instances of this room in the dungeon.
• 1 - The room will ONLY generate once. Useful for loot and exit rooms!
• 2+ - The room must generate AT LEAST twice, and is allowed to generate more.

Generation Depth
This controls how far into the dungeon the room can generate. It supports ranged values, so you can fine-tune where in the dungeon certain rooms appear. Ranges work the same as the Generation Limits. Here are some examples:

• 0-15 - This room can only generate if it's one of the first 15 rooms in the dungeon.
• 10-20 - This room can only generate between the 10th and 20th room (inclusively).
• 12+ - This room isn't allowed to generate until at least the 12th room in the dungeon.

Configuration File

All rooms have their own configuration file in the rooms folder of your map. Everything found in this file can be modified in-game, but you may also edit them in the config file. Note that if you modify the config file, you need to reload the dungeon with /md reload [dungeon] or /md reload all!!