# Generators

## Generators

[![generators](https://github.com/doorfortyfour/TileWorldCreator/raw/master/docs/img/generators.png)](https://github.com/doorfortyfour/TileWorldCreator/blob/master/docs/img/generators.png)\
Generators are actions which creates a map based on an algorithm (Except for the paint generator) from scratch.\
TileWorldCreator has multiple algorithms built-in but you can of course also implement your own.

### Cellular Automata

[![cellularAutomata](https://github.com/doorfortyfour/TileWorldCreator/raw/master/docs/img/cellularAutomata.gif)](https://github.com/doorfortyfour/TileWorldCreator/blob/master/docs/img/cellularAutomata.gif)\
The cellular automata generator is a great generator if you want to create an island type of map.

### BSP Dungeon

[![bspDungeon](https://github.com/doorfortyfour/TileWorldCreator/raw/master/docs/img/bspDungeon.gif)](https://github.com/doorfortyfour/TileWorldCreator/blob/master/docs/img/bspDungeon.gif)\
BSP Dungeon generates dungeon like maps based on the BSP algorithm.

### L-System

[![lsystem](https://github.com/doorfortyfour/TileWorldCreator/raw/master/docs/img/lsystem.gif)](https://github.com/doorfortyfour/TileWorldCreator/blob/master/docs/img/lsystem.gif)\
The L-System generator is great for creating road like networks or similiar looking maps. This algorithm uses string based rules.\
Read more about L-Systems here:\
[L-System](https://www.sidefx.com/docs/houdini/nodes/sop/lsystem.html)

### Maze

[![maze](https://github.com/doorfortyfour/TileWorldCreator/raw/master/docs/img/maze.gif)](https://github.com/doorfortyfour/TileWorldCreator/blob/master/docs/img/maze.gif)\
Use the maze generator to generate maze like maps.

### Random Noise

[![random](https://github.com/doorfortyfour/TileWorldCreator/raw/master/docs/img/randomNoise.gif)](https://github.com/doorfortyfour/TileWorldCreator/blob/master/docs/img/randomNoise.gif)\
Generates a random noise map. Great in combination with an `expand` and `smooth` modifier.\
**Random noise with `expand` and `smooth` modifier:**\
[![randomModified](https://github.com/doorfortyfour/TileWorldCreator/raw/master/docs/img/randomNoiseModified.gif)](https://github.com/doorfortyfour/TileWorldCreator/blob/master/docs/img/randomNoiseModified.gif)

### Paint

[![paint](https://github.com/doorfortyfour/TileWorldCreator/raw/master/docs/img/paint.gif)](https://github.com/doorfortyfour/TileWorldCreator/blob/master/docs/img/paint.gif)\
The paint generator allows you to easily paint a map in the scene view.

1. Add a paint generator to your layer.
2. Enable the paint generator by clicking on the brush icon.
3. In the scene view you can now start adding or removing tiles by holding Left Ctrl key and holding the left or right mouse button. [![paintSceneView](https://github.com/doorfortyfour/TileWorldCreator/raw/master/docs/img/paintSceneView.png)](https://github.com/doorfortyfour/TileWorldCreator/blob/master/docs/img/paintSceneView.png)
4. When enabling the paint layer, the scene view registers the paint layer and allows you to easily enable / disable the paint layer from the scene view.

### Circle

[![circle](https://github.com/doorfortyfour/TileWorldCreator/raw/master/docs/img/circle.png)](https://github.com/doorfortyfour/TileWorldCreator/blob/master/docs/img/circle.png)\
The circle generator generates a simple circle shape from a random or fixed position.

### Texture

[![textureGenerator](https://github.com/doorfortyfour/TileWorldCreator/raw/master/docs/img/TextureGenerator.png)](https://github.com/doorfortyfour/TileWorldCreator/blob/master/docs/img/TextureGenerator.png)\
The texture generator generates a map based on a texture2d. You can also set this texture by script during runtime. Please have a look at the `10_GeneratyByTexture` demo scene

[![textureGeneratorDemo](https://github.com/doorfortyfour/TileWorldCreator/raw/master/docs/img/TextureGeneratorDemo.gif)](https://github.com/doorfortyfour/TileWorldCreator/blob/master/docs/img/TextureGeneratorDemo.gif)

### Dot grid

[![dogGrid](https://github.com/doorfortyfour/TileWorldCreator/raw/master/docs/img/dotGrid.png)](https://github.com/doorfortyfour/TileWorldCreator/blob/master/docs/img/dotGrid.png)\
Generates a dot grid

### Checkerboard

[![checkerboard](https://github.com/doorfortyfour/TileWorldCreator/raw/master/docs/img/checkerboard.png)](https://github.com/doorfortyfour/TileWorldCreator/blob/master/docs/img/checkerboard.png)\
Generates a checkerboard like grid

### Pathfinding

[![pathfinding](https://github.com/doorfortyfour/TileWorldCreator/raw/master/docs/img/pathfinding.gif)](https://github.com/doorfortyfour/TileWorldCreator/blob/master/docs/img/pathfinding.gif)\
The pathfinding generator takes a start position and end position (layers) and generates a path on a navigation layer. Please see the included demo scenes for more information.