bevy_ggrs 0.9.0

Bevy plugin for the GGRS P2P rollback networking library
docs.rs failed to build bevy_ggrs-0.9.0
Please check the build logs for more information.
See Builds for ideas on how to fix a failed build, or Metadata for how to configure docs.rs builds.
If you believe this is docs.rs' fault, open an issue.
Visit the last successful build: bevy_ggrs-0.22.0

GGRS LOGO

crates.io GitHub Workflow Status

Bevy GGRS

Bevy plugin for the GGRS P2P rollback networking library. The plugin creates a custom stage with a separate schedule, which handles correctly advancing the gamestate, including rollbacks. It efficiently handles saving and loading of the gamestate by only snapshotting relevant parts of the world, as defined by the user. It is supposed to work with the latest released version of bevy.

For explanation on how to use it, check the 👉examples!

Live Demonstrations

johanhelsing wrote and hosts multiple small demos/games written with GGRS, Bevy and matchbox running in the browser. Try them out with a friend! Just click the link to get matched with another player! (You can also open the link in two separate windows to play against yourself)

How it works

The GGRS plugin creates a custom GGRSStage which owns a separate schedule. Inside this schedule, the user can add stages and systems as they wish. When the default schedule runs the GGRSStage, it polls the session and executes resulting GGRSRequests, such as loading, saving and advancing the gamestate.

  • advancing the gamestate is done by running the internal schedule once.
  • saving the gamestate is done by creating a snapshot of entities tagged with a bevy_ggrs::Rollback component and saving only the components that were registered through register_rollback_type::<YourCoolComponent>(). The plugin internally keeps track of the snapshots together with the GGRS session.
  • loading the gamestate applies the snapshot by overwriting, creating and deleting entities tagged with a bevy_ggrs::Rollback component and updating the registered components values.

Since bevy_ggrs operates with a separate schedule, compatibility with other plugins might be complicated to achieve out of the box, as all gamestate-relevant systems needs to somehow end up inside the internal GGRS schedule to be updated together the rest of the game systems.

Compatible Versions

Starting with 0.9.0, the bevy_ggrs plugin will update its version number together with GGRS to avoid confusion.

bevy bevy_ggrs ggrs
0.6 main main
0.6 0.9 0.9
0.6 =0.1.3 0.8

Thanks

to bevy_backroll and bevy_rollback for figuring out pieces of the puzzle that made bevy_GGRS possible. Special thanks to the helpful folks in the bevy discord, providing useful help and pointers all over the place.

Licensing

Bevy_GGRS is dual-licensed under either

at your option.