Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/cheina97/gomaze
GoMaze is a simple maze generator and solver written in Go.
https://github.com/cheina97/gomaze
ebitengine graph graphviz maze shortest-path
Last synced: 1 day ago
JSON representation
GoMaze is a simple maze generator and solver written in Go.
- Host: GitHub
- URL: https://github.com/cheina97/gomaze
- Owner: cheina97
- License: apache-2.0
- Created: 2024-03-24T19:15:01.000Z (8 months ago)
- Default Branch: main
- Last Pushed: 2024-03-24T19:21:29.000Z (8 months ago)
- Last Synced: 2024-10-11T11:18:37.331Z (25 days ago)
- Topics: ebitengine, graph, graphviz, maze, shortest-path
- Language: Go
- Homepage:
- Size: 526 KB
- Stars: 2
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# GoMaze
*GoMaze* is a simple maze generator and solver written in *Go*. It randomly generate the maze and uses *Dijkstra algorithm* to find the minimum path between 2 points.
The library used to render the maze and manage inputs is [ebitengine](https://ebitengine.org/), a simple 2D game engine written in Go.
The minimum path is calculated using the [graph](https://pkg.go.dev/github.com/dominikbraun/graph#readme-getting-started) library.
# How to use
## How to run
```bash
go run cmd/main.go
```
```bash
Flags:
-h int
height of the maze (cells number) (default 20)
-w int
width of the maze (cells number) (default 20)
```
## How to play
- *Click* on the maze with the *left mouse button* to set the *start* and the *ending* point.
- Press *R* on the keyboard to *generate* a new maze.
# How it works
To find the minimum path between 2 points, the program uses the *Dijkstra algorithm*. Every walkable cell of the matrix (representing the maze), have been added to a graph. The weight of the edges is the distance between 2 cells, which is always 1. The algorithm will find the shortest path between the 2 points by exploring the graph.
This is an example of the generated graph:
