Update Bevy to v0.16 (#52)

* refactor: ⬆️ Update Bevy to v0.16

* fix: 🐛 Fix crash due to the UI side panel being updated in the wrong schedule

* refactor: ♻️ Re-add `#[must_use]` on `FrameExt` trait method definitions

* fix: 🐛 Fix panic on window close

* fix: 🐛 Fix Peak Alloc panic

* docs: 📝 Add development information to the readme

Author: Steveplays28

Cargo.lock

@@ -1,6 +1,6 @@
 [workspace]
 resolver = "2"
-members = ["crates/*", ]
+members = ["crates/*"]
 
 [workspace.package]
 version = "0.1.0"
@@ -9,9 +9,10 @@ license = "MIT OR Apache-2.0"
 repository = "https://github.com/nixon-voxell/bevy_motion_matching"
 
 [workspace.dependencies]
-bevy = { version = "0.15", features = ["asset_processor"] }
-bevy_gltf = "0.15"
-bevy_egui = "0.33"
+bevy = { version = "0.16", features = ["asset_processor"] }
+bevy_gltf = "0.16"
+bevy_egui = "0.34"
+bevy_platform = "0.16"
 serde_json = "1.0"
 serde = "1.0"
 bvh_anim = "0.4"
@@ -43,23 +44,24 @@ bevy_bvh_anim = { path = "crates/bevy_bvh_anim" }
 bevy = { workspace = true }
 bevy_gltf = { workspace = true }
 bevy_egui = { workspace = true }
+bevy_platform = { workspace = true }
 serde = { workspace = true }
 serde_json = { workspace = true }
 thiserror = { workspace = true }
 
 egui_extras = "0.31.1"
-egui_plot = "0.31.0"
-leafwing-input-manager = "0.16.0"
+egui_plot = "0.32.1"
+leafwing-input-manager = "0.17"
 
 # Debug editor (run with debug feature to enable it)
-bevy-inspector-egui = { version = "0.29", optional = true }
+bevy-inspector-egui = { version = "0.31", optional = true }
 kdtree = "0.7.0"
-peak_alloc = "0.2.1"
+peak_alloc = { git = "https://github.com/Steveplays28/peak_alloc", branch = "fix-usize-overflow" }
 clustering = "0.2.1"
 csv = "1.3.0"
 
 [dev-dependencies]
-bevy-inspector-egui = { version = "0.29" }
+bevy-inspector-egui = { version = "0.31" }
 
 [lints]
 workspace = true

Cargo.toml

@@ -8,6 +8,8 @@
 Motion matching enables characters to smoothly transition between animations by finding the best matching pose and trajectory from an extensive database, without the need to create state machines.
 Gameplay logic can be embedded side by side with motion matching by querying animations with the desired attributes.
 
+## Showcase
+
 ### Configuration
 
 ![config](./.github/assets/config.png)
@@ -16,6 +18,29 @@ Gameplay logic can be embedded side by side with motion matching by querying ani
 
 ![play-mode](./.github/assets/play-mode.png)
 
+## Development
+
+### Prerequisites
+
+- Rust
+  - MSRV: v1.85.0
+- Cargo
+- Linux: [Bevy dependencies](https://github.com/bevyengine/bevy/blob/main/docs/linux_dependencies.md)
+- Optional, for the Visual Studio Code `start` task: `cargo-watch`
+  - `cargo install cargo-watch` or `cargo binstall cargo-watch`
+
+### Building
+
+```bash
+cargo build
+```
+
+### Running
+
+```bash
+cargo run --features bevy/dynamic_linking
+```
+
 ## Reference
 
 - [Learned Motion Matching](https://static-wordpress.ubisoft.com/montreal.ubisoft.com/wp-content/uploads/2020/07/09154101/Learned_Motion_Matching.pdf)

README.md

@@ -18,15 +18,17 @@ pub mod joint_matrices;
 pub mod joint_traits;
 
 pub trait FrameExt {
+    #[must_use]
     fn get_pos_rot(&self, joint_data: &JointData) -> (Vec3, Quat);
 
+    #[must_use]
     fn get_pos(&self, joint_data: &JointData) -> Vec3;
 
+    #[must_use]
     fn get_rot(&self, joint_data: &JointData) -> Quat;
 }
 
 impl FrameExt for Frame {
-    #[must_use]
     fn get_pos_rot(&self, joint_data: &JointData) -> (Vec3, Quat) {
         let mut pos = Vec3::ZERO;
         let mut euler = Vec3::ZERO;
@@ -52,7 +54,6 @@ impl FrameExt for Frame {
         )
     }
 
-    #[must_use]
     fn get_pos(&self, joint_data: &JointData) -> Vec3 {
         let mut pos = Vec3::ZERO;
 
@@ -72,7 +73,6 @@ impl FrameExt for Frame {
         pos
     }
 
-    #[must_use]
     fn get_rot(&self, joint_data: &JointData) -> Quat {
         let mut euler = Vec3::ZERO;
 

crates/bevy_bvh_anim/src/lib.rs

@@ -72,7 +72,7 @@ fn armature_gizmos(
         }
 
         if let Ok(children) = q_children.get(parent) {
-            for &child in children.iter() {
+            for child in children.iter() {
                 if let Ok(transform) = q_transforms.get(child) {
                     let child_translation = transform.translation();
 
@@ -99,7 +99,7 @@ fn armature_gizmos(
         }
     }
 
-    if let Ok((entity, transform)) = q_character.get_single() {
+    if let Ok((entity, transform)) = q_character.single() {
         recursive_draw(
             0,
             entity,

src/bvh_manager/bvh_gizmos.rs

@@ -1,7 +1,8 @@
 use std::{fs, path::PathBuf, str::FromStr};
 
-use bevy::{prelude::*, utils::HashSet};
+use bevy::prelude::*;
 use bevy_bvh_anim::prelude::*;
+use bevy_platform::collections::HashSet;
 
 pub const BVH_FOLDER: &str = "bvh";
 pub const BVH_MAP_FOLDER: &str = "bvh_map";

src/bvh_manager/bvh_library.rs

@@ -1,7 +1,7 @@
 use bevy::{
     asset::{DependencyLoadState, LoadState, RecursiveDependencyLoadState},
+    platform::collections::HashMap,
     prelude::*,
-    utils::hashbrown::HashMap,
 };
 use bevy_bvh_anim::{bvh_anim::ChannelType, prelude::*};
 
@@ -35,7 +35,7 @@ fn generate_bone_map(
     server: Res<AssetServer>,
     mut asset_loaded: Local<bool>,
 ) {
-    let Ok((entity, scene_root)) = q_character.get_single() else {
+    let Ok((entity, scene_root)) = q_character.single() else {
         return;
     };
 
@@ -64,7 +64,7 @@ fn generate_bone_map(
             q_transforms: &Query<&Transform>,
         ) {
             if let Ok(children) = q_children.get(parent) {
-                for &child in children.iter() {
+                for child in children.iter() {
                     for _ in 0..indent {
                         print!("| ");
                     }

src/bvh_manager/bvh_player.rs

@@ -188,7 +188,7 @@ fn pan_orbit_camera(
         {
             if is_focus {
                 camera_focus.clear();
-            } else if let Ok(entity) = q_main_scene.get_single() {
+            } else if let Ok(entity) = q_main_scene.single() {
                 camera_focus.set(entity);
             }
         }

src/camera.rs

@@ -73,7 +73,7 @@ fn _test(
 
     // if input.just_pressed(KeyCode::Space) {
     //     for entity in q_entities.iter() {
-    //         jump_evw.send(JumpToPose {
+    //         jump_evw.write(JumpToPose {
     //             motion_pose: MotionPose {
     //                 chunk_index: 0,
     //                 time: 3.0,

src/motion/motion_player.rs

@@ -91,7 +91,7 @@ fn flow(
         let index = motion_player.target_pair_index();
         let Some(traj_pose) = &traj_pose_pair[index] else {
             // Find a new animation to play.
-            traj_match_evw.send(TrajectoryMatch(entity));
+            traj_match_evw.write(TrajectoryMatch(entity));
             continue;
         };
 
@@ -101,7 +101,7 @@ fn flow(
                 continue;
             }
             false => {
-                pred_match_evw.send(PredictionMatch {
+                pred_match_evw.write(PredictionMatch {
                     motion_pose: *traj_pose.motion_pose(),
                     entity,
                 });
@@ -154,7 +154,7 @@ fn prediction_match(
             trajectory_data.get_chunk(pred_match.chunk_index),
             pose_data.is_chunk_loopable(pred_match.chunk_index),
         ) else {
-            traj_match_evw.send(TrajectoryMatch(pred_match.entity));
+            traj_match_evw.write(TrajectoryMatch(pred_match.entity));
             continue;
         };
 
@@ -163,7 +163,7 @@ fn prediction_match(
             match loopable {
                 true => chunk_offset = 0,
                 false => {
-                    traj_match_evw.send(TrajectoryMatch(pred_match.entity));
+                    traj_match_evw.write(TrajectoryMatch(pred_match.entity));
                     continue;
                 }
             }
@@ -186,7 +186,7 @@ fn prediction_match(
             .collect::<Vec<_>>();
 
         if traj.distance(&data_traj) > match_config.pred_match_threshold {
-            traj_match_evw.send(TrajectoryMatch(pred_match.entity));
+            traj_match_evw.write(TrajectoryMatch(pred_match.entity));
         }
     }
 }
@@ -301,7 +301,7 @@ fn trajectory_match(
                 / runs as f64;
         motion_matching_result.matching_result.runs = runs;
 
-        nearest_trajectories_evw.send(NearestTrajectories {
+        nearest_trajectories_evw.write(NearestTrajectories {
             trajectories: nearest_trajs,
             entity,
         });
@@ -378,7 +378,7 @@ fn pose_match(
         motion_matching_result.selected_trajectory = best_traj_index;
 
         let best_traj = &trajs[best_traj_index];
-        jump_evw.send(JumpToPose {
+        jump_evw.write(JumpToPose {
             motion_pose: MotionPose {
                 chunk_index: best_traj.chunk_index,
                 time: motion_asset