Metadata-Version: 2.1
Name: mazegenerator
Version: 1.2
Summary: A maze generation algorithm for image-based mazes.
Home-page: https://github.com/exciteabletom/mazegenerator
Author: Tommy Dougiamas
Author-email: tom@digitalnook.net
License: UNKNOWN
Keywords: maze algorithm image generate
Platform: UNKNOWN
Classifier: License :: OSI Approved :: GNU General Public License v3 (GPLv3)
Classifier: Programming Language :: Python :: 3
Requires-Python: >=3.5
Description-Content-Type: text/markdown
Requires-Dist: Pillow (>=6.0)
Requires-Dist: progress (>=1.5)

# Maze Generator

This program generates a random black and white maze image. The mazes that are generated can be solved with <a href="//github.com/exciteabletom/mazesolver">mazesolver</a>

## Installing

Check that your python version is >=3.5 with `python3 -V`.
Also make sure that pip is installed with `python3 -m pip -V`.

To install, simply run `python3 -m pip install mazegenerator --user` on the command line.

You can run the tool using `mazegenerator`(unix-based) or `mazegenerator.exe` (windows).

## How do I use it?

You can use `mazegenerator --help` to get a list of commands.

Normal usage will look something like this: `mazegenerator -x 200 -y 300`


## What are the rules for maze images?
- Walls marked with black pixels and paths marked with white pixels

- Walls around the entire maze

- One entrance on the top row and one exit on the bottom row      



