This system is designed to generate a random map based off of a given tile set. Allowing for required, and rotating, rooms.

Unity 2020.3.16 or newer is recomended.

NOTE: This system assumes all doors are at the same height.

• Room Tile Setup
• Tile-Set Setup
• Basic Scene Setup
• Test Tile Set
• API

Every object in a room should be contained in a parent object.

Add the Tile Data to the highest object in the prefab hierarchy.

• Set Gizmo axis mode to the correct mode for your project.
• Add doors to the "Door Positions" list. (When in 3D the Z axis maps to the Y value of doors)
• Set door rotations so that the gizmos point away from the tile as seen below.
  

• Either populate the appropriate list with the colliders that you wish to use for overlap detection when generating the map, or if you wish to use all coliders on the object press the detect colliders button.
  

Right click in the project window and go to Create>RandomMapGenerator>RoomTileSet to create a blank tile set...

Open the window by double clicking on the asset.

• Add starting room(s) to the "Starting Tile(s)" category.
• Add exit rooms to the "Ending Tile(s)" category.
• Add locked door(s) to the "Door Capping Tile(s)" category.
• Finaly add all other rooms to the "Other Tiles" category.

• Set current mode to the collider type your map uses (They are not cross compatible)*
• Maximum Collision Overlap determines how much overlap is ignored when rooms are touching when generated.
• Minimum Tiles Per Map is the number of rooms generated before the ending tiles can be spawned.
• Maximum Tiles per Map is the maximum number of tiles the map will generate.

*Current Mode also determines how door positions are handled, as long as this setting matches the equivalent on all your tiles then it should work fine.

• Weight determines the likelihood that a room will be chosen when spawning a room, the higher the weight the more often the room will spawn.
• Required will force exactly the set number of that room to be spawned. If required is not set then the room can be used any number of times.

If every thing was done correctly when you press play you should see the generated map once it finishes loading. (By default the generator will generate during the start call, to change this you must use the API)

Included in the package is a 'SetTester' prefab. This prefab supplies the means to test your tile sets to make sure that they can generate valid maps.

It is recomended to use an otherwise empty scene to perform these tests for the sake of time.

The prefab can be found under MapGenerator/SetTester

Set 'Set To Test' to the tile set you wish to test. You can also set the amount of times it will attempt to make a map.

Once the component is ready press play and wait for the maps to finish.

Any map that faild will be left in the scene for you to see how they failed, if the fail rate is below 10% and the maps are failing when small then it should be safe to use as the generation script will handle restarting after a faild map automatically.(up to your set amount of attempts)

You must use the RTMG namespace for access to the api.

using RTMG;

GenerateMap without keeping result data for future use.

public bool GenerateMap(RoomTileMap tileSet, int maxTries = 100, bool enableDebug = false)

GenerateMap and keep data for future use.

public bool GenerateMap(RoomTileMap tileSet, out Map mapData, int maxTries = 100, bool enableDebug = false)

public IEnumerator<MapGenerator.Map> GenerateMapAsync(RoomTileMap tileSet, int maxTries = 100, bool enableDebug = false)

While this is a coroutine it can't be run like a normal coroutine as it needs to return custom data.

To use this coroutine you will need to setup a MonoBehaviour with the following implementation of the included CoroutineData class.

void Start() 
{    
    cd = new CoroutineData(this, mapGenerator.GenerateMapAsync(mapGenerator.tileSetData));
}

void Update() 
{

    if(cd!=null)
    {
        MapGenerator.Map theMap = ((MapGenerator.Map)cd.result);
        if(theMap.isDone)
        {
            Debug.Log("Done Loading Map");
        }
        else
        {
            Debug.Log(theMap.progress);
        }
    }    

}

• MapGenerator.Map: Stores the generation progress, and final PlacedRoomData and DoorLocations for a generated map.
• MapGenerator.PlacedRoomData: Stores a reference to the placed GameObject as well as it position and rotation, also stores connected rooms and doors.
• MapGenerator.DoorLocation: Stores the position and rotaion of a door aswell as the doors locked state, also stores connected rooms.