astrelis 0.0.1

A modular 2D/3D game engine framework
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
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166

//! Astrelis - A modular game engine
//!
//! Astrelis is a Rust game engine built around a flexible plugin system.
//! It provides core functionality for game development including:
//!
//! - **Plugin System**: Extensible architecture for adding features
//! - **Asset Management**: Type-safe asset loading and caching
//! - **Rendering**: GPU-accelerated rendering with wgpu
//! - **Text Rendering**: High-quality text with cosmic-text
//! - **Input Handling**: Keyboard, mouse, and gamepad input
//! - **Windowing**: Cross-platform window management
//!
//! # Quick Start
//!
//! ```ignore
//! use astrelis::prelude::*;
//!
//! struct MyGame {
//!     engine: Engine,
//! }
//!
//! impl App for MyGame {
//!     fn render(&mut self, ctx: &mut AppCtx, window_id: WindowId, events: &mut EventBatch) {
//!         // Game logic here
//!     }
//! }
//!
//! fn main() {
//!     run_app(|ctx| {
//!         let window = ctx.create_window(WindowDescriptor::default()).unwrap();
//!         
//!         let engine = Engine::new()
//!             .add_plugin(AssetPlugin)
//!             .add_plugin(RenderPlugin)
//!             .build();
//!
//!         Box::new(MyGame { engine })
//!     });
//! }
//! ```
//!
//! # Architecture
//!
//! The engine is built around the `Plugin` trait, which allows adding
//! functionality in a modular way. Plugins can:
//!
//! - Register resources with the engine
//! - Hook into the update and render lifecycle
//! - Depend on other plugins
//!
//! # Default Plugins
//!
//! - `AssetPlugin` - Asset loading and management
//! - `RenderPlugin` - Graphics context and rendering (requires window)
//! - `TextPlugin` - Text rendering capabilities
//! - `InputPlugin` - Input state management

pub mod engine;
pub mod plugin;
pub mod resource;

#[cfg(feature = "assets")]
pub mod plugins;

// Re-export core types
pub use astrelis_core as core;
pub use astrelis_core::math;

// Re-export sub-crates based on features
#[cfg(feature = "winit")]
pub use astrelis_winit as winit;
#[cfg(feature = "winit")]
pub use astrelis_winit::{
    app::{run_app, App, AppCtx, AppFactory},
    event::{Event, EventBatch, HandleStatus},
    window::{Window, WindowDescriptor},
    WindowId,
};

#[cfg(feature = "assets")]
pub use astrelis_assets as assets;

#[cfg(feature = "render")]
pub use astrelis_render as render;

#[cfg(feature = "text")]
pub use astrelis_text as text;

#[cfg(feature = "input")]
pub use astrelis_input as input;

#[cfg(feature = "ui")]
pub use astrelis_ui as ui;

#[cfg(feature = "egui")]
pub use astrelis_egui as egui;

#[cfg(feature = "audio")]
pub use astrelis_audio as audio;

// Re-export engine types
pub use engine::{Engine, EngineBuilder};
pub use plugin::{Plugin, FnPlugin, PluginGroup};
pub use resource::{Resource, Resources};

// Re-export plugin types when available
#[cfg(feature = "assets")]
pub use plugins::AssetPlugin;

#[cfg(all(feature = "render", feature = "winit"))]
pub use plugins::{RenderPlugin, RenderContexts};

#[cfg(feature = "text")]
pub use plugins::TextPlugin;

#[cfg(feature = "input")]
pub use plugins::InputPlugin;

#[cfg(feature = "assets")]
pub use plugins::{DefaultPlugins, MinimalPlugins};

/// Prelude module for convenient imports
pub mod prelude {
    pub use crate::engine::{Engine, EngineBuilder};
    pub use crate::plugin::{Plugin, FnPlugin};
    pub use crate::resource::{Resource, Resources};

    // Core math types
    pub use astrelis_core::math::{Mat4, Vec2, Vec3, Vec4};

    // Winit types
    #[cfg(feature = "winit")]
    pub use astrelis_winit::{
        app::{run_app, App, AppCtx},
        event::{Event, EventBatch, HandleStatus},
        window::{Window, WindowDescriptor},
        WindowId,
    };

    // Asset types
    #[cfg(feature = "assets")]
    pub use astrelis_assets::{Asset, AssetEvent, AssetLoader, AssetServer, AssetSource, Handle};

    // Render types
    #[cfg(feature = "render")]
    pub use astrelis_render::{
        Color, ComputePassBuilder, FrameContext, GraphicsContext, RenderPassBuilder, WindowContext,
    };

    // Text types
    #[cfg(feature = "text")]
    pub use astrelis_text::{FontRenderer, FontSystem, Text, TextAlign};

    // Plugin types
    #[cfg(feature = "assets")]
    pub use crate::plugins::{AssetPlugin, DefaultPlugins, MinimalPlugins};

    #[cfg(all(feature = "render", feature = "winit"))]
    pub use crate::plugins::{RenderPlugin, RenderContexts};

    #[cfg(feature = "input")]
    pub use crate::plugins::InputPlugin;

    #[cfg(feature = "text")]
    pub use crate::plugins::TextPlugin;
}