README.md

Maze generator - A rust crate to generate mazes

Overview

This crate provide functions to generate mazes with several algorithms, in an efficient way. Once a maze is generated, you can print it with walls as lines or as blocks (hey Minecrafters) or export it as jpg.

Public API

pub fn generate(w: usize, h: usize, generator: Generator) -> Maze;
pub fn print_linewise(&self);
pub fn print_blockwise(&self, free_char: char, wall_char: char);
pub fn export(&self, filename: &str, w: u32, h: u32, walls_width: u32);

Compilation & Installation

Compile from source:

git clone https://github.com/lfalkau/maze-generator
cd maze-generator
cargo build

Import from crates.io

NOT YET EXPORTED

Generation algorithms

• Recursive backtracker
• Eller’s algorithm
• Kruskal’s algorithm
• Prim’s algorithm
• Recursive division algorithm
• Aldous-Broder algorithm
• Wilson’s algorithm
• Hunt-and-Kill algorithm
• Growing Tree algorithm
• Binary Tree algorithm
• Sidewinder algorithm

Ressources

Mazes for programmers