Struct DylibLoaderPlugin 

pub struct DylibLoaderPlugin {
    pub extra_paths: Vec<PathBuf>,
    pub include_user_dir: bool,
    pub include_env_dir: bool,
}

Enable discovery and loading of dynamic-library extensions.

With the defaults, the loader scans the per-user config directory (~/.config/jackdaw/extensions/ and platform equivalents) plus $JACKDAW_EXTENSIONS_DIR if set. Call Self::with_extension_search_path to add more locations or Self::with_user_extension_dir / Self::with_extension_env_var to opt out of the defaults.

Dynamic-library extensions require the host binary to be built with bevy/dynamic_linking so the editor and every loaded extension share one copy of Bevy at runtime. Without that, trait-object calls across the dylib boundary are unsound.

Configuration lives on the plugin itself because loading happens during build(), so the loader can reach &mut App to register each discovered dylib into the extension catalog.

Fields

extra_paths: Vec<PathBuf>

Extra search paths added on top of the defaults.

include_user_dir: bool

If true (default), also search the per-user config dir.

include_env_dir: bool

If true (default), also search $JACKDAW_EXTENSIONS_DIR when that env var is set.

Implementations

impl DylibLoaderPlugin

pub fn new() -> DylibLoaderPlugin

pub fn with_extension_search_path( self, path: impl Into<PathBuf>, ) -> DylibLoaderPlugin

Add an explicit search path for the dylib loader. Implicitly enables the loader if it wasn’t already.

pub fn with_extension_env_var(self, enable: bool) -> DylibLoaderPlugin

Opt in or out of honouring $JACKDAW_EXTENSIONS_DIR. Defaults to true when the loader is enabled.

pub fn with_user_extension_dir(self, enable: bool) -> DylibLoaderPlugin

Opt in or out of searching the per-user config directory. Defaults to true when the loader is enabled.

Trait Implementations

impl Default for DylibLoaderPlugin

fn default() -> DylibLoaderPlugin

Returns the “default value” for a type.

impl Plugin for DylibLoaderPlugin

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.