Merge branch 'main' into fix-conflict-volumetric-fog

.github/workflows/ci.yml

@@ -218,7 +218,7 @@ jobs:
  steps:
  - uses: actions/checkout@v4
  - name: Check for typos
- uses: crate-ci/typos@v1.20.10
+ uses: crate-ci/typos@v1.21.0
  - name: Typos info
  if: failure()
  run: |

.github/workflows/docs.yml

@@ -27,6 +27,9 @@ concurrency:
 jobs:
  build-and-deploy:
  runs-on: ubuntu-latest
+ # Only run this job when on the main Bevy repository. Without this, it would also run on forks
+ # where developers work on the main branch but have not enabled Github Pages.
+ if: ${{ github.repository == 'bevyengine/bevy' }}
  environment:
  name: github-pages
  url: ${{ steps.deployment.outputs.page_url }}

Cargo.toml

@@ -55,6 +55,7 @@ workspace = true
 default = [
  "animation",
  "bevy_asset",
+ "bevy_state",
  "bevy_audio",
  "bevy_color",
  "bevy_gilrs",
@@ -67,7 +68,7 @@ default = [
  "bevy_sprite",
  "bevy_text",
  "bevy_ui",
- "multi-threaded",
+ "multi_threaded",
  "png",
  "hdr",
  "vorbis",
@@ -252,7 +253,7 @@ symphonia-wav = ["bevy_internal/symphonia-wav"]
 serialize = ["bevy_internal/serialize"]
 
 # Enables multithreaded parallelism in the engine. Disabling it forces all engine tasks to run on a single thread.
-multi-threaded = ["bevy_internal/multi-threaded"]
+multi_threaded = ["bevy_internal/multi_threaded"]
 
 # Use async-io's implementation of block_on instead of futures-lite's implementation. This is preferred if your application uses async-io.
 async-io = ["bevy_internal/async-io"]
@@ -334,6 +335,9 @@ meshlet_processor = ["bevy_internal/meshlet_processor"]
 # Enable support for the ios_simulator by downgrading some rendering capabilities
 ios_simulator = ["bevy_internal/ios_simulator"]
 
+# Enable built in global state machines
+bevy_state = ["bevy_internal/bevy_state"]
+
 [dependencies]
 bevy_internal = { path = "crates/bevy_internal", version = "0.14.0-dev", default-features = false }
 
@@ -1274,6 +1278,17 @@ description = "An application that runs with default plugins and displays an emp
 category = "Application"
 wasm = false
 
+[[example]]
+name = "headless_renderer"
+path = "examples/app/headless_renderer.rs"
+doc-scrape-examples = true
+
+[package.metadata.example.headless_renderer]
+name = "Headless Renderer"
+description = "An application that runs with no window, but renders into image file"
+category = "Application"
+wasm = false
+
 [[example]]
 name = "without_winit"
 path = "examples/app/without_winit.rs"
@@ -1718,35 +1733,35 @@ wasm = false
 
 [[example]]
 name = "state"
-path = "examples/ecs/state.rs"
+path = "examples/state/state.rs"
 doc-scrape-examples = true
 
 [package.metadata.example.state]
 name = "State"
 description = "Illustrates how to use States to control transitioning from a Menu state to an InGame state"
-category = "ECS (Entity Component System)"
+category = "State"
 wasm = false
 
 [[example]]
 name = "sub_states"
-path = "examples/ecs/sub_states.rs"
+path = "examples/state/sub_states.rs"
 doc-scrape-examples = true
 
 [package.metadata.example.sub_states]
 name = "Sub States"
 description = "Using Sub States for hierarchical state handling."
-category = "ECS (Entity Component System)"
+category = "State"
 wasm = false
 
 [[example]]
 name = "computed_states"
-path = "examples/ecs/computed_states.rs"
+path = "examples/state/computed_states.rs"
 doc-scrape-examples = true
 
 [package.metadata.example.computed_states]
 name = "Computed States"
 description = "Advanced state patterns using Computed States"
-category = "ECS (Entity Component System)"
+category = "State"
 wasm = false
 
 [[example]]

benches/Cargo.toml

@@ -11,7 +11,7 @@ rand = "0.8"
 rand_chacha = "0.3"
 criterion = { version = "0.3", features = ["html_reports"] }
 bevy_app = { path = "../crates/bevy_app" }
-bevy_ecs = { path = "../crates/bevy_ecs", features = ["multi-threaded"] }
+bevy_ecs = { path = "../crates/bevy_ecs", features = ["multi_threaded"] }
 bevy_reflect = { path = "../crates/bevy_reflect" }
 bevy_tasks = { path = "../crates/bevy_tasks" }
 bevy_utils = { path = "../crates/bevy_utils" }

crates/bevy_animation/src/animatable.rs

@@ -1,5 +1,5 @@
 use crate::util;
-use bevy_color::{ClampColor, Laba, LinearRgba, Oklaba, Srgba, Xyza};
+use bevy_color::{Laba, LinearRgba, Oklaba, Srgba, Xyza};
 use bevy_ecs::world::World;
 use bevy_math::*;
 use bevy_reflect::Reflect;
@@ -63,7 +63,7 @@ macro_rules! impl_color_animatable {
  #[inline]
  fn interpolate(a: &Self, b: &Self, t: f32) -> Self {
  let value = *a * (1. - t) + *b * t;
- value.clamped()
+ value
  }
 
  #[inline]
@@ -76,7 +76,7 @@ macro_rules! impl_color_animatable {
  value = Self::interpolate(&value, &input.value, input.weight);
  }
  }
- value.clamped()
+ value
  }
  }
  };

crates/bevy_app/Cargo.toml

@@ -11,9 +11,10 @@ keywords = ["bevy"]
 [features]
 trace = []
 bevy_debug_stepping = []
-default = ["bevy_reflect"]
+default = ["bevy_reflect", "bevy_state"]
 bevy_reflect = ["dep:bevy_reflect", "bevy_ecs/bevy_reflect"]
 serialize = ["bevy_ecs/serde"]
+bevy_state = ["dep:bevy_state"]
 
 [dependencies]
 # bevy
@@ -22,6 +23,7 @@ bevy_ecs = { path = "../bevy_ecs", version = "0.14.0-dev", default-features = fa
 bevy_reflect = { path = "../bevy_reflect", version = "0.14.0-dev", optional = true }
 bevy_utils = { path = "../bevy_utils", version = "0.14.0-dev" }
 bevy_tasks = { path = "../bevy_tasks", version = "0.14.0-dev" }
+bevy_state = { path = "../bevy_state", optional = true, version = "0.14.0-dev" }
 
 # other
 serde = { version = "1.0", features = ["derive"], optional = true }

crates/bevy_app/src/app.rs

@@ -7,9 +7,11 @@ use bevy_ecs::{
  event::{event_update_system, ManualEventReader},
  intern::Interned,
  prelude::*,
- schedule::{FreelyMutableState, ScheduleBuildSettings, ScheduleLabel},
+ schedule::{ScheduleBuildSettings, ScheduleLabel},
  system::SystemId,
 };
+#[cfg(feature = "bevy_state")]
+use bevy_state::{prelude::*, state::FreelyMutableState};
 #[cfg(feature = "trace")]
 use bevy_utils::tracing::info_span;
 use bevy_utils::{tracing::debug, HashMap};
@@ -264,6 +266,7 @@ impl App {
  self.sub_apps.iter().any(|s| s.is_building_plugins())
  }
 
+ #[cfg(feature = "bevy_state")]
  /// Initializes a [`State`] with standard starting values.
  ///
  /// This method is idempotent: it has no effect when called again using the same generic type.
@@ -281,6 +284,7 @@ impl App {
  self
  }
 
+ #[cfg(feature = "bevy_state")]
  /// Inserts a specific [`State`] to the current [`App`] and overrides any [`State`] previously
  /// added of the same type.
  ///
@@ -297,23 +301,19 @@ impl App {
  self
  }
 
+ #[cfg(feature = "bevy_state")]
  /// Sets up a type implementing [`ComputedStates`].
  ///
  /// This method is idempotent: it has no effect when called again using the same generic type.
- ///
- /// For each source state the derived state depends on, it adds this state's derivation
- /// to it's [`ComputeDependantStates<Source>`](bevy_ecs::schedule::ComputeDependantStates<S>) schedule.
  pub fn add_computed_state<S: ComputedStates>(&mut self) -> &mut Self {
  self.main_mut().add_computed_state::<S>();
  self
  }
 
+ #[cfg(feature = "bevy_state")]
  /// Sets up a type implementing [`SubStates`].
  ///
  /// This method is idempotent: it has no effect when called again using the same generic type.
- ///
- /// For each source state the derived state depends on, it adds this state's existence check
- /// to it's [`ComputeDependantStates<Source>`](bevy_ecs::schedule::ComputeDependantStates<S>) schedule.
  pub fn add_sub_state<S: SubStates>(&mut self) -> &mut Self {
  self.main_mut().add_sub_state::<S>();
  self
@@ -983,10 +983,7 @@ impl Termination for AppExit {
 mod tests {
  use std::{marker::PhantomData, mem};
 
- use bevy_ecs::{
- schedule::{OnEnter, States},
- system::Commands,
- };
+ use bevy_ecs::{schedule::ScheduleLabel, system::Commands};
 
  use crate::{App, AppExit, Plugin};
 
@@ -1059,11 +1056,9 @@ mod tests {
  App::new().add_plugins(PluginRun);
  }
 
- #[derive(States, PartialEq, Eq, Debug, Default, Hash, Clone)]
- enum AppState {
- #[default]
- MainMenu,
- }
+ #[derive(ScheduleLabel, Hash, Clone, PartialEq, Eq, Debug)]
+ struct EnterMainMenu;
+
  fn bar(mut commands: Commands) {
  commands.spawn_empty();
  }
@@ -1075,20 +1070,9 @@ mod tests {
  #[test]
  fn add_systems_should_create_schedule_if_it_does_not_exist() {
  let mut app = App::new();
- app.init_state::<AppState>()
- .add_systems(OnEnter(AppState::MainMenu), (foo, bar));
-
- app.world_mut().run_schedule(OnEnter(AppState::MainMenu));
- assert_eq!(app.world().entities().len(), 2);
- }
-
- #[test]
- fn add_systems_should_create_schedule_if_it_does_not_exist2() {
- let mut app = App::new();
- app.add_systems(OnEnter(AppState::MainMenu), (foo, bar))
- .init_state::<AppState>();
+ app.add_systems(EnterMainMenu, (foo, bar));
 
- app.world_mut().run_schedule(OnEnter(AppState::MainMenu));
+ app.world_mut().run_schedule(EnterMainMenu);
  assert_eq!(app.world().entities().len(), 2);
  }
 

crates/bevy_app/src/main_schedule.rs

@@ -1,9 +1,11 @@
 use crate::{App, Plugin};
 use bevy_ecs::{
- schedule::{ExecutorKind, InternedScheduleLabel, Schedule, ScheduleLabel, StateTransition},
+ schedule::{ExecutorKind, InternedScheduleLabel, Schedule, ScheduleLabel},
  system::{Local, Resource},
  world::{Mut, World},
 };
+#[cfg(feature = "bevy_state")]
+use bevy_state::state::StateTransition;
 
 /// The schedule that contains the app logic that is evaluated each tick of [`App::update()`].
 ///

crates/bevy_app/src/sub_app.rs

@@ -2,12 +2,15 @@ use crate::{App, InternedAppLabel, Plugin, Plugins, PluginsState, Startup};
 use bevy_ecs::{
  event::EventRegistry,
  prelude::*,
- schedule::{
- setup_state_transitions_in_world, FreelyMutableState, InternedScheduleLabel,
- ScheduleBuildSettings, ScheduleLabel,
- },
+ schedule::{InternedScheduleLabel, ScheduleBuildSettings, ScheduleLabel},
  system::SystemId,
 };
+#[cfg(feature = "bevy_state")]
+use bevy_state::{
+ prelude::*,
+ state::{setup_state_transitions_in_world, FreelyMutableState},
+};
+
 #[cfg(feature = "trace")]
 use bevy_utils::tracing::info_span;
 use bevy_utils::{HashMap, HashSet};
@@ -295,6 +298,7 @@ impl SubApp {
  self
  }
 
+ #[cfg(feature = "bevy_state")]
  /// See [`App::init_state`].
  pub fn init_state<S: FreelyMutableState + FromWorld>(&mut self) -> &mut Self {
  if !self.world.contains_resource::<State<S>>() {
@@ -309,6 +313,7 @@ impl SubApp {
  self
  }
 
+ #[cfg(feature = "bevy_state")]
  /// See [`App::insert_state`].
  pub fn insert_state<S: FreelyMutableState>(&mut self, state: S) -> &mut Self {
  if !self.world.contains_resource::<State<S>>() {
@@ -324,6 +329,7 @@ impl SubApp {
  self
  }
 
+ #[cfg(feature = "bevy_state")]
  /// See [`App::add_computed_state`].
  pub fn add_computed_state<S: ComputedStates>(&mut self) -> &mut Self {
  if !self
@@ -339,6 +345,7 @@ impl SubApp {
  self
  }
 
+ #[cfg(feature = "bevy_state")]
  /// See [`App::add_sub_state`].
  pub fn add_sub_state<S: SubStates>(&mut self) -> &mut Self {
  if !self

crates/bevy_asset/Cargo.toml

@@ -13,7 +13,7 @@ keywords = ["bevy"]
 [features]
 file_watcher = ["notify-debouncer-full", "watch"]
 embedded_watcher = ["file_watcher"]
-multi-threaded = ["bevy_tasks/multi-threaded"]
+multi_threaded = ["bevy_tasks/multi_threaded"]
 asset_processor = []
 watch = []
 trace = []

crates/bevy_asset/src/io/file/mod.rs

@@ -1,9 +1,9 @@
 #[cfg(feature = "file_watcher")]
 mod file_watcher;
 
-#[cfg(feature = "multi-threaded")]
+#[cfg(feature = "multi_threaded")]
 mod file_asset;
-#[cfg(not(feature = "multi-threaded"))]
+#[cfg(not(feature = "multi_threaded"))]
 mod sync_file_asset;
 
 use bevy_utils::tracing::error;