Update Dungeon Rooms authored by MarcatoSound's avatar MarcatoSound
......@@ -6,20 +6,22 @@ Procedurally generated dungeons are built using rooms. They consist of a schemat
## 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.
- Right-click sets the spawn point
- Left-click sets the facing direction
_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.
_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!_
## Room Rules
**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._
**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.
**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:
......
......