map_generator

A library that generates 2D-interconnected cave systems. Optionally, can be compiled into a Python module.

I created this project (my first shot at Rust) as an exercise in array manipulation, procedural generation, and algorithmic thinking as a whole. In the future, map_generator will serve as a basis for a traditional roguelike focused on spelunking, evasion, terrain traversal, etc...

Examples

Cave generation process

Dungeons

Functions

Python

Creates a simple cave world. Connectivity between caves is ensured.

generate(height: int, width: int) ⟶ List(List(int))

generate_from_seed(height: int, width: int, seed: int) ⟶ List(List(int))

Generates a cave with a series of connected rooms and corridors.

dungeon(height: int, width: int) ⟶ List(List(int))

dungeon_from_seed(height: int, width: int, seed: int) ⟶ List(List(int))

Rust

build(height: usize, width: usize, seed: Option<u64>, rooms: bool) -> Vec<Vec<Tile>>

A random seed will be used if seed is Option::None otherwise, the provided Some value will be unwrapped and used to seed the generation process.

Requirements

Rust and Python requirements are specified in Cargo.toml and requirements.txt respectively. Cargo should handle Rust dependencies automatically; any missing Python modules can be installed with the following:

pip install -r requirements.txt

Usage

Python

import sys

from map_generator import dungeon

symbols = {
    0: " ",
    1: "#",
    2: "%",
    3: "+"
}

world = dungeon(32, 64)
for row in world:
    for cell in row:
        sys.stdout.write(symbols[cell])
    sys.stdout.write("\n")

Rust

use map_generator::build;
use std::collections::HashMap;

fn main() {
    let symbols: HashMap<u8, String> = HashMap::from([
        (0, " "),
        (1, "#"),
        (2, "%"),
        (3, "+")
    ]);
    
    let world = build(32, 64, None, true);
    for y in 0..world.len() {
        for x in 0..world[0].len() {
            print!("{}", symbols[&world[y][x].id])
        }
        println!();
    }
}

TODO

• Series of connected rooms should have fewer exterior doors
• Disconnected rooms should be pruned
• Ores, POIs, set pieces