bevy_replicon

Bevy Replicon

A server-authoritative replication crate for Bevy.

If you are new to networking, see glossary and What kind of networking should X game use?.

Features

• Automatic world replication.
• Remote events and triggers.
• Authorization support.
• Control over client visibility of entities and components.
• Specify which entities should be replicated in sync using ECS relationships.
• State serialization based on replication rules.
• 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 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.

Getting Started

Check out the quick start guide.

For examples navigate to the example_backend (because you need I/O in order to run them). Messaging backend repositories usually also contains the exact same examples, but with backend initialization adapted to each backend's API.

You can also:

• Watch my talk at Bevy Meetup #9
• Read this great article (not mine)

Have any questions? Feel free to ask in the dedicated bevy_replicon channel 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 - integration for bevy_renet.
• bevy_replicon_renet2 - integration for bevy_renet2.
• bevy_replicon_quinnet - integration for bevy_quinnet.
• aeronet_replicon - integration for aeronet.
• bevy_replicon_matchbox - integration for matchbox.

Interpolation and/or rollback

• bevy_rewind - server-authoritative rollback inspired by Rocket League.

Unmaintained

• bevy_replicon_repair - preserves replicated client state across reconnects.
• bevy_replicon_attributes - ergonomic visibility control through client attributes and entity/event visibility conditions. An extension of this crate's raw client visibility API.
• bevy_replicon_snap - snapshot interpolation and client-side prediction.
• bevy_timewarp - a rollback library that buffers component state. See this instruction about how to integrate.
• bevy_bundlication - automates the creation of replication rules for bundles.

Bevy compatibility

License

Licensed under either of Apache License, Version 2.0 or MIT License at your option.