Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/Amaranthos/UnityHexGrid
A hex grid generation tool, for use in unity
https://github.com/Amaranthos/UnityHexGrid
Last synced: 3 months ago
JSON representation
A hex grid generation tool, for use in unity
- Host: GitHub
- URL: https://github.com/Amaranthos/UnityHexGrid
- Owner: Amaranthos
- License: mit
- Created: 2015-09-27T00:44:41.000Z (about 9 years ago)
- Default Branch: master
- Last Pushed: 2019-09-22T05:46:43.000Z (about 5 years ago)
- Last Synced: 2024-07-14T04:37:55.589Z (4 months ago)
- Language: C#
- Size: 40 KB
- Stars: 220
- Watchers: 14
- Forks: 47
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
- awesome-unity-open-source-on-github - UnityHexGrid - A hex grid generation tool (Generator)
README
# UnityHexGrid
A hex grid generation tool, for use in unity. Much of the hex logic is drawn from [Red Blob Games](http://www.redblobgames.com/grids/hexagons/). I made this because I initially struggled with the implementation so now you don't have to. Feel free to leave any feedback or suggestions, I will consider implementing suggestions that I think are generally useful to all users.
## Installation
Download unity package from releases
In unity Assets > Import Package > Custom Package
Navigate to downloaded file and select it
Create an empty gameObject `ctrl+shift+n` and add `Grid` script to it
## Generating a Grid in edit mode
Click Generate Grid in the inspector ensuring that relevant settings are selected
## Generating a Grid at runtime
Ensure relevant settings are set and call `GenerateGrid()` on an instance of Grid
```cs
public Material hexMaterial; //Assigned in inspector
public Material lineMaterial; //Assigned in inspector
private Grid grid;
private void Start() {
//Set grid settings
grid.mapShape = MapShape.Rectangle;
grid.mapWidth = 5;
grid.mapHeight = 5;
grid.hexOrientation = HexOrientation.Flat;
grid.hexRadius = 1;
grid.hexMaterial = hexMaterial;
grid.addColliders = true;
grid.drawOutlines = true;
grid.lineMaterial = lineMaterial;
//Gen Grid
grid.GenerateGrid();
}
```
## Access tiles at runtime
Call `Tiles` on an instance of Grid, returns a `Dictionary` where the string is constructed from the tile's coordinates.
```cs
private Grid grid;
private void Start() {
var tiles = grid.Tiles;
}
```
## Grid Settings
* `mapShape` determines the overall shape of the map, available options are
* Rectangle
* Hexagon
* Parrallelogram
* Triangle
* `mapWidth` an `int`, controls the number tiles wide the map is, for hexagonal shape the larger of `mapWidth` and `mapHeight` is picked and used as a radius.
* `mapHeight` an `int`, controls the number of tiles high the map is
* `hexOrientation` the orientation of the individual hexes, available options are
* Pointy
* Flat
* `hexRadius` a `float`, controls the radius of hex tile meshes, in unity units, measured from the centre of the hex to a corner, all corners are equidistant from the centre
* `hexMaterial` a `Material`, applied to the hex tile meshes, if not specified defaults to unity's diffuse material
* `addColliders` a `bool`, when true grid generation will add a mesh collider to the tiles using the same mesh as the tiles
* `drawOutlines` a `bool`, when true grid generation will add line renderers to the tiles and draw outlines for the meshes
* `lineMaterial` a `Material`, applied to the line renderers for drawing outlines, if you want outlines add the `Lines` material, included in the package, to the inspector field. Apparently I couldn't load the default Sprites/Default material via code