sceller/lib.rs
1//! SCELLER or Systems Components Entities Lacking List Ekindled in Rust is an ECS crate.
2//!
3//! ## SOURCES
4//! It is modelled from the tutorial series by [Brooks Builds](https://www.youtube.com/channel/UCT1-XRVnJA-wws2bfbLbFcQ) on Youtube and his series on [how to make an ECS in rust](https://www.youtube.com/watch?v=CTuTEi4YUb8&list=PLrmY5pVcnuE_SQSzGPWUJrf9Yo-YNeBYs).
5//!
6//! This project is likely riddled with bugs, and yet I am very proud of it.
7//!
8//! ## HOW TO START
9//! For tips and pointers on how to use SCELLER, check the examples folder, or ask a knowledgeable friend.
10//! Most importantly, have fun!
11//! The '[prelude]' module contains the only modules you will probably ever need.
12//!
13//! If you have any bugs to report or questions, leave 'em on the github friends. If you want me to teach you rust, ask someone who knows rust (maybe that friend we talked about ealier).
14//! If you have a terribly negative review or want to chastise my design choices, leave that on the github too. I recommend you __don't__ check out my other work, because it just isn't very good.
15//! Ok bye.
16//!
17//! Oh, and i forgot to mention something really important about this crate, don't ever ever **ever** forget t
18//!
19
20pub mod resources;
21pub mod world;
22pub mod entities;
23pub mod system;
24
25pub mod prelude {
26 pub use super::resources::*;
27 pub use super::world::*;
28 pub use super::entities::*;
29 pub use super::system::*;
30
31 pub use std::cell::{Ref, RefMut};
32 pub use eyre::Result;
33}
34
35#[cfg(test)]
36mod tests {
37 #[test]
38 fn it_works() {
39 let result = 2 + 2;
40 assert_eq!(result, 4);
41 }
42}