bracket_lib/
lib.rs

1//! bracket-lib is a wrapper of the bracket- set of crates designed initally
2//! for roguelike development (as RLTK) and later transitioned into a general
3//! use crate.
4
5/// prelude
6pub mod prelude {
7    pub use bracket_algorithm_traits::prelude::*;
8    pub use bracket_color::prelude::*;
9    pub use bracket_geometry::prelude::*;
10    pub use bracket_noise::prelude::*;
11    pub use bracket_pathfinding::prelude::*;
12    pub use bracket_random::prelude::*;
13    pub use bracket_terminal::prelude::*;
14    pub use bracket_terminal::{add_wasm_support, embedded_resource, link_resource};
15}
16
17/// bracket-algorithm-traits provides traits for use in the bracket-pathfinding
18/// and bracket-geometry
19pub mod algorithm_traits {
20    pub use bracket_algorithm_traits::prelude::*;
21}
22
23/// bracket-color provides a color system for use in the bracket-terminal
24pub mod color {
25    pub use bracket_color::prelude::*;
26}
27/// bracket-geometry provides some geometric primitives (Point, Point3D, Rect),
28/// support functions and distance calculations. It also includes Bresenham's
29/// line algorithm, a vector line algorithm, and Bresenham's Circle algorithm.
30pub mod geometry {
31    pub use bracket_geometry::prelude::*;
32}
33
34/// bracket-noise covers all the commonly used types of noise,
35pub mod noise {
36    pub use bracket_noise::prelude::*;
37}
38/// bracket-pathfinding (in conjunction with bracket-algorithm-traits) provides
39/// pathfinding functionality. A-Star (A*) and Dijkstra are supported. It also
40// provides field of view (FOV) functionality.
41pub mod pathfinding {
42    pub use bracket_pathfinding::prelude::*;
43}
44
45/// bracket-random provides a dice-oriented random number generation
46pub mod random {
47    pub use bracket_random::prelude::*;
48}
49
50/// bracket-terminal provides a virtual ASCII/Codepage-437 terminal (with
51/// optional tile graphic support and layers), and a game loop
52pub mod terminal {
53    pub use bracket_terminal::prelude::*;
54}