2940636e0a
# Objective - The current implementation for dynamic plugins is unsound. Please see #11969 for background and justification. - Closes #11969 and closes #13073. ## Solution - Deprecate all dynamic plugin items for Bevy 0.14, with plans to remove them for Bevy 0.15. ## Discussion One thing I want to make clear is that I'm not opposed to dynamic plugins _in general_. I think they can be handy, especially for DLC and modding, but I think the current system is the wrong approach. It's too much of a footgun for the meager benefit is provides. --- ## Changelog - Deprecated the current dynamic plugin system. - Dynamic plugins will be removed in Bevy 0.15. For now you can continue using them by marking your code with `#[allow(deprecated)]`. ## Migration Guide If possible, remove all usage of dynamic plugins. ```rust // Old #[derive(DynamicPlugin)] pub struct MyPlugin; App::new() .load_plugin("path/to/plugin") .run(); // New pub struct MyPlugin; App::new() .add_plugins(MyPlugin) .run(); ``` If you are unable to do that, you may temporarily silence the deprecation warnings. ```rust #[allow(deprecated)] ``` Please note that the current dynamic plugin system will be removed by the next major Bevy release, so you will have to migrate eventually. You may be interested in these safer alternatives: - [Bevy Assets - Scripting]: Scripting and modding libraries for Bevy - [Bevy Assets - Development tools]: Hot reloading and other development functionality - [`stabby`]: Stable Rust ABI [Bevy Assets - Scripting]: https://bevyengine.org/assets/#scripting [Bevy Assets - Development tools]: https://bevyengine.org/assets/#development-tools [`stabby`]: https://github.com/ZettaScaleLabs/stabby
42 lines
1.7 KiB
Rust
42 lines
1.7 KiB
Rust
#![cfg_attr(docsrs, feature(doc_auto_cfg))]
|
|
#![doc(
|
|
html_logo_url = "https://bevyengine.org/assets/icon.png",
|
|
html_favicon_url = "https://bevyengine.org/assets/icon.png"
|
|
)]
|
|
|
|
//! Bevy's dynamic plugin loading functionality.
|
|
//!
|
|
//! This crate allows loading dynamic libraries (`.dylib`, `.so`) that export a single
|
|
//! [`Plugin`](bevy_app::Plugin). For usage, see [`dynamically_load_plugin`].
|
|
//!
|
|
//! # Deprecation
|
|
//!
|
|
//! The current dynamic plugin system is unsound and will be removed in 0.15. You may be interested
|
|
//! in the [Alternatives](#alternatives) listed below. If your use-case is not supported, please
|
|
//! consider commenting on [#13080](https://github.com/bevyengine/bevy/pull/13080) describing how
|
|
//! you use dynamic plugins in your project.
|
|
//!
|
|
//! # Warning
|
|
//!
|
|
//! Note that dynamic linking and loading is inherently unsafe because it allows executing foreign
|
|
//! code. Additionally, Rust does not have a stable ABI and may produce
|
|
//! incompatible libraries across Rust versions, or even subsequent compilations. This will not work
|
|
//! well in scenarios such as modding, but can work if the dynamic plugins and the main app are
|
|
//! built at the same time, such as with Downloadable Content (DLC) packs.
|
|
//!
|
|
//! # Alternatives
|
|
//!
|
|
//! You may be interested in these safer alternatives:
|
|
//!
|
|
//! - [Bevy Assets - Scripting]: Scripting and modding libraries for Bevy
|
|
//! - [Bevy Assets - Development tools]: Hot reloading and other development functionality
|
|
//! - [`stabby`]: Stable Rust ABI
|
|
//!
|
|
//! [Bevy Assets - Scripting]: https://bevyengine.org/assets/#scripting
|
|
//! [Bevy Assets - Development tools]: https://bevyengine.org/assets/#development-tools
|
|
//! [`stabby`]: https://github.com/ZettaScaleLabs/stabby
|
|
|
|
mod loader;
|
|
|
|
pub use loader::*;
|