cc69fdd0c6
# Objective - Fixes #15460 (will open new issues for further `no_std` efforts) - Supersedes #17715 ## Solution - Threaded in new features as required - Made certain crates optional but default enabled - Removed `compile-check-no-std` from internal `ci` tool since GitHub CI can now simply check `bevy` itself now - Added CI task to check `bevy` on `thumbv6m-none-eabi` to ensure `portable-atomic` support is still valid [^1] [^1]: This may be controversial, since it could be interpreted as implying Bevy will maintain support for `thumbv6m-none-eabi` going forward. In reality, just like `x86_64-unknown-none`, this is a [canary](https://en.wiktionary.org/wiki/canary_in_a_coal_mine) target to make it clear when `portable-atomic` no longer works as intended (fixing atomic support on atomically challenged platforms). If a PR comes through and makes supporting this class of platforms impossible, then this CI task can be removed. I however wager this won't be a problem. ## Testing - CI --- ## Release Notes Bevy now has support for `no_std` directly from the `bevy` crate. Users can disable default features and enable a new `default_no_std` feature instead, allowing `bevy` to be used in `no_std` applications and libraries. ```toml # Bevy for `no_std` platforms bevy = { version = "0.16", default-features = false, features = ["default_no_std"] } ``` `default_no_std` enables certain required features, such as `libm` and `critical-section`, and as many optional crates as possible (currently just `bevy_state`). For atomically-challenged platforms such as the Raspberry Pi Pico, `portable-atomic` will be used automatically. For library authors, we recommend depending on `bevy` with `default-features = false` to allow `std` and `no_std` users to both depend on your crate. Here are some recommended features a library crate may want to expose: ```toml [features] # Most users will be on a platform which has `std` and can use the more-powerful `async_executor`. default = ["std", "async_executor"] # Features for typical platforms. std = ["bevy/std"] async_executor = ["bevy/async_executor"] # Features for `no_std` platforms. libm = ["bevy/libm"] critical-section = ["bevy/critical-section"] [dependencies] # We disable default features to ensure we don't accidentally enable `std` on `no_std` targets, for example. bevy = { version = "0.16", default-features = false } ``` While this is verbose, it gives the maximum control to end-users to decide how they wish to use Bevy on their platform. We encourage library authors to experiment with `no_std` support. For libraries relying exclusively on `bevy` and no other dependencies, it may be as simple as adding `#![no_std]` to your `lib.rs` and exposing features as above! Bevy can also provide many `std` types, such as `HashMap`, `Mutex`, and `Instant` on all platforms. See `bevy::platform_support` for details on what's available out of the box! ## Migration Guide - If you were previously relying on `bevy` with default features disabled, you may need to enable the `std` and `async_executor` features. - `bevy_reflect` has had its `bevy` feature removed. If you were relying on this feature, simply enable `smallvec` and `smol_str` instead. --------- Co-authored-by: Alice Cecile <alice.i.cecile@gmail.com>
80 lines
2.4 KiB
Rust
80 lines
2.4 KiB
Rust
#![cfg_attr(docsrs, feature(doc_auto_cfg))]
|
|
#![forbid(unsafe_code)]
|
|
#![doc(
|
|
html_logo_url = "https://bevyengine.org/assets/icon.png",
|
|
html_favicon_url = "https://bevyengine.org/assets/icon.png"
|
|
)]
|
|
#![no_std]
|
|
|
|
//! This module is separated into its own crate to enable simple dynamic linking for Bevy, and should not be used directly
|
|
|
|
/// `use bevy::prelude::*;` to import common components, bundles, and plugins.
|
|
pub mod prelude;
|
|
|
|
mod default_plugins;
|
|
pub use default_plugins::*;
|
|
|
|
#[cfg(feature = "bevy_window")]
|
|
pub use bevy_a11y as a11y;
|
|
#[cfg(feature = "bevy_animation")]
|
|
pub use bevy_animation as animation;
|
|
pub use bevy_app as app;
|
|
#[cfg(feature = "bevy_asset")]
|
|
pub use bevy_asset as asset;
|
|
#[cfg(feature = "bevy_audio")]
|
|
pub use bevy_audio as audio;
|
|
#[cfg(feature = "bevy_color")]
|
|
pub use bevy_color as color;
|
|
#[cfg(feature = "bevy_core_pipeline")]
|
|
pub use bevy_core_pipeline as core_pipeline;
|
|
#[cfg(feature = "bevy_dev_tools")]
|
|
pub use bevy_dev_tools as dev_tools;
|
|
pub use bevy_diagnostic as diagnostic;
|
|
pub use bevy_ecs as ecs;
|
|
#[cfg(feature = "bevy_gilrs")]
|
|
pub use bevy_gilrs as gilrs;
|
|
#[cfg(feature = "bevy_gizmos")]
|
|
pub use bevy_gizmos as gizmos;
|
|
#[cfg(feature = "bevy_gltf")]
|
|
pub use bevy_gltf as gltf;
|
|
#[cfg(feature = "bevy_image")]
|
|
pub use bevy_image as image;
|
|
#[cfg(any(feature = "libm", feature = "std"))]
|
|
pub use bevy_input as input;
|
|
#[cfg(feature = "bevy_input_focus")]
|
|
pub use bevy_input_focus as input_focus;
|
|
#[cfg(feature = "bevy_log")]
|
|
pub use bevy_log as log;
|
|
#[cfg(any(feature = "libm", feature = "std"))]
|
|
pub use bevy_math as math;
|
|
#[cfg(feature = "bevy_pbr")]
|
|
pub use bevy_pbr as pbr;
|
|
#[cfg(feature = "bevy_picking")]
|
|
pub use bevy_picking as picking;
|
|
pub use bevy_platform_support as platform_support;
|
|
pub use bevy_ptr as ptr;
|
|
pub use bevy_reflect as reflect;
|
|
#[cfg(feature = "bevy_remote")]
|
|
pub use bevy_remote as remote;
|
|
#[cfg(feature = "bevy_render")]
|
|
pub use bevy_render as render;
|
|
#[cfg(feature = "bevy_scene")]
|
|
pub use bevy_scene as scene;
|
|
#[cfg(feature = "bevy_sprite")]
|
|
pub use bevy_sprite as sprite;
|
|
#[cfg(feature = "bevy_state")]
|
|
pub use bevy_state as state;
|
|
pub use bevy_tasks as tasks;
|
|
#[cfg(feature = "bevy_text")]
|
|
pub use bevy_text as text;
|
|
pub use bevy_time as time;
|
|
#[cfg(any(feature = "libm", feature = "std"))]
|
|
pub use bevy_transform as transform;
|
|
#[cfg(feature = "bevy_ui")]
|
|
pub use bevy_ui as ui;
|
|
pub use bevy_utils as utils;
|
|
#[cfg(feature = "bevy_window")]
|
|
pub use bevy_window as window;
|
|
#[cfg(feature = "bevy_winit")]
|
|
pub use bevy_winit as winit;
|