Hexlab

• Features
• Installation
• Getting Started
• Usage
• Documentation
• Contributing
• Acknowledgements
• License

Hexlab is a Rust library for generating and manipulating hexagonal mazes.

Features

• Create hexagonal mazes of configurable size
• Customizable maze properties (radius, start position, seed)
• Efficient bit-flag representation of walls for optimized memory usage
• Multiple maze generation algorithms (WIP)
• Maze builder pattern for easy and flexible maze creation

Installation

Add hexlab as a dependency:

cargo add hexlab

Getting Started

use hexlab::prelude::*;

fn main() {
    // Create a new maze with radius 5
    let maze = MazeBuilder::new()
        .with_radius(5)
        .build()
        .expect("Failed to create maze");
    println!("Maze size: {}", maze.count());
}

Usage

use hexlab::prelude::*;

// Create a new maze
let maze = MazeBuilder::new()
    .with_radius(5)
    .build()
    .expect("Failed to create maze");

// Get a specific tile
let tile = maze.get_tile(&Hex::new(1, -1)).unwrap();

// Check if a wall exists
let has_wall = tile.walls().contains(EdgeDirection::FLAT_NORTH);

Documentation

Full documentation is available at docs.rs.

Contributing

Contributions are welcome! Please feel free to submit a Pull Request.

Acknowledgements

Hexlab relies on the excellent hexx library for handling hexagonal grid mathematics, coordinates, and related operations. We're grateful for the robust foundation it provides for working with hexagonal grids.

License

This project is dual-licensed under either:

• MIT License (LICENSE-MIT or http://opensource.org/licenses/MIT)
• Apache License, Version 2.0 (LICENSE-APACHE or http://www.apache.org/licenses/LICENSE-2.0)

at your option.