How to Use?

Parameters

There are some parameters:

Seed: the seed for random generator. The map generation is dependent on this value. -1 means random seed.
Rooms: See Rooms chapter.
Zone size: The size for a "zone" - a square, which contains rooms.
Map Size X and Y: Amount of "zones" (not rooms). Can be rectangular, unlike a zone.
- ⚠ X and Y are beginning from 0, not 1!
- ⚠ The amount of zones in Rooms variable MUST be equal or more than X Y (or (X + 1) (Y + 1), if you count zones from 1)
Grid size: The size of a room model (X and Z dimensions). For SCP-CB remake, you should use 20.48, the default value.
Large rooms: Usually, the room size should be equal to Grid size variable. But what about bigger rooms? Since v.6.1, the large rooms (max size - 2 * 3 cells for endrooms) are supported too, althrough limited to Zone_size / 6
Room amount: Amount of endrooms. Calculated as Zone_size * Room_amount. Maybe not accurate, if Better zone generation not enabled.
Enable door generation: Generates doors between rooms. Can use different doors, since v.5.1
Better zone generation: Enable endroom checking (there are situations, where the last room to generate is in a existing hallway). May have a little generation time cost. Available since v. 7.1

Rooms parameter is the specific Resource type, where contains the room of the zones:

All parameters in this resource (called MapGenZone) (except Door frames) are also Resources - MapGenRoom which also have some parameters:

Name,
Prefab (you need to put room scene there),
Icon 0, 90, 180, 270 degrees - see example resources to see the right align of the room. (available since 7.0)
Spawn chance - set the spawn chance of the room.
- ⚠ The spawn chance is ignored by Single and Large room types, also the large endroom always spawns if the Large room is enabled and Large rooms count in MapGenZone > 1.

In Godot editor, make sure, that the exits of rooms faces the axis, seen in this picture: