juho05 / libmaze

An extensible C++ library for creating and solving mazes.

libmaze

An extensible C++20 library for creating and solving mazes.

NOTE: This library currently has some serious performance issues. I'm currently occupied with other projects. I don't kown when or if I will revisit this project.

Documentation

Features

• Work with mazes through an easy to use class
• Export mazes
  • Exporter interface
  • PNGExporter
    • Create png image files showing the maze
  • MinecraftExporter
    • Create datapacks which generate the maze in-game
  • JSONExporter
    • Create json files representing the maze
• Load mazes
  • Loader interface
  • PNGLoader
    • Load png files created using PNGExporter
  • JSONLoader - Load json files created using JSONExporter
• Generate mazes
  • Generator interface
  • Randomized depth-first search
  • Wilson's algorithm
  • Aldous-Broder algorithm
  • Randomized Kruskal's algorithm
  • Randomized Prim's algorithm
  • Recursive division method
  • Simple algorithms
  • Cellular automata
• Create weighted graphs from mazes
• Solve mazes
  • Solver interface
  • Breadth-first search
  • Dijkstra's algorithm
  • Bellman–Ford algorithm
  • A* search algorithm
  • Floyd–Warshall algorithm
  • Johnson's algorithm
  • Viterbi algorithm

Installing Dependencies

ArchLinux

sudo pacman -S catch2 libpng

Other

Install the following libraries:

• Catch2
• libpng

Building

Unix-like

Required packages

• git
• cmake
• make

Run the following commands (Change Release to Debug for debug build):

git clone https://gitlab.com/Bananenpro05/libmaze.git
cd libmaze
mkdir build && cd build
cmake -DCMAKE_BUILD_TYPE=Release ..
make

Windows

¯\(o_o)/¯

Running tests

Run the following command in the build directory after building as debug build:

./tests

After running the tests you can manually check the outcome of all algorithms by checking the corresponding png file (e.g. depth-first.png).

License

This program is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.

This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.

You should have received a copy of the GNU General Public License along with this program. If not, see http://www.gnu.org/licenses/.

Copyright

Copyright © 2021 Julian Hofmann