Merge branch 'main' into set-if-differs

Author: alice-i-cecile

.github/workflows/ci.yml

@@ -9,7 +9,7 @@ on:
 
 env:
   CARGO_TERM_COLOR: always
-  NIGHTLY_TOOLCHAIN: nightly-2022-07-13
+  NIGHTLY_TOOLCHAIN: nightly
 
 jobs:
   build:

CONTRIBUTING.md

@@ -119,6 +119,8 @@ PRs are controversial if there is serious design discussion required, or a large
 7. Large-scale code reorganization.
 8. High levels of technical complexity.
 9. Adding a dependency.
+10. Touching licensing information (due to the level of precision required).
+11. Adding root-level files (due to the high level of visibility).
 
 Finally, changes are "relatively uncontroversial" if they are neither trivial or controversial.
 Most PRs should fall into this category.

Cargo.toml

@@ -26,8 +26,10 @@ members = [
 [features]
 default = [
   "animation",
+  "bevy_asset",
   "bevy_audio",
   "bevy_gilrs",
+  "bevy_scene",
   "bevy_winit",
   "render",
   "png",
@@ -53,13 +55,15 @@ render = [
 
 # Optional bevy crates
 bevy_animation = ["bevy_internal/bevy_animation"]
+bevy_asset = ["bevy_internal/bevy_asset"]
 bevy_audio = ["bevy_internal/bevy_audio"]
 bevy_core_pipeline = ["bevy_internal/bevy_core_pipeline"]
 bevy_dynamic_plugin = ["bevy_internal/bevy_dynamic_plugin"]
 bevy_gilrs = ["bevy_internal/bevy_gilrs"]
 bevy_gltf = ["bevy_internal/bevy_gltf"]
 bevy_pbr = ["bevy_internal/bevy_pbr"]
 bevy_render = ["bevy_internal/bevy_render"]
+bevy_scene = ["bevy_internal/bevy_scene"]
 bevy_sprite = ["bevy_internal/bevy_sprite"]
 bevy_text = ["bevy_internal/bevy_text"]
 bevy_ui = ["bevy_internal/bevy_ui"]
@@ -1254,6 +1258,16 @@ description = "Displays many animated sprites in a grid arrangement with slight
 category = "Stress Tests"
 wasm = true
 
+[[example]]
+name = "many_buttons"
+path = "examples/stress_tests/many_buttons.rs"
+
+[package.metadata.example.many_buttons]
+name = "Many Buttons"
+description = "Test rendering of many UI elements"
+category = "Stress Tests"
+wasm = true
+
 [[example]]
 name = "many_cubes"
 path = "examples/stress_tests/many_cubes.rs"
@@ -1524,3 +1538,9 @@ target_sdk_version = 31
 [package.metadata.android.application]
 icon = "@mipmap/ic_launcher"
 label = "Bevy Example"
+
+[profile.wasm-release]
+inherits = "release"
+opt-level = "z"
+lto = "fat"
+codegen-units = 1

README.md

@@ -109,13 +109,31 @@ Additionally, we would like to thank the [Amethyst](https://github.com/amethyst/
 
 ## License
 
-Bevy is free and open source! All code in this repository is dual-licensed under either:
+Bevy is free, open source and permissively licensed!
+Except where noted (below and/or in individual files), all code in this repository is dual-licensed under either:
 
 * MIT License ([LICENSE-MIT](LICENSE-MIT) or [http://opensource.org/licenses/MIT](http://opensource.org/licenses/MIT))
 * Apache License, Version 2.0 ([LICENSE-APACHE](LICENSE-APACHE) or [http://www.apache.org/licenses/LICENSE-2.0](http://www.apache.org/licenses/LICENSE-2.0))
 
-at your option. This means you can select the license you prefer! This dual-licensing approach is the de-facto standard in the Rust ecosystem and there are [very good reasons](https://github.com/bevyengine/bevy/issues/2373) to include both.
+at your option.
+This means you can select the license you prefer!
+This dual-licensing approach is the de-facto standard in the Rust ecosystem and there are [very good reasons](https://github.com/bevyengine/bevy/issues/2373) to include both.
 
-Unless you explicitly state otherwise, any contribution intentionally submitted
-for inclusion in the work by you, as defined in the Apache-2.0 license, shall be dual licensed as above, without any
-additional terms or conditions.
+Some of the engine's code carries additional copyright notices and license terms due to their external origins.
+These are generally BSD-like, but exact details vary by crate:
+If the README of a crate contains a 'License' header (or similar), the additional copyright notices and license terms applicable to that crate will be listed.
+The above licensing requirement still applies to contributions to those crates, and sections of those crates will carry those license terms.
+The [license](https://doc.rust-lang.org/cargo/reference/manifest.html#the-license-and-license-file-fields) field of each crate will also reflect this.
+For example, [`bevy_mikktspace`](./crates/bevy_mikktspace/README.md#license-agreement) has code under the Zlib license (as well as a copyright notice when choosing the MIT license).
+
+The [assets](assets) included in this repository (for our [examples](./examples/README.md)) typically fall under different open licenses.
+These will not be included in your game (unless copied in by you), and they are not distributed in the published bevy crates.
+See [CREDITS.md](CREDITS.md) for the details of the licenses of those files.
+
+### Your contributions
+
+Unless you explicitly state otherwise,
+any contribution intentionally submitted for inclusion in the work by you,
+as defined in the Apache-2.0 license,
+shall be dual licensed as above,
+without any additional terms or conditions.

crates/bevy_app/src/app.rs

@@ -15,7 +15,12 @@ use std::fmt::Debug;
 
 #[cfg(feature = "trace")]
 use bevy_utils::tracing::info_span;
-bevy_utils::define_label!(AppLabel);
+bevy_utils::define_label!(
+    /// A strongly-typed class of labels used to identify an [`App`].
+    AppLabel,
+    /// A strongly-typed identifier for an [`AppLabel`].
+    AppLabelId,
+);
 
 #[allow(clippy::needless_doctest_main)]
 /// A container of app logic and data.
@@ -857,7 +862,14 @@ impl App {
         self
     }
 
-    /// Adds the type `T` to the type registry [`Resource`].
+    /// Registers the type `T` in the [`TypeRegistry`](bevy_reflect::TypeRegistry) resource,
+    /// adding reflect data as specified in the [`Reflect`](bevy_reflect::Reflect) derive:
+    /// ```rust,ignore
+    /// #[derive(Reflect)]
+    /// #[reflect(Component, Serialize, Deserialize)] // will register ReflectComponent, ReflectSerialize, ReflectDeserialize
+    /// ```
+    ///
+    /// See [`bevy_reflect::TypeRegistry::register`].
     #[cfg(feature = "bevy_reflect")]
     pub fn register_type<T: bevy_reflect::GetTypeRegistration>(&mut self) -> &mut Self {
         {
@@ -867,6 +879,39 @@ impl App {
         self
     }
 
+    /// Adds the type data `D` to type `T` in the [`TypeRegistry`](bevy_reflect::TypeRegistry) resource.
+    ///
+    /// Most of the time [`App::register_type`] can be used instead to register a type you derived [`Reflect`](bevy_reflect::Reflect) for.
+    /// However, in cases where you want to add a piece of type data that was not included in the list of `#[reflect(...)]` type data in the derive,
+    /// or where the type is generic and cannot register e.g. `ReflectSerialize` unconditionally without knowing the specific type parameters,
+    /// this method can be used to insert additional type data.
+    ///
+    /// # Example
+    /// ```rust
+    /// use bevy_app::App;
+    /// use bevy_reflect::{ReflectSerialize, ReflectDeserialize};
+    ///
+    /// App::new()
+    ///     .register_type::<Option<String>>()
+    ///     .register_type_data::<Option<String>, ReflectSerialize>()
+    ///     .register_type_data::<Option<String>, ReflectDeserialize>();
+    /// ```
+    ///
+    /// See [`bevy_reflect::TypeRegistry::register_type_data`].
+    #[cfg(feature = "bevy_reflect")]
+    pub fn register_type_data<
+        T: bevy_reflect::Reflect + 'static,
+        D: bevy_reflect::TypeData + bevy_reflect::FromType<T>,
+    >(
+        &mut self,
+    ) -> &mut Self {
+        {
+            let registry = self.world.resource_mut::<bevy_reflect::TypeRegistryArc>();
+            registry.write().register_type_data::<T, D>();
+        }
+        self
+    }
+
     /// Adds an [`App`] as a child of the current one.
     ///
     /// The provided function `f` is called by the [`update`](Self::update) method. The [`World`]

crates/bevy_asset/Cargo.toml

@@ -30,7 +30,7 @@ anyhow = "1.0.4"
 thiserror = "1.0"
 downcast-rs = "1.2.0"
 fastrand = "1.7.0"
-notify = { version = "=5.0.0-pre.11", optional = true }
+notify = { version = "=5.0.0-pre.15", optional = true }
 parking_lot = "0.12.1"
 
 [target.'cfg(target_arch = "wasm32")'.dependencies]

crates/bevy_asset/src/asset_server.rs

@@ -81,7 +81,7 @@ pub struct AssetServerInternal {
 /// of the assets it manages and can even reload them from the filesystem with
 /// [`AssetServer::watch_for_changes`]!
 ///
-/// The asset server is a _resource_, so in order to accesss it in a system you need a `Res`
+/// The asset server is a _resource_, so in order to access it in a system you need a `Res`
 /// accessor, like this:
 ///
 /// ```rust,no_run
@@ -256,7 +256,7 @@ impl AssetServer {
     /// Gets the overall load state of a group of assets from the provided handles.
     ///
     /// This method will only return [`LoadState::Loaded`] if all assets in the
-    /// group were loaded succesfully.
+    /// group were loaded successfully.
     pub fn get_group_load_state(&self, handles: impl IntoIterator<Item = HandleId>) -> LoadState {
         let mut load_state = LoadState::Loaded;
         for handle_id in handles {

crates/bevy_asset/src/debug_asset_server.rs

@@ -116,7 +116,7 @@ pub(crate) fn sync_debug_assets<T: Asset + Clone>(
 /// Uses the return type of the given loader to register the given handle with the appropriate type
 /// and load the asset with the given `path` and parent `file_path`.
 ///
-/// If this feels a bit odd ... thats because it is. This was built to improve the UX of the
+/// If this feels a bit odd ... that's because it is. This was built to improve the UX of the
 /// `load_internal_asset` macro.
 pub fn register_handle_with_loader<A: Asset>(
     _loader: fn(&'static str) -> A,

crates/bevy_asset/src/io/android_asset_io.rs

@@ -12,7 +12,7 @@ use std::{
 /// Implementation details:
 ///
 /// - `load_path` uses the [AssetManager] to load files.
-/// - `read_directory` always returns an empty itrator.
+/// - `read_directory` always returns an empty iterator.
 /// - `get_metadata` will probably return an error.
 /// - Watching for changes is not supported. The watcher methods will do nothing.
 ///

crates/bevy_asset/src/io/wasm_asset_io.rs

@@ -25,6 +25,7 @@ pub struct WasmAssetIo {
 }
 
 impl WasmAssetIo {
+    /// Creates a new `WasmAssetIo`. The path provided will be used to build URLs to query for assets.
     pub fn new<P: AsRef<Path>>(path: P) -> Self {
         WasmAssetIo {
             root_path: path.as_ref().to_owned(),

crates/bevy_asset/src/lib.rs

@@ -32,6 +32,7 @@ pub mod prelude {
     pub use crate::{AddAsset, AssetEvent, AssetServer, Assets, Handle, HandleUntyped};
 }
 
+pub use anyhow::Error;
 pub use asset_server::*;
 pub use assets::*;
 pub use bevy_utils::BoxedFuture;

crates/bevy_asset/src/loader.rs

@@ -2,6 +2,7 @@ use crate::{
     path::AssetPath, AssetIo, AssetIoError, AssetMeta, AssetServer, Assets, Handle, HandleId,
     RefChangeChannel,
 };
+use anyhow::Error;
 use anyhow::Result;
 use bevy_ecs::system::{Res, ResMut};
 use bevy_reflect::{TypeUuid, TypeUuidDynamic};
@@ -20,7 +21,7 @@ pub trait AssetLoader: Send + Sync + 'static {
         &'a self,
         bytes: &'a [u8],
         load_context: &'a mut LoadContext,
-    ) -> BoxedFuture<'a, Result<(), anyhow::Error>>;
+    ) -> BoxedFuture<'a, Result<(), Error>>;
 
     /// Returns a list of extensions supported by this asset loader, without the preceding dot.
     fn extensions(&self) -> &[&str];

crates/bevy_audio/src/audio_source.rs

@@ -57,7 +57,7 @@ impl AssetLoader for AudioLoader {
 
 /// A type implementing this trait can be decoded as a rodio source
 pub trait Decodable: Send + Sync + 'static {
-    /// The decoder that can decode the implemeting type
+    /// The decoder that can decode the implementing type
     type Decoder: rodio::Source + Send + Sync + Iterator<Item = Self::DecoderItem>;
     /// A single value given by the decoder
     type DecoderItem: rodio::Sample + Send + Sync;

crates/bevy_derive/src/lib.rs

@@ -80,10 +80,14 @@ pub fn derive_enum_variant_meta(input: TokenStream) -> TokenStream {
     enum_variant_meta::derive_enum_variant_meta(input)
 }
 
-#[proc_macro_derive(AppLabel)]
+/// Generates an impl of the `AppLabel` trait.
+///
+/// This works only for unit structs, or enums with only unit variants.
+/// You may force a struct or variant to behave as if it were fieldless with `#[app_label(ignore_fields)]`.
+#[proc_macro_derive(AppLabel, attributes(app_label))]
 pub fn derive_app_label(input: TokenStream) -> TokenStream {
     let input = syn::parse_macro_input!(input as syn::DeriveInput);
     let mut trait_path = BevyManifest::default().get_path("bevy_app");
     trait_path.segments.push(format_ident!("AppLabel").into());
-    derive_label(input, &trait_path)
+    derive_label(input, &trait_path, "app_label")
 }

crates/bevy_ecs/Cargo.toml

@@ -41,3 +41,7 @@ path = "examples/resources.rs"
 [[example]]
 name = "change_detection"
 path = "examples/change_detection.rs"
+
+[[example]]
+name = "derive_label"
+path = "examples/derive_label.rs"

crates/bevy_ecs/examples/derive_label.rs

@@ -0,0 +1,62 @@
+use std::marker::PhantomData;
+
+use bevy_ecs::prelude::*;
+
+fn main() {
+    // Unit labels are always equal.
+    assert_eq!(UnitLabel.as_label(), UnitLabel.as_label());
+
+    // Enum labels depend on the variant.
+    assert_eq!(EnumLabel::One.as_label(), EnumLabel::One.as_label());
+    assert_ne!(EnumLabel::One.as_label(), EnumLabel::Two.as_label());
+
+    // Labels annotated with `ignore_fields` ignore their fields.
+    assert_eq!(WeirdLabel(1).as_label(), WeirdLabel(2).as_label());
+
+    // Labels don't depend only on the variant name but on the full type
+    assert_ne!(
+        GenericLabel::<f64>::One.as_label(),
+        GenericLabel::<char>::One.as_label(),
+    );
+}
+
+#[derive(SystemLabel)]
+pub struct UnitLabel;
+
+#[derive(SystemLabel)]
+pub enum EnumLabel {
+    One,
+    Two,
+}
+
+#[derive(SystemLabel)]
+#[system_label(ignore_fields)]
+pub struct WeirdLabel(i32);
+
+#[derive(SystemLabel)]
+pub enum GenericLabel<T> {
+    One,
+    #[system_label(ignore_fields)]
+    Two(PhantomData<T>),
+}
+
+// FIXME: this should be a compile_fail test
+/*#[derive(SystemLabel)]
+pub union Foo {
+    x: i32,
+}*/
+
+// FIXME: this should be a compile_fail test
+/*#[derive(SystemLabel)]
+#[system_label(ignore_fields)]
+pub enum BadLabel {
+    One,
+    Two,
+}*/
+
+// FIXME: this should be a compile_fail test
+/*#[derive(SystemLabel)]
+pub struct BadLabel2 {
+    #[system_label(ignore_fields)]
+    x: (),
+}*/