README.md

MapGen

2d Map generator for tile based games built in Unity3d.

How it works

Creates 2d objects in a constricted space then uses Unity's physics engine to seperate. Once seperated, the larger 'hub' rooms are found and connected to one another. The connections are culled down to a minimum spanning tree, then a few of the culled connections are added back.

Next, create right angle hallways between connected hub rooms. The remaining rooms are checked for collision along the hallway paths. If collision is found then those rooms are added as 'hallway' rooms. Check the hallway lines for empty space along their path. If a space is found to be empty, note the point. Create 'filler' rooms from the noted empty spaces along the hallway line paths.

Legend:
  Hub rooms:      Green
  Hallway rooms:  Yellow
  Filler rooms:   Blue
  Filler points:  Red
  Hallways:       Grey

Prerequisites

Unity 3d (MapGen was created with version 2017.1.0f3)

https://unity3d.com/

Zenject

https://github.com/modesttree/Zenject
or
https://www.assetstore.unity3d.com/en/#!/content/17758

Point Triangulation

https://github.com/adamgit/Unity-delaunay
This is outdated but works fine in this instance. Replace as required.

Installing

Install Zenject and Unity-Delaunay from prerequisites section.

Import MapGen into Unity3D project window.

Drag MapGen/mapGen (folder) into Unity project window under Scripts

Create new SceneContext object in scene

Right click on Hierarchy > Zenject > Scene Context
Add GameInstaller to SceneContext
Drag added GameInstaller to "Installers" collection on Scene Context

Create Physical helper room prefab

Create empty game object in scene.

Add Rigidbody 2D
  Freeze Rotation Z
  
Add Box Collider 2D
Add MapRoomHolder (script)

Drag newly created object to Prefab folder in Project window.
Delete from scene.

Create MapGen

Create empty game object in scene.

Add MapGen(Script)
  Drag Physical helper room prefab (Created above) onto "Physical Room" property.
  Drag a MapSettings SO (Located @ MapGen>Scriptable Objects>MapSettings) onto "Map Settings" property.

Add MapGenVisualDebugger(Script)

Add ZenjectBinding(script)
  Drag MapGen(script) on same game object to Components.

Built With

• ZenJect - Dependency injection for Unity3D
• Unity-delaunay - Point Triangulation