Skip to content

Mazex is a tool for generating mazes using different algorithms and rendering them as png images.

License

Notifications You must be signed in to change notification settings

alexandrubagu/mazex

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

26 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

mazex

Mazex is a tool for generating mazes using different algorithms and rendering them as png images.

| Instalation | Usage | Algorithms | License

Instalation

In order to install mazex you need to have Elixir installed.

After that you can clone this repository and compile the project by running mix compile

Usage

Maze can be generated by using mix mazex task. This tasks accepts the following options:

## Options

    --rows             # Number of rows for the maze
    --columns          # Number of columns for the maze
    --algorithm        # One of the following algorithms: binary_tree, sidewinder
    --output           # Output folder if not given it will use the current folder as output folder
    --filename         # File name to be used for generated maze image, if not given it will use the maze_<current_timestamp>.png.

Example:

mix mazex --rows=10 --columns=15 --algorithm=binary_tree

mix mazex --rows=10 --columns=15 --algorithm=sidewinder --output=/tmp --filename=maze.png

Algorithms

Supported maze algorithms:

Binary Tree

binary_tree

Sidewinder

sidewinder

Aldous Broder

aldous_broder

License

Copyright © 2017–2020 Alexandru Bogdan Bâgu

Distributed under the MIT License.

About

Mazex is a tool for generating mazes using different algorithms and rendering them as png images.

Topics

Resources

License

Stars

Watchers

Forks

Languages