furmint-runtime 0.1.0

Main package of furmint game engine providing higher level API
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28

//! # `furmint-runtime`
//! The furmint engine's runtime module, which basically serves as the main entry point into the application (game).
//! Runtime contains only essential pieces: an ECS, time management (ticks), scene management.
//! It "glues" together everything else, you name it: renderer, tiles, sprites, animations, maybe some RPG-like systems.
//!
//! Previously this was called `furmint-engine`, but it's not the actual engine, because the actual engine is a combination
//! of all crates and plugins. "Runtime" is the best word to describe this crate.
#![warn(missing_docs)]

/// Application layer module
pub mod app;
pub mod error;
pub mod events;
pub mod plugins;
/// Module providing functionality of scenes
pub mod scenes;
#[cfg(test)]
mod tests;
/// Module providing time (tick) functionality
pub mod time;

/// Prelude module
pub mod prelude {
    pub use crate::app::{App, AppBuilder};
    pub use furmint_registry::ComponentFactory;
    pub use furmint_registry::ComponentRegistry;
    pub use furmint_registry::impl_component_factory;
}