Skip to main content

A shortest-path maze solving algorithm for image-based mazes.

Project description

Maze Solver

Created by Tommy Dougiamas

This algorithm finds the shortest path through black and white maze images. It outputs an image with the path marked in green.

Installing

Easy Installation

Check that your python version is >=3.5 with python3 -V. (You might have to use python3.5 or similar). Also make sure that pip is installed with python3 -m pip -V.

To install, simply run python3 -m pip install mazesolver on the command line as root/admin.

You can run the tool using mazesolver.

Install from source

For GNU/Linux:

git clone https://github.com/exciteabletom/mazesolver.git

cd mazesolver

python3 setup.py build

sudo python3 setup.py install

For Windows CMD:

Make sure your prompt has admin permissions.

git clone https://github.com/exciteabletom/mazesolver.git

chdir mazesolver

python3 setup.py build

python3 setup.py install

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

If this is confusing, check out some of the example mazes in the pics directory.

How do I use it?

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

Make sure that your image meets the specifications above.

Normal usage will look something like this: mazesolver -i path/to/input_img -o path/to/output_dir

How does the algorithm work?

  • Start at the entrance and label it zero.

  • Move to any neighbouring cells and mark them with 1

  • Move to any of the cells neighbouring the ones marked 1 and label them 2

  • Continue doing this until all cells are marked

  • Start from the exit of the maze and move to any neighbouring cell that == the current cell's number -1. Until we reach 0 (the entrance).

We now have the shortest path from the entrance to the exit!

Licensed under GNU GPLv3

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Files for mazesolver, version 1.2.2.post1
Filename, size File type Python version Upload date Hashes
Filename, size mazesolver-1.2.2.post1-py3-none-any.whl (19.4 kB) File type Wheel Python version py3 Upload date Hashes View

Supported by

AWS AWS Cloud computing Datadog Datadog Monitoring DigiCert DigiCert EV certificate Facebook / Instagram Facebook / Instagram PSF Sponsor Fastly Fastly CDN Google Google Object Storage and Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Salesforce Salesforce PSF Sponsor Sentry Sentry Error logging StatusPage StatusPage Status page