Maze Game Library

A simple Rust library for creating and playing text-based maze games. The maze is procedurally generated, and the player must find their way from the entrance to the exit.

Features

Randomly generated mazes
Simple text-based UI
Keyboard controls for character movement
Can be used as a library or standalone game

Installation

Add this to your Cargo.toml:

[dependencies]
maze_game = "0.1.0"

Usage as a Library

use maze_game::maze::Maze;

fn main() {
    // Create a new maze
    let mut maze = match Maze::create() {
        Some(m) => m,
        None => {
            println!("Failed to generate the maze.");
            return;
        }
    };

    // Display the maze
    println!("{}", maze.get_maze_as_string());

    // Try to move the player
    let moved = maze.try_move("d"); // Move right
    
    // Check if the game is completed
    let state = maze.get_state();
    if state.is_completed {
        println!("Congratulations! You've reached the goal!");
    }
}

Playing the Game

Execute the following command to run the standalone game:

cargo run

Controls

w or up: Move up
s or down: Move down
a or left: Move left
d or right: Move right
q: Quit the game

Project Structure

lib.rs: Public module exports
main.rs: Standalone game loop and user input handling
maze.rs: Maze data structure and operations
generator.rs: Maze generation algorithms
position.rs: Position structure

Algorithm

The maze is generated using a "recursive backtracking" algorithm (also known as the "digging method"). This algorithm works as follows:

Fill the entire maze with walls
Start at a specific point and mark it as a passage
Choose a random direction and, if the cell two spaces away is a wall, convert it and the wall between to passages
Recursively repeat step 3 from the newly created passage

This creates a complex maze with dead ends and branching paths.

License

This project is licensed under the MIT License - see the LICENSE file for details.

maze_runner_rs 0.1.0