https://github.com/projectharmonia/bevy_replicon
A server-authoritative replication crate for Bevy.
https://github.com/projectharmonia/bevy_replicon
bevy client-server multiplayer netcode networking replication server-authoritative
Last synced: 6 months ago
JSON representation
A server-authoritative replication crate for Bevy.
- Host: GitHub
- URL: https://github.com/projectharmonia/bevy_replicon
- Owner: projectharmonia
- License: apache-2.0
- Created: 2023-03-24T22:16:58.000Z (over 2 years ago)
- Default Branch: master
- Last Pushed: 2025-05-09T00:21:03.000Z (6 months ago)
- Last Synced: 2025-05-09T00:24:01.214Z (6 months ago)
- Topics: bevy, client-server, multiplayer, netcode, networking, replication, server-authoritative
- Language: Rust
- Homepage: https://crates.io/crates/bevy_replicon
- Size: 1.94 MB
- Stars: 452
- Watchers: 4
- Forks: 33
- Open Issues: 14
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE-APACHE
Awesome Lists containing this project
- awesome-bevy - `bevy_replicon` - authoritative networking crate for the Bevy game engine (Networking)
- awesome-bevy - `bevy_replicon` - authoritative networking crate for the Bevy game engine (Networking)
README
# Bevy Replicon
[](https://crates.io/crates/bevy_replicon)
[](https://docs.rs/bevy_replicon)
[](#license)
[](https://codecov.io/gh/projectharmonia/bevy_replicon)
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).
## Features
- Automatic world replication.
- Remote events and triggers.
- Control over client visibility of entities and events.
- Specify which entities should be replicated in sync using ECS relationships.
- Replication into scene to save server state.
- Customizable serialization and deserialization even for types that don't implement `serde` traits (like `Box`).
- 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.
- Robust, with high test coverage.
- Supports `no_std` and environments without atomic CAS, such as thumbv6m.
- 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
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.
#### Messaging backends
- [`bevy_replicon_renet`](https://github.com/projectharmonia/bevy_replicon_renet) - integration for [`bevy_renet`](https://github.com/lucaspoffo/renet/tree/master/bevy_renet). Maintained by the authors of this crate.
- [`bevy_replicon_renet2`](https://github.com/UkoeHB/renet2/tree/main/bevy_replicon_renet2) - integration for [`bevy_renet2`](https://github.com/UkoeHB/renet2/tree/main/bevy_renet2). Includes a WebTransport backend for browsers, and enables servers that can manage multi-platform clients simultaneously.
- [`bevy_replicon_quinnet`](https://github.com/Henauxg/bevy_replicon_quinnet) - integration for [`bevy_quinnet`](https://github.com/Henauxg/bevy_quinnet).
- [`aeronet_replicon`](https://github.com/aecsocket/aeronet/tree/main/crates/aeronet_replicon) - integration for [`aeronet`](https://github.com/aecsocket/aeronet). Works on any IO layer supported by `aeronet_io`, but requires `aeronet_transport`.
#### Interpolation and/or rollback
- [`bevy_replicon_snap`](https://github.com/Bendzae/bevy_replicon_snap) - adds snapshot interpolation and client-side prediction.
#### Visibility
- [`bevy_replicon_attributes`](https://github.com/UkoeHB/bevy_replicon_attributes) - adds ergonomic visibility control through client attributes and entity/event visibility conditions. An extension of this crate's raw client visibility API.
#### Miscellaneous
- [`bevy_replicon_repair`](https://github.com/UkoeHB/bevy_replicon_repair) - preserves replicated client state across reconnects.
- [`bevy_bundlication`](https://github.com/NiseVoid/bevy_bundlication) - adds registration of replication groups using a bundle-like api.
#### Unmaintained
- [`bevy_timewarp`](https://github.com/RJ/bevy_timewarp) - a rollback library that buffers component state. See [this instruction](https://github.com/RJ/bevy_timewarp/blob/main/REPLICON_INTEGRATION.md) about how to integrate.
## Bevy compatibility
| bevy | bevy_replicon |
| ------ | ------------- |
| 0.16.0 | 0.33 |
| 0.15.0 | 0.29-0.32 |
| 0.14.0 | 0.27-0.28 |
| 0.13.0 | 0.23-0.26 |
| 0.12.1 | 0.18-0.22 |
| 0.11.0 | 0.6-0.17 |
| 0.10.1 | 0.2-0.6 |
| 0.10.0 | 0.1 |
## License
Licensed under either of [Apache License, Version 2.0](LICENSE-APACHE) or [MIT License](LICENSE-MIT) at your option.