f096ad4155
# Objective Currently the built docs only shows the logo and favicon for the top level `bevy` crate. This makes views like https://docs.rs/bevy_ecs/latest/bevy_ecs/ look potentially unrelated to the project at first glance. ## Solution Reproduce the docs attributes for every crate that Bevy publishes. Ideally this would be done with some workspace level Cargo.toml control, but AFAICT, such support does not exist.
31 lines
1.3 KiB
Rust
31 lines
1.3 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`].
|
|
//!
|
|
//! 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.
|
|
//!
|
|
//! 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::*;
|