https://github.com/unitytechnologies/proceduralpatterns2d
https://github.com/unitytechnologies/proceduralpatterns2d
Last synced: 11 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/unitytechnologies/proceduralpatterns2d
- Owner: UnityTechnologies
- License: other
- Created: 2018-04-18T15:18:26.000Z (almost 8 years ago)
- Default Branch: master
- Last Pushed: 2018-06-12T09:54:21.000Z (over 7 years ago)
- Last Synced: 2025-03-25T05:42:01.028Z (11 months ago)
- Language: C#
- Size: 648 KB
- Stars: 112
- Watchers: 11
- Forks: 19
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: License.txt
Awesome Lists containing this project
README
# Procedural Patterns to use with Tilemaps
## Description
This project shows a number of different patterns to use with Tilemaps to create custom maps.
All the main functions are within the script [MapFunctions.cs](https://github.com/UnityTechnologies/ProceduralPatterns2D/blob/master/Assets/Global%20Scripts/MapFunctions.cs).
### How to get started:
Within this project there are scenes showing examples of the following algorithms:
1. [Perlin Noise](https://github.com/UnityTechnologies/ProceduralPatterns2D/tree/master/Assets/Generation%20Examples/Perlin%20Noise)
1. Basic Generation (for top layer)
2. Smoothed Generation (for top layer)
3. Cave Generation
2. [Random Walk](https://github.com/UnityTechnologies/ProceduralPatterns2D/tree/master/Assets/Generation%20Examples/Random%20Walk)
1. Basic Generation (for top layer)
2. Smoothed Generation (for top layer)
3. Cave Generation (4 directional movement)
4. Custom Cave Generation (8 directional movement)
3. [Cellular Automata](https://github.com/UnityTechnologies/ProceduralPatterns2D/tree/master/Assets/Generation%20Examples/Cellular%20Automata)
1. von Neumann Neighbourhood
2. Moore Neighbourhood
4. [Directional Dungeon](https://github.com/UnityTechnologies/ProceduralPatterns2D/tree/master/Assets/Generation%20Examples/Directional%20Tunnel)
There is also an example of using multiple types of generation for one tilemap.
This can be seen in the Multi-Generation Example subfolder.
### Layout of each scene
Within each scene there will be an object named LevelGenerator. This object holds the [LevelGenerator.cs](https://github.com/UnityTechnologies/ProceduralPatterns2D/blob/master/Assets/Global%20Scripts/LevelGenerator.cs) Script, the exception to this rule is the multi-generation example scene.
The object named LevelGenerator in this scene holds a customised version of the [LevelGenerator.cs](https://github.com/UnityTechnologies/ProceduralPatterns2D/blob/master/Assets/Multi-Generation%20Example/Scripts/LevelGeneratorStack.cs) script which allows for multiple types of Map Settings
On this game object, you can generate and clear the level in edit mode using the buttons provided
### How to create Map Settings
To create a new map setting object, you need to right click in the project view then go Create->Map Settings.
*or*
You can got to Assets->Create->Map Settings from the toolbar
### How to call functions from MapFunctions.cs
The good thing about the MapFunctions.cs script is that you can take it out of this project and put it into any other project.
If you want to call functions from the script you would just need to do the following:
```csharp
int[,] map;
map = MapFunctions.GenerateArray(width, height, empty);
map = MapFunctions.PerlinNoise(map, seed);
MapFunctions.RenderMap(map, tilemap, tile);
```
What this code would do is:
1. Create an int array for a map
2. Generate the array into the map
3. Generate perlin noise within the map
4. Render the map to a tilemap
**Software Requirements**
Required: Unity 2017.3, or later version
**Hardware Requirements**
Required: Any Computer (Windows or Mac)
**Owner and Responsible Devs**
Owners: Ethan Bruins (ethanbruins@unity3d.com)