Skip to content

This software is a mathematical simulation that generates a labyrinth and then solves it using an algorithm of your choice.

License

Notifications You must be signed in to change notification settings

maxencebonamy/Maze-Generator-Solver

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

20 Commits
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Maze Generator Solver

Maze_Generator_Solver.mp4

Description

This software is a mathematical simulation that generates a labyrinth and then solves it using an algorithm of your choice.

Generation algorithms:

  • Prim:
Prim.mp4
  • Kruskal:
Kruskal.mp4
  • Hunt and Kill:
Hunt_And_Kill.mp4
  • Depth First:
Depth_First.mp4
  • Aldous-Broder:
Aldous_Broder.mp4

Solve algorithms:

  • Breadth First:
Breadth_First.mp4

Get Started

Launch the software:

  1. Click on the Releases button on the right and select the latest version.
  2. Download the .zip archive and extract the files.
  3. Run the .exe executable.

Compile:

Note

Prerequisites:

  • Git must be installed on your computer. If not, click here.
  • Xmake must be installed on your computer, if not, click here.

  1. Clone the repository on your computer. To do this, open a terminal in the folder of your choice and run the following command:
git clone https://github.com/maxencebonamy/Maze-Generator-Solver
  1. Navigate inside the folder you've just cloned with the following command:
cd Maze-Generator-Solver
  1. Compile the project with the following command:
xmake
  1. Run the executable with this command:
xmake run main --generation kruskal

This is an example, you can change the name of the generation algorithm and add other parameters. This is described in greater detail in the "Features" section.


Features

Parameters that can be passed on the command line:

  • --generation or -g: specify generation algorithm ("kruskal", "prim", "hunt-and-kill", "depth-first" or "aldous-broder").
  • --solve or -s: specify resolution algorithm (default "breadth-first" or "none" to avoid resolving the maze).
  • --speed: specify the speed of the algorithm (default 1).
  • --fps or -f: specify the number of images displayed per second (default 60, 0 for no limit).
  • --fullscreen: launch software in full screen mode.
  • --cel-size or -c: specify cell size in pixels (default 1).

Example: the following command will launch the software in full screen mode, and generate a maze using the "hunt-and-kill" algorithm without solving it, with a speed of 10, 120 images displayed per second and a cell size of 10 pixels.

./Maze-Generator-Solver.exe -g hunt-and-kill -s none --speed 10 -f 120 --fullscreen -c 10
Example.mp4

About

This software is a mathematical simulation that generates a labyrinth and then solves it using an algorithm of your choice.

Topics

Resources

License

Stars

Watchers

Forks