https://github.com/average-user/mazegen
Implementation of different Maze Generation algorithms in Haskell
https://github.com/average-user/mazegen
Last synced: 12 months ago
JSON representation
Implementation of different Maze Generation algorithms in Haskell
- Host: GitHub
- URL: https://github.com/average-user/mazegen
- Owner: Average-user
- License: mit
- Created: 2018-05-16T21:10:19.000Z (about 8 years ago)
- Default Branch: master
- Last Pushed: 2019-05-15T18:54:56.000Z (about 7 years ago)
- Last Synced: 2025-07-06T08:44:00.401Z (12 months ago)
- Language: Haskell
- Size: 98.6 KB
- Stars: 8
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: ChangeLog.md
- License: LICENSE
Awesome Lists containing this project
README
# Haskell Maze Generator
This software provides an implementation of several algorithms to generate
mazes. The mazes are shown with
[Gloss](https://hackage.haskell.org/package/gloss)
(2D vector graphics, package for Haskell). It also allows to draw paths from one
place to another, and is capable of generating perfect and non-perfect mazes.
This project is strongly inspired by
[this](http://weblog.jamisbuck.org/2011/2/7/maze-generation-algorithm-recap)
blog of Maze Generation algorithms
Algorithms implemented so far
- [Growing Tree](https://github.com/Average-user/MazeGen/tree/master/src/Algorithm/GrowingTree.hs)
- [Hunt And Kill](https://github.com/Average-user/MazeGen/tree/master/src/Algorithm/HuntKill.hs)
- [Randomized Prims](https://github.com/Average-user/MazeGen/tree/master/src/Algorithm/Prims.hs)
- [Recursive Backtracker](https://github.com/Average-user/MazeGen/tree/master/src/Algorithm/Backtracker.hs)
- [Sidewinder](https://github.com/Average-user/MazeGen/tree/master/src/Algorithm/Sidewinder.hs)
- [Randomized Kruskals](https://github.com/Average-user/MazeGen/tree/master/src/Algorithm/Kruskals.hs)
- [Eller's Algorithm](https://github.com/Average-user/MazeGen/blob/master/src/Algorithm/Ellers.hs)
#### Usage
The parameters for building the maze, are specified in `config.json` file. Which
by default is:
``` json
{
"algorithm": "Prims",
"maze-size": "(30,30)",
"walls-to-remove": "10",
"draw-paths": "True",
"path-starting-point": "(0,0)",
"path-ending-point": "(29, 29)"
}
```
To know by what name algorithms are recognized checkout
[`ParseConfig.hs`](https://github.com/Average-user/MazeGen/blob/master/src/ParseConfig.hs).
`walls-to-remove` refers to the amount of walls to remove from the maze to make
a non-perfect maze. The default 0, generates perfect mazes (one and only one
path from any place to another).
When `draw-paths` is on, it I'll draw shortest paths in red, and the more large
ones in purple.
An example of default `config.json`:
``` text
stack build
stack exec MazeGen-exe
```
#### Test And Benchmarks
You can run some random tests using
[QuickCheck](https://hackage.haskell.org/package/QuickCheck) with:
``` text
stack test
```
And benchmarks using [
criterion](https://hackage.haskell.org/package/criterion) with:
``` text
stack bench
```
Although is recommended to use
``` text
stack bench --ba='-o bench.html'
```
To output benchmarks results in an `.html` file. That looks like:
Let us say that this benchmarks will always run with the same Random Gen. This
means that every time you run it, it'll measure the time of the same process,
that will not be affected by randomness, but only by changes to the algorithms.
The Random Gen chosen is completely arbitrary.