bevy_roll_safe

Crates.iobevy_roll_safe
lib.rsbevy_roll_safe
version
sourcesrc
created_at2023-11-14 08:10:17.153892+00
updated_at2024-12-19 21:06:27.754956+00
descriptionRollback safe utilities and abstractions for Bevy
homepage
repositoryhttps://github.com/johanhelsing/bevy_roll_safe
max_upload_size
id1034486
Cargo.toml error:TOML parse error at line 18, column 1 | 18 | autolib = false | ^^^^^^^ unknown field `autolib`, expected one of `name`, `version`, `edition`, `authors`, `description`, `readme`, `license`, `repository`, `homepage`, `documentation`, `build`, `resolver`, `links`, `default-run`, `default_dash_run`, `rust-version`, `rust_dash_version`, `rust_version`, `license-file`, `license_dash_file`, `license_file`, `licenseFile`, `license_capital_file`, `forced-target`, `forced_dash_target`, `autobins`, `autotests`, `autoexamples`, `autobenches`, `publish`, `metadata`, `keywords`, `categories`, `exclude`, `include`
size0
Johan Klokkhammer Helsing (johanhelsing)

documentation

README

bevy_roll_safe

crates.io MIT/Apache 2.0 docs.rs

Rollback-safe implementations and utilities for Bevy Engine.

Motivation

Some of Bevy's features can't be used in a rollback context (with crates such as bevy_ggrs). This is either because they behave non-deterministically, rely on inaccessible local system state, or are tightly coupled to the Main schedule.

Roadmap

  • States
    • Basic freely mutable states
    • OnEnter/OnLeave/OnTransition
    • Sub-States
    • Computed states
    • Roll-safe events
  • FrameCount
  • Events

States

Bevy states when added through app.add_state::<FooState>() have two big problems:

  1. They happen in the StateTransition schedule within the MainSchedule
  2. If rolled back to the first frame, OnEnter(InitialState) is not re-run.

This crate provides an extension method, add_roll_state::<S>(schedule), which lets you add a state to the schedule you want, and a resource, InitialStateEntered<S> which can be rolled back and tracks whether the initial OnEnter should be run (or re-run on rollbacks to the initial frame).

See the states example for usage with bevy_ggrs.

Cargo features

  • bevy_ggrs: Enable integration with bevy_ggrs
  • math_determinism: Enable cross-platform determinism for operations on Bevy's (glam) math types.

Bevy Version Support

bevy bevy_roll_safe
0.15 0.4, main
0.14 0.3
0.13 0.2
0.12 0.1

License

bevy_roll_safe is dual-licensed under either

at your option.

Contributions

PRs welcome!

Commit count: 32

cargo fmt