Here Be Dragons

Generate procedural maps for games.

Acknowledgments

This crate is based on mapgen.rs. Thanks to Krzysztof Langner for doing the hard work of implementing the many map generation algorithms this crate includes.

Map filters

This library consists of different map filters which can be combined to create custom map generators.

Implemented filters

• Area exit point
• Area starting point
• BSP Interior
• BSP Rooms
• Cellular automata
• Cull unreachable areas
• Diffusion-Limited Aggregation (DLA)
• Drunkard's walk
• Maze
• Noise generator
• Prefabs
• Room corridors nearest
• Simple rooms
• Voronoi hive
• Wave Function Collapse

Usage

Add the dependency to your project

here_be_dragons = "0.1"

Using single map generator:

use rand::prelude::*;
use here_be_dragons::{Map, MapFilter};
use here_be_dragons::filter::CellularAutomata;

let mut rng = StdRng::seed_from_u64(100);
let gen = CellularAutomata::new();
let map = gen.modify_map(&mut rng, &Map::new(80, 50));

Use MapBuilder for chaining map generator and modifiers

use here_be_dragons::{
    MapBuilder,
    filter::{
        NoiseGenerator, 
        CellularAutomata,
        AreaStartingPosition,
        XStart, 
        YStart,
    },
};

let map = MapBuilder::new(80, 50)
        .with(NoiseGenerator::uniform())
        .with(CellularAutomata::new())
        .with(AreaStartingPosition::new(XStart::CENTER, YStart::CENTER))
        .with(CullUnreachable::new())
        .with(DistantExit::new())
        .build();

For more information check the docs.

This library is based on the code from the Roguelike tutorial. I highly recommend it for learning how to write a Roguelike in Rust.

License

Licensed under either of

• Apache License, Version 2.0
• MIT license

at your option.

Contributions

Unless you explicitly state otherwise, any contribution intentionally submitted for inclusion in the work by you, as defined in the Apache-2.0 license, shall be dual licensed as above, without any additional terms or conditions.