https://github.com/itchyny/maze

A maze command written in Go
https://github.com/itchyny/maze

golang maze maze-game maze-generation-algorithms maze-generator

Last synced: 12 months ago
JSON representation

A maze command written in Go

• Host: GitHub
• URL: https://github.com/itchyny/maze
• Owner: itchyny
• License: mit
• Created: 2016-04-04T12:39:04.000Z (almost 10 years ago)
• Default Branch: main
• Last Pushed: 2024-03-23T02:15:13.000Z (almost 2 years ago)
• Last Synced: 2025-03-16T04:03:58.578Z (about 1 year ago)
• Topics: golang, maze, maze-game, maze-generation-algorithms, maze-generator
• Language: Go
• Homepage:
• Size: 105 KB
• Stars: 120
• Watchers: 4
• Forks: 10
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

• awesome-tuis - Maze

README

          
# maze

[![CI Status](https://github.com/itchyny/maze/actions/workflows/ci.yaml/badge.svg?branch=main)](https://github.com/itchyny/maze/actions?query=branch:main)

![maze](https://raw.githubusercontent.com/wiki/itchyny/maze/image/maze1.gif)

## Usage

The `maze` command without the arguments prints the random maze to the standard output.

```sh

maze

```

![maze](https://raw.githubusercontent.com/wiki/itchyny/maze/image/maze6.gif)

We can play the maze on the terminal with `--interactive`.

```sh

maze --interactive

```

![maze](https://raw.githubusercontent.com/wiki/itchyny/maze/image/maze2.gif)

The `--format color` is a good option to print the colored maze. Also we can specify the size of the maze with `--width` and `--height`.

```sh

maze --width 20 --height 10 --format color

```

![maze](https://raw.githubusercontent.com/wiki/itchyny/maze/image/maze3.gif)

We can toggle the solution with the `s` key.

![maze](https://raw.githubusercontent.com/wiki/itchyny/maze/image/maze4.gif)

If we change the font size of the terminal smaller, we get a large maze.

![maze](https://raw.githubusercontent.com/wiki/itchyny/maze/image/maze5.gif)

## Installation

### Homebrew

```bash

brew install itchyny/tap/maze

```

### Build from source

```bash

go install github.com/itchyny/maze/cmd/maze@latest

```

## Bug Tracker

Report bug at [Issues・itchyny/maze - GitHub](https://github.com/itchyny/maze/issues).

## Author

itchyny ()

## License

This software is released under the MIT License, see LICENSE.

## Special thanks

Special thanks to the [termbox-go](https://github.com/nsf/termbox-go) library.

## References

- [Maze generation algorithm - Wikipedia, the free encyclopedia](https://en.wikipedia.org/wiki/Maze_generation_algorithm)

- [Maze solving algorithm - Wikipedia, the free encyclopedia](https://en.wikipedia.org/wiki/Maze_solving_algorithm)

- [lunixbochs/maze: Maze generation and salvation](https://github.com/lunixbochs/maze)

- [willfrew/maze-generation: Some maze generation algorithms written in Go](https://github.com/willfrew/maze-generation)