Merge remote-tracking branch 'origin/master' into bevy-0.16-dev

Author: Shatur

.github/workflows/main.yml

@@ -23,7 +23,7 @@ jobs:
         uses: actions/checkout@v4
 
       - name: Check typos
-        uses: crate-ci/typos@v1.30.2
+        uses: crate-ci/typos@v1.31.1
 
   format:
     name: Format

CHANGELOG.md

@@ -7,6 +7,12 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
+## [0.32.1] - 2025-04-05
+
+### Changed
+
+- Publicize `ClientTicks` component and its `update_tick` method.
+
 ## [0.32.0] - 2025-03-24
 
 ### Added
@@ -762,7 +768,8 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 Initial release after separation from [Project Harmonia](https://github.com/projectharmonia/project_harmonia).
 
-[unreleased]: https://github.com/projectharmonia/bevy_replicon/compare/v0.32.0...HEAD
+[unreleased]: https://github.com/projectharmonia/bevy_replicon/compare/v0.32.1...HEAD
+[0.32.0]: https://github.com/projectharmonia/bevy_replicon/compare/v0.32.0...v0.32.1
 [0.32.0]: https://github.com/projectharmonia/bevy_replicon/compare/v0.31.1...v0.32.0
 [0.31.1]: https://github.com/projectharmonia/bevy_replicon/compare/v0.31.0...v0.31.1
 [0.31.0]: https://github.com/projectharmonia/bevy_replicon/compare/v0.30.1...v0.31.0

Cargo.toml

@@ -6,7 +6,7 @@ authors = [
   "koe <ukoe@protonmail.com>",
 ]
 edition = "2024"
-description = "High level networking for the Bevy game engine"
+description = "A server-authoritative replication crate for Bevy"
 readme = "README.md"
 repository = "https://github.com/projectharmonia/bevy_replicon"
 keywords = [

README.md

@@ -5,7 +5,7 @@
 [![license](https://img.shields.io/crates/l/bevy_replicon)](#license)
 [![codecov](https://codecov.io/gh/projectharmonia/bevy_replicon/graph/badge.svg?token=N1G28NQB1L)](https://codecov.io/gh/projectharmonia/bevy_replicon)
 
-Server-authoritative networking crate for the [Bevy game engine](https://bevyengine.org).
+A server-authoritative replication crate for [Bevy](https://bevyengine.org).
 
 If you are new to networking, see [glossary](https://gist.github.com/maniwani/f92cc5d827b00163f5846ea7dcb90d44) and
 [What kind of networking should X game use?](https://github.com/bevyengine/bevy/discussions/8675).
@@ -15,26 +15,29 @@ If you are new to networking, see [glossary](https://gist.github.com/maniwani/f9
 - Automatic world replication.
 - Remote events and triggers.
 - Control over client visibility of entities and events.
-- Abstracts game logic to support singleplayer, client, dedicated server, and listen server configurations simultaneously.
-- Works with `no_std`.
-- No builtin I/O, can be used with any messaging library. See [messaging backends](#messaging-backends) for already available integrations.
 - Replication into scene to save server state.
 - Customizable serialization and deserialization even for types that don't implement `serde` traits (like `Box<dyn Reflect>`).
-- Extensible architecture. See [ecosystem](#ecosystem).
+- Abstracts game logic to support singleplayer, client, dedicated server, and listen server configurations simultaneously.
+- No builtin I/O, can be used with any messaging library. See [messaging backends](#messaging-backends) for already available integrations.
+- Heavily optimized.
+- Works with `no_std`.
+- Hackable. See [ecosystem](#ecosystem).
 
 ## Getting Started
 
 Check out the [quick start guide](https://docs.rs/bevy_replicon).
 
 For examples navigate to the [`bevy_replicon_example_backend`](bevy_replicon_example_backend) (because you need I/O in order to run them).
 
+You can also:
+- Watch [my talk at Bevy Meetup #9](https://www.youtube.com/watch?v=aDsVFmXD2cc)  
+- Read [this great article](https://www.hankruiger.com/posts/adding-networked-multiplayer-to-my-game-with-bevy-replicon) *(not mine)*  
+
 Have any questions? Feel free to ask in the dedicated [`bevy_replicon` channel](https://discord.com/channels/691052431525675048/1090432346907492443) in Bevy's Discord server.
 
 ## Ecosystem
 
-We have a growing ecosystem of crates that can be integrated with Replicon or built on top of it.
-Networking is quite complex, and maintaining everything in a single crate would be a nightmare.
-So we are trying to provide an extensible core and encourage users to build their own abstractions as separate crates.
+Depending on your game, you may need additional features. We provide an API that allows external crates to integrate with Replicon or to be built on top of it.
 
 > [!WARNING]
 > Ensure that your `bevy_replicon` version is compatible with the used crate according to semantic versioning.

src/lib.rs

@@ -1,5 +1,5 @@
 /*!
-Server-authoritative networking crate for the [Bevy game engine](https://bevyengine.org).
+A server-authoritative replication crate for [Bevy](https://bevyengine.org).
 
 # Quick start
 
@@ -48,7 +48,7 @@ or use backend-provided events if you need the disconnect reason.
 ## Replication
 
 It's a process of exchanging data in order to keep the world in sync. Replicon
-provides a high-level API to automate this process.
+provides a high-level API to automate server-authoritative replication.
 
 Replication happens only from server to clients. It's necessary to prevent cheating.
 If you need to send information from clients to the server, use

src/shared/backend/replicon_client.rs

@@ -121,7 +121,7 @@ impl RepliconClient {
     pub fn set_status(&mut self, status: RepliconClientStatus) {
         debug!("changing `RepliconClient` status to `{status:?}`");
 
-        if self.is_connected() && !matches!(status, RepliconClientStatus::Connected { .. }) {
+        if self.is_connected() && !matches!(status, RepliconClientStatus::Connected) {
             for channel_messages in &mut self.received_messages {
                 channel_messages.clear();
             }

src/shared/postcard_utils.rs

@@ -162,9 +162,6 @@ impl<'a, T: Buf> DeFlavor<'a> for BufFlavor<'a, T> {
     type Source = &'a [u8];
 
     fn pop(&mut self) -> postcard::Result<u8> {
-        if self.buf.remaining() == 0 {
-            panic!("asdf");
-        }
         self.buf
             .try_get_u8()
             .map_err(|_| postcard::Error::DeserializeUnexpectedEnd)

src/shared/replication.rs

@@ -1,4 +1,4 @@
-pub(crate) mod client_ticks;
+pub mod client_ticks;
 pub mod command_markers;
 pub mod deferred_entity;
 pub(crate) mod mutate_index;

src/shared/replication/client_ticks.rs

@@ -12,7 +12,7 @@ use crate::shared::replicon_tick::RepliconTick;
 
 /// Tracks replication ticks for a client.
 #[derive(Component, Default)]
-pub(crate) struct ClientTicks {
+pub struct ClientTicks {
     /// Lowest tick for use in change detection for each entity.
     mutation_ticks: EntityHashMap<Tick>,
 
@@ -40,7 +40,7 @@ impl ClientTicks {
 
     /// Returns the last tick in which a replicated entity had an insertion, removal, or gained/lost a component from the
     /// perspective of the client.
-    pub(crate) fn update_tick(&self) -> RepliconTick {
+    pub fn update_tick(&self) -> RepliconTick {
         self.update_tick
     }