Struct BevyCachePlugin 

pub struct BevyCachePlugin {
    pub config: CacheConfig,
}

Plugin that registers the file cache system.

Registers a "cache" asset source that maps to the OS cache directory. Any Bevy asset type can be loaded from the cache using the cache:// scheme; Bevy’s built-in loaders handle the file based on its real extension.

Must be added before DefaultPlugins so that the asset source is available when AssetPlugin initialises.

The plugin automatically registers the cache directory with Bevy’s AssetPlugin using platform_default, so if you enable file watching in AssetPlugin the cache directory is watched alongside the normal assets folder — no extra configuration required:

App::new()
    .add_plugins(BevyCachePlugin::new("my_game"))
    .add_plugins(DefaultPlugins.set(AssetPlugin {
        watch_for_changes_override: Some(true),
        ..default()
    }))
    .run();

Without a watch_for_changes_override the cache source is still registered and accessible via cache://; watching is just disabled.

Hot-reloading the manifest

Enable the hot_reload Cargo feature to additionally watch the manifest.cache_manifest file itself and have CacheManifest re-synced automatically when it changes on disk.

After adding the plugin, use CacheManifest to store and query cached assets, and CacheQueue to enqueue asset handles for deferred caching:

fn cache_screenshot(mut cache: Cache) {
    let png_data: Vec<u8> = render_my_screenshot();
    cache.store("scene_01", "png", std::io::Cursor::new(png_data), None)
        .expect("cache write failed");
}

fn cache_asset_by_handle(
    mut pending: ResMut<CacheQueue>,
    assets: Res<Assets<MyAsset>>,
    handle: Res<MyAssetHandle>,
) {
    if let Some(asset) = assets.get(&handle.0) {
        // Reflect-based: serialized to RON via ReflectSerializer
        pending.enqueue_reflect(
            Box::new(asset.clone()),
            "my_asset_key",
            "ron",
            None,
        );
    }
}

fn load_cached(mut cache: Cache, asset_server: Res<AssetServer>) {
    if let Some(path) = cache.asset_path("scene_01") {
        // Bevy detects ".png" and uses ImageLoader automatically.
        let handle: Handle<Image> = asset_server.load(path);
    }
}

Fields

config: CacheConfig

Implementations

impl BevyCachePlugin

pub fn new(app_name: &str) -> Self

Trait Implementations

impl Default for BevyCachePlugin

fn default() -> BevyCachePlugin

Returns the “default value” for a type.

impl Plugin for BevyCachePlugin

fn build(&self, app: &mut App)

Configures the App to which this plugin is added.

fn ready(&self, _app: &App) -> bool

Has the plugin finished its setup? This can be useful for plugins that need something asynchronous to happen before they can finish their setup, like the initialization of a renderer. Once the plugin is ready, finish should be called.

fn finish(&self, _app: &mut App)

Finish adding this plugin to the App, once all plugins registered are ready. This can be useful for plugins that depends on another plugin asynchronous setup, like the renderer.

fn cleanup(&self, _app: &mut App)

Runs after all plugins are built and finished, but before the app schedule is executed. This can be useful if you have some resource that other plugins need during their build step, but after build you want to remove it and send it to another thread.

fn name(&self) -> &str

Configures a name for the Plugin which is primarily used for checking plugin uniqueness and debugging.

fn is_unique(&self) -> bool

If the plugin can be meaningfully instantiated several times in an App, override this method to return false.