diff --git a/Cargo.toml b/Cargo.toml index d2eb52a..057bc05 100644 --- a/Cargo.toml +++ b/Cargo.toml @@ -1,13 +1,12 @@ [package] -name = "mapgen" -version = "0.5.2" -authors = ["Krzysztof Langner "] -description = "Map generator for games (dungeons, worlds etc.)" +name = "here_be_dragons" +version = "0.1.0" +authors = ["Nolan Darilek ", "Krzysztof Langner "] +description = "Map generator for games" keywords = ["game", "map", "map-generator"] license = "MIT OR Apache-2.0" -repository = "https://github.com/klangner/mapgen.rs" -homepage = "https://github.com/klangner/mapgen.rs" -documentation = "https://docs.rs/mapgen" +repository = "https://labs.lightsout.games/projects/here_be_dragons" +documentation = "https://docs.rs/here_be_dragons" edition = "2021" [dependencies] diff --git a/README.md b/README.md index c5d9ed5..fdc7236 100644 --- a/README.md +++ b/README.md @@ -1,15 +1,17 @@ -# Game Map Generator +# Here Be Dragons -[![Build Status](https://travis-ci.org/klangner/mapgen.rs.svg?branch=master)](https://travis-ci.org/klangner/mapgen.rs) -[![Crates.io](https://img.shields.io/crates/v/mapgen.svg)](https://crates.io/crates/mapgen) -[![mapgen.rs](https://docs.rs/mapgen/badge.svg)](https://docs.rs/mapgen/) +[![Crates.io](https://img.shields.io/crates/v/here_be_dragons.svg)](https://crates.io/crates/here_be_dragons) +[![here_be_dragons](https://docs.rs/here_be_dragons/badge.svg)](https://docs.rs/here_be_dragons/) -Generate procedural maps for games. [Try it in the browser](https://klangner.github.io/mapgen.rs/) using WebAssembly. +Generate procedural maps for games. +## Acknowledgments + +This crate is based on [mapgen.rs](https://github.com/klangner/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 generator. +This library consists of different map filters which can be combined to create custom map generators. ### Implemented filters @@ -29,20 +31,19 @@ This library consists of different map filters which can be combined to create c * [x] Voronoi hive * [ ] Wave Function Collapse - ## Usage -Add dependency to your project +Add the dependency to your project ``` -mapgen = "0.4" +here_be_dragons = "0.1" ``` Using single map generator: ```rust use rand::prelude::*; -use mapgen::{Map, MapFilter}; -use mapgen::filter::CellularAutomata; +use here_be_dragons::{Map, MapFilter}; +use here_be_dragons::filter::CellularAutomata; let mut rng = StdRng::seed_from_u64(100); let gen = CellularAutomata::new(); @@ -52,7 +53,7 @@ let map = gen.modify_map(&mut rng, &Map::new(80, 50)); Use MapBuilder for chaining map generator and modifiers ```rust -use mapgen::{ +use here_be_dragons::{ MapBuilder, filter::{ NoiseGenerator, @@ -72,14 +73,11 @@ let map = MapBuilder::new(80, 50) .build(); ``` -For more information check the [doc](https://docs.rs/mapgen) +For more information check the [docs](https://docs.rs/here_be_dragons). +This library is based on the code from the [Roguelike tutorial](https://github.com/thebracket/rustrogueliketutorial). I highly recommend it for learning how to write a Roguelike in Rust. -This library is based on the code from the [Roguelike tutorial](https://github.com/thebracket/rustrogueliketutorial). -I highly recommend it for learning how to write Roguelike in Rust. - - -# License +## License Licensed under either of @@ -88,9 +86,8 @@ 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. +dual licensed as above, without any additional terms or conditions. \ No newline at end of file diff --git a/examples/bsp_interior.rs b/examples/bsp_interior.rs index cc7f767..82d4e80 100644 --- a/examples/bsp_interior.rs +++ b/examples/bsp_interior.rs @@ -1,4 +1,4 @@ -use mapgen::*; +use here_be_dragons::*; use rand::prelude::*; fn main() { diff --git a/examples/bsp_rooms.rs b/examples/bsp_rooms.rs index 6c5c7e9..39f3255 100644 --- a/examples/bsp_rooms.rs +++ b/examples/bsp_rooms.rs @@ -1,4 +1,4 @@ -use mapgen::*; +use here_be_dragons::*; use rand::prelude::*; use std::time::{SystemTime, UNIX_EPOCH}; diff --git a/examples/builder_data.rs b/examples/builder_data.rs index 260e04c..d44b65e 100644 --- a/examples/builder_data.rs +++ b/examples/builder_data.rs @@ -1,4 +1,4 @@ -use mapgen::{ +use here_be_dragons::{ filter::{ AreaStartingPosition, CellularAutomata, CullUnreachable, NoiseGenerator, XStart, YStart, }, @@ -16,8 +16,8 @@ impl MapFilter for IncrementData { fn modify_map( &self, _rng: &mut rand::prelude::StdRng, - map: &mapgen::Map, - ) -> mapgen::Map { + map: &here_be_dragons::Map, + ) -> here_be_dragons::Map { let mut map = map.clone(); map.data.value += 1; map diff --git a/examples/example1.rs b/examples/example1.rs index 1721053..d11335b 100644 --- a/examples/example1.rs +++ b/examples/example1.rs @@ -1,4 +1,4 @@ -use mapgen::{ +use here_be_dragons::{ filter::{ AreaStartingPosition, CellularAutomata, CullUnreachable, NoiseGenerator, XStart, YStart, }, diff --git a/src/dijkstra.rs b/src/dijkstra.rs index a1c9d7b..734f8cf 100644 --- a/src/dijkstra.rs +++ b/src/dijkstra.rs @@ -9,7 +9,7 @@ //! --- //! use rand::prelude::*; //! use crate::common::geometry::Point; -//! use mapgen::dungeon::{ +//! use here_be_dragons::dungeon::{ //! MapModifier, //! map::{Map, TileType}, //! starting_point::{AreaStartingPosition, XStart, YStart} diff --git a/src/filter/bsp_interior.rs b/src/filter/bsp_interior.rs index 4968bc0..8a7b504 100644 --- a/src/filter/bsp_interior.rs +++ b/src/filter/bsp_interior.rs @@ -6,8 +6,8 @@ //! Example generator usage: //! ``` //! use rand::prelude::*; -//! use mapgen::{Map, MapFilter, NoData}; -//! use mapgen::filter::{ +//! use here_be_dragons::{Map, MapFilter, NoData}; +//! use here_be_dragons::filter::{ //! BspInterior //! }; //! diff --git a/src/filter/bsp_rooms.rs b/src/filter/bsp_rooms.rs index 1ad479b..0fe4a8b 100644 --- a/src/filter/bsp_rooms.rs +++ b/src/filter/bsp_rooms.rs @@ -6,8 +6,8 @@ //! Example generator usage: //! ``` //! use rand::prelude::*; -//! use mapgen::{Map, MapFilter, NoData}; -//! use mapgen::filter::BspRooms; +//! use here_be_dragons::{Map, MapFilter, NoData}; +//! use here_be_dragons::filter::BspRooms; //! //! let mut rng = StdRng::seed_from_u64(100); //! let gen = BspRooms::::new(); diff --git a/src/filter/cellular_automata.rs b/src/filter/cellular_automata.rs index 8fd430d..8526928 100644 --- a/src/filter/cellular_automata.rs +++ b/src/filter/cellular_automata.rs @@ -9,8 +9,8 @@ //! Example usage: //! ``` //! use rand::prelude::*; -//! use mapgen::{Map, MapFilter, NoData}; -//! use mapgen::filter::CellularAutomata; +//! use here_be_dragons::{Map, MapFilter, NoData}; +//! use here_be_dragons::filter::CellularAutomata; //! //! let mut rng = StdRng::seed_from_u64(100); //! let gen = CellularAutomata::::new(); diff --git a/src/filter/drunkard.rs b/src/filter/drunkard.rs index 6714375..2f72798 100644 --- a/src/filter/drunkard.rs +++ b/src/filter/drunkard.rs @@ -1,8 +1,8 @@ //! Example generator usage: //! ``` //! use rand::prelude::*; -//! use mapgen::{Map, MapFilter, NoData}; -//! use mapgen::filter::DrunkardsWalk; +//! use here_be_dragons::{Map, MapFilter, NoData}; +//! use here_be_dragons::filter::DrunkardsWalk; //! //! let mut rng = StdRng::seed_from_u64(100); //! let gen = DrunkardsWalk::::open_area(); diff --git a/src/filter/maze.rs b/src/filter/maze.rs index 29a55fd..a60ebc0 100644 --- a/src/filter/maze.rs +++ b/src/filter/maze.rs @@ -1,8 +1,8 @@ //! Example generator usage: //! ``` //! use rand::prelude::*; -//! use mapgen::{Map, MapFilter, NoData}; -//! use mapgen::filter::MazeBuilder; +//! use here_be_dragons::{Map, MapFilter, NoData}; +//! use here_be_dragons::filter::MazeBuilder; //! //! let mut rng = StdRng::seed_from_u64(100); //! let gen = MazeBuilder::::new(); diff --git a/src/filter/noise_generator.rs b/src/filter/noise_generator.rs index b6e753a..e430863 100644 --- a/src/filter/noise_generator.rs +++ b/src/filter/noise_generator.rs @@ -4,8 +4,8 @@ //! Example usage: //! ``` //! use rand::prelude::*; -//! use mapgen::{Map, MapFilter, NoData}; -//! use mapgen::filter::NoiseGenerator; +//! use here_be_dragons::{Map, MapFilter, NoData}; +//! use here_be_dragons::filter::NoiseGenerator; //! //! let mut rng = StdRng::seed_from_u64(100); //! let gen = NoiseGenerator::::uniform(); diff --git a/src/filter/simple_rooms.rs b/src/filter/simple_rooms.rs index b8de238..d3504df 100644 --- a/src/filter/simple_rooms.rs +++ b/src/filter/simple_rooms.rs @@ -6,8 +6,8 @@ //! Example generator usage: //! ``` //! use rand::prelude::*; -//! use mapgen::{MapFilter, Map, NoData}; -//! use mapgen::filter::SimpleRooms; +//! use here_be_dragons::{MapFilter, Map, NoData}; +//! use here_be_dragons::filter::SimpleRooms; //! //! let mut rng = StdRng::seed_from_u64(100); //! let gen = SimpleRooms::::new(); diff --git a/src/filter/starting_point.rs b/src/filter/starting_point.rs index d04e643..04a5872 100644 --- a/src/filter/starting_point.rs +++ b/src/filter/starting_point.rs @@ -6,9 +6,9 @@ //! Example modifier usage: //! ``` //! use rand::prelude::*; -//! use mapgen::{MapFilter, Map, NoData, Tile}; -//! use mapgen::filter::starting_point::{AreaStartingPosition, XStart, YStart}; -//! use mapgen::geometry::Point; +//! use here_be_dragons::{MapFilter, Map, NoData, Tile}; +//! use here_be_dragons::filter::starting_point::{AreaStartingPosition, XStart, YStart}; +//! use here_be_dragons::geometry::Point; //! //! let mut rng = StdRng::seed_from_u64(100); //! let mut map = Map::::new(80, 50); diff --git a/src/filter/voronoi.rs b/src/filter/voronoi.rs index 1aa05c9..ced110a 100644 --- a/src/filter/voronoi.rs +++ b/src/filter/voronoi.rs @@ -1,8 +1,8 @@ //! Example generator usage: //! ``` //! use rand::prelude::*; -//! use mapgen::{Map, MapFilter, NoData}; -//! use mapgen::filter::VoronoiHive; +//! use here_be_dragons::{Map, MapFilter, NoData}; +//! use here_be_dragons::filter::VoronoiHive; //! //! let mut rng = StdRng::seed_from_u64(100); //! let gen = VoronoiHive::::new(); diff --git a/src/geometry.rs b/src/geometry.rs index 23686b6..564974d 100644 --- a/src/geometry.rs +++ b/src/geometry.rs @@ -84,7 +84,7 @@ impl Rect { /// Calculate abs value between 2 usize values /// Example: /// ``` -/// use mapgen::geometry::usize_abs; +/// use here_be_dragons::geometry::usize_abs; /// /// assert_eq!(usize_abs(5, 3), 2); /// assert_eq!(usize_abs(3, 5), 2); diff --git a/src/lib.rs b/src/lib.rs index e530894..b82e4dc 100644 --- a/src/lib.rs +++ b/src/lib.rs @@ -8,13 +8,13 @@ //! //! Example //! ``` -//! use mapgen::{MapFilter, MapBuilder, Map, NoData, Tile}; -//! use mapgen::filter::{ +//! use here_be_dragons::{MapFilter, MapBuilder, Map, NoData, Tile}; +//! use here_be_dragons::filter::{ //! NoiseGenerator, //! CellularAutomata, //! starting_point::{AreaStartingPosition, XStart, YStart} //! }; -//! use mapgen::geometry::Point; +//! use here_be_dragons::geometry::Point; //! //! let map = MapBuilder::::new(80, 50) //! .with(NoiseGenerator::uniform())