=================================================

PolyMaze - Create mazes from a variety of sources

This utility converts several different kinds of inputs into mazes.

Allowed Inputs:

• Aspect ratio (height / width) of a rectangular maze
• Text - convert the content of the string into a maze / mazes
• Image - convert the dark parts of an image into a maze / mazes

Options:

• Height / Width - adjust the difficulty (measured in polygon side lengths)
• Complexity - adjust the difficulty (measured in polygon density)
• Font - use your own font when making a String maze (especially for unicode strings)
• Shape - explicitly choose the type of tesselation used in the maze

.. image:: https://github.com/kobejohn/polymaze/raw/master/docs/Globe_Polycat_small.png

.. image:: https://github.com/kobejohn/polymaze/raw/master/docs/String_small.png

Installation:

polymaze should work with Py2 or Py3.

.. code:: sh

pip install polymaze

If you get the error decoder zip not available when using it, then probably PILLOW did not install completely. Try to upgrade or reinstall PILLOW and make sure it says png support was installed.

Commandline Usage:

To make a generic rectangular maze, at the command line:

.. code:: sh

polymaze

.. image:: https://github.com/kobejohn/polymaze/raw/master/docs/rectangle_small.png

To see all options:

.. code:: sh

polymaze -h

For example, to make a string into a maze with some extra options (note the \n gets converted to a real newline internally):

.. code:: sh

polymaze --text "Happy\nBirthday!" --complexity 10 --shape Polycat
polymaze -t 迷路 -c 10 -s OctaDiamond --font meiryob.ttc

.. image:: https://github.com/kobejohn/polymaze/raw/master/docs/birthday_small.png

.. image:: https://github.com/kobejohn/polymaze/raw/master/docs/unicode_small.png

Everything above assumes the command line entry point (named polymaze) works after installation. If not, then you will need to navigate to the root package directory and use:

.. code:: sh

python cli_runner.py [--options...]

Library Usage:

Please see demo.py for examples of how to use the components. You can also run it simply with:

.. code:: sh

python demo.py

The primary components are PolyGrid (the geometric core of the whole package), and PolyMaze which converts a PolyGrid into a maze.

Extension:

If anyone is interested, I can document how to specify new tessellations.

Background and Feedback:

I developed this to regain some basic trigonometry skills which I have lost over the years.

If you find this useful or have any feedback, please let me know! Specifically I have only tested this on Windows so please make an issue if it doesn't work in Linux, etc.

License:

MIT. See LICENSE

Bundled Noto CJK Font:

SIL Open Font License, Version 1.1. See polymaze/font/LICENSE_CJK.txt