dungen_minion 0.3.2

#![warn(missing_docs)]
#![warn(rustdoc::missing_doc_code_examples)]
#![warn(clippy::all, clippy::pedantic)]
#![cfg_attr(feature = "strict", deny(warnings))]

//! A dungeon generation library focused on 2D roguelikes.
//!
//! `dungen_minion` is in the very early release stage, with most features being new or unstable.
//! It is not (yet!) recommend for general use, although you can test it if you're feeling really
//! adventurous.
//!
//! ```
//! use dungen_minion::geometry::*;
//! use dungen_minion::*;
//! // Create a dungeon generator using SparseMap.
//! // SparseMap is expandable, and has no explicit size restrictions.
//! let map_id = DunGen::new(SparseMap::new())
//!     // Expand the map to a width of 40, and a height of 30.
//!     .gen_with(&EmptyRoomGenerator::new(Size::new(40, 30)))
//!     // TileType::Floor will be placed.
//!     // You may also give it a SizeRange to generate a randomly-sized map.
//!     // .gen_with(EmptyRoomGenerator::new(SizeRange::new(Size::new(24, 18), Size::new(40, 30))))
//!     // Create walls for the map.
//!     .gen_with(&WalledRoomGenerator::new(Size::zero()))
//!     .build();
//!
//! let maps = MAPS.read();
//! let map = maps[map_id].read();
//!
//! // A simple drawing routine.
//! for y in 0..map.size().height() {
//!     for x in 0..map.size().width() {
//!         let tile_type = map.tile_type_at_local(Position::new(x as i32, y as i32));
//!
//!         // The selection of tiles is deliberately limited, for now.
//!         // Theming is included in future plans for dungen_minion.
//!         let ch = match tile_type {
//!             Some(TileType::Void) => ' ',
//!             Some(TileType::Floor) => '.',
//!             Some(TileType::Wall) => '#',
//!             Some(TileType::Portal) => '+',
//!             None => ' ',
//!         };
//!
//!         print!("{}", ch);
//!     }
//!     println!();
//! }
//! ```
// External includes.
pub use dungen_minion_rooms::*;

// Standard includes.

// Internal includes.
mod dun_gen;
mod edge_portals_generator;
mod empty_room_generator;
mod fill_tiles_generator;
mod if_map_then_generator;
mod merge_portal_maps_as_sub_maps_generator;
mod reciprocate_portals_generator;
mod sequential_generator;
mod sub_map_generator;
mod traverse_portals_generator;
mod traverse_this_and_portals_generator;
mod walled_room_generator;

pub use dun_gen::DunGen;
pub use edge_portals_generator::EdgePortalsGenerator;
pub use empty_room_generator::EmptyRoomGenerator;
pub use fill_tiles_generator::FillTilesGenerator;
pub use if_map_then_generator::IfMapThenGenerator;
pub use merge_portal_maps_as_sub_maps_generator::MergePortalMapsAsSubMapsGenerator;
pub use reciprocate_portals_generator::ReciprocatePortalsGenerator;
pub use sequential_generator::SequentialGenerator;
pub use sub_map_generator::{SubMapGenerator, SubMapGeneratorSet};
pub use traverse_portals_generator::TraversePortalsGenerator;
pub use traverse_this_and_portals_generator::TraverseThisAndPortalsGenerator;
pub use walled_room_generator::WalledRoomGenerator;

#[cfg(test)]
mod tests {
    #[test]
    fn it_works() {
        assert_eq!(2 + 2, 4);
    }
}