astrelis 0.2.4

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

//! Asset plugin for loading and managing assets.

use astrelis_assets::{AssetLoader, AssetServer};

use crate::plugin::Plugin;
use crate::resource::Resources;

#[cfg(feature = "text")]
use astrelis_text::FontLoader;

/// Plugin that provides asset loading and management.
///
/// This plugin registers an `AssetServer` resource that can be used
/// to load assets from disk, memory, or raw bytes.
///
/// # Resources Provided
///
/// - `AssetServer` - The main asset loading and caching system
///
/// # Default Loaders
///
/// The plugin registers these loaders by default:
/// - `TextLoader` - Loads `.txt`, `.text`, `.md` files as `String`
/// - `BytesLoader` - Loads `.bin`, `.bytes`, `.dat` files as `Vec<u8>`
/// - `FontLoader` - Loads `.ttf`, `.otf`, `.woff` files as `FontAsset` (with `text` feature)
///
/// # Example
///
/// ```ignore
/// use astrelis::prelude::*;
///
/// let engine = Engine::builder()
///     .add_plugin(AssetPlugin::default())
///     .build();
///
/// let server = engine.get::<AssetServer>().unwrap();
/// let text: Handle<String> = server.load_sync("hello.txt").unwrap();
/// ```
#[derive(Default)]
pub struct AssetPlugin {
    /// Base path for loading assets from disk.
    pub base_path: Option<String>,
}

impl AssetPlugin {
    /// Create a new asset plugin.
    pub fn new() -> Self {
        Self::default()
    }

    /// Set the base path for loading assets.
    pub fn with_base_path(mut self, path: impl Into<String>) -> Self {
        self.base_path = Some(path.into());
        self
    }
}

impl Plugin for AssetPlugin {
    type Dependencies = ();
    fn name(&self) -> &'static str {
        "AssetPlugin"
    }

    fn build(&self, resources: &mut Resources) {
        // Create the asset server
        let mut server = match &self.base_path {
            Some(path) => AssetServer::with_base_path(path),
            None => AssetServer::new(),
        };

        // Register default loaders
        server.register_loader(astrelis_assets::TextLoader);
        server.register_loader(astrelis_assets::BytesLoader);

        // Register font loader if text feature is enabled
        #[cfg(feature = "text")]
        server.register_loader(FontLoader);

        tracing::debug!("AssetPlugin: Registered default loaders");

        resources.insert(server);
    }
}

/// Extension trait for easily registering loaders with the engine.
#[allow(dead_code)]
pub trait AssetServerExt {
    /// Register an asset loader with the asset server.
    fn register_loader<L: AssetLoader>(&mut self, loader: L)
    where
        L::Asset: astrelis_assets::Asset;
}

impl AssetServerExt for crate::Engine {
    fn register_loader<L: AssetLoader>(&mut self, loader: L)
    where
        L::Asset: astrelis_assets::Asset,
    {
        if let Some(server) = self.get_mut::<AssetServer>() {
            server.register_loader(loader);
        } else {
            tracing::warn!("AssetServer not found - is AssetPlugin added?");
        }
    }
}

#[cfg(test)]
mod tests {
    use super::*;
    use crate::EngineBuilder;

    #[test]
    fn test_asset_plugin_registers_server() {
        let engine = EngineBuilder::new()
            .add_plugin(AssetPlugin::default())
            .build();

        assert!(engine.get::<AssetServer>().is_some());
    }

    #[test]
    fn test_asset_plugin_with_base_path() {
        let engine = EngineBuilder::new()
            .add_plugin(AssetPlugin::new().with_base_path("assets"))
            .build();

        assert!(engine.get::<AssetServer>().is_some());
    }

    #[test]
    fn test_default_loaders_registered() {
        let engine = EngineBuilder::new()
            .add_plugin(AssetPlugin::default())
            .build();

        let server = engine.get::<AssetServer>().unwrap();

        // Check that text loader is registered
        assert!(server.has_loader_for::<String>("txt"));
        assert!(server.has_loader_for::<Vec<u8>>("bin"));
    }
}