nicholas-maltbie / TileMaps

Example repository for organizing generic tile maps in Unity with C#

Home Page:https://nickmaltbie.com/TileMaps/

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

Tile Maps

This project will generate various types of tile maps including square and hexagon maps and allow for spawning in game objects based off of these patterns. Includes various features such as path finding.

Sample pathfinding demo with astar.

The Tile Maps project is hosted on GitHub at https://github.com/nicholas-maltbie/TileMaps

An interactive version demonstrating the TileMaps project is hosted at https://nickmaltbie.com/TileMaps/.

Series of videos describing how pathfinding works

Development

If you want to help with the project, feel free to make some changes and submit a PR to the repo.

This library was developed as part of the Falling Parkour Project here - https://github.com/nicholas-maltbie/FallingParkour

This project is developed using Unity Release 2021.1.19f1. Install this version of Unity from Unity Hub using this unity hub link unityhub://2021.1.19f1/d0d1bb862f9d.

When working with the project, make sure to setup the .githooks if you want to edit the code in the project. In order to do this, use the following command to reconfigure the core.hooksPath for your repository

git config --local core.hooksPath .githooks

Documentation

Documentation on the project and scripting API is found at https://nickmaltbie.com/TileMaps/docs/ for the latest version of the codebase.

To view the documentation from a local build of the project install DocFX, use the following command from the root of the repo.

docfx Documentation/docfx.json --serve

The documentation for the project is stored in the folder /Documentation and can be modified and changed to update with the project.

This documentation project is inspired by the project by Norman Erwan's DocFxForUnity

License

This is an open source project licensed under a MIT License. Feel free to use a build of the project for your own work. If you see an error in the project or have any suggestions, write an issue or make a pull request, I'll happy include any suggestions or ideas into the project.

About

Example repository for organizing generic tile maps in Unity with C#

https://nickmaltbie.com/TileMaps/

License:MIT License


Languages

Language:C# 68.6%Language:ShaderLab 22.6%Language:HLSL 3.8%Language:HTML 2.9%Language:CSS 1.1%Language:Shell 1.1%