here_be_dragons/README.md
2020-09-15 16:23:47 +02:00

2.4 KiB

Game Map Generator

Build Status Crates.io mapgen.rs

Generate procedural maps for games. Try it in the browser using WebAssembly.

Features

Dungeons

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

Usage

Add dependency to your project

mapgen = "0.2"

Using single map generator:

use rand::prelude::*;
use mapgen::dungeon::{
    MapGenerator,
    cellular_automata::CellularAutomataGen
};

let mut rng = StdRng::seed_from_u64(100);
let gen = CellularAutomataGen::new(80, 50);
let map = gen.generate_map(&mut rng)

Use MapBuilder for chaining map generator and modifiers

use mapgen::dungeon::{
    MapBuilder,
    map::{Map, Point, TileType},
    cellular_automata::CellularAutomataGen,
    starting_point::{AreaStartingPosition, XStart, YStart},
    cull_unreachable::CullUnreachable,
};

let map = MapBuilder::new(CellularAutomataGen::new(80, 50))
            .with(AreaStartingPosition::new(XStart::CENTER, YStart::CENTER))
            .with(CullUnreachable::new())
            .build_map();

For more information check the doc

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

License

Licensed under either of

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.