## Overview
Revy is a proof-of-concept time-travel debugger for the [Bevy](https://github.com/bevyengine/bevy) game engine, built using [Rerun](https://github.com/rerun-io/rerun).
Revy works by snapshotting diffs of the Bevy database every frame that are then logged into the Rerun database.\
This allows you to inspect and visualize the state of the engine at any point in time, either in real-time or after the fact.\
These recordings can then be shared to be replayed or e.g. attached to bug reports.
For more information, check out the [Revy repository](https://github.com/rerun-io/revy).
## Examples
## Usage
1. [Install the Rerun Viewer](https://www.rerun.io/docs/overview/installing-rerun/viewer) (`0.15`).
2. Add `revy` to your dependencies:
```toml
revy = "0.15" # always matches the Rerun version
```
3. Initialize the `rerun` plugin:
```rust
.add_plugins({
let rec = revy::RecordingStreamBuilder::new("").spawn().unwrap();
revy::RerunPlugin { rec }
})
```
This will start a Rerun Viewer in the background and stream the recording data to it.\
Check out the [`RecordingStreamBuilder`](https://docs.rs/rerun/latest/rerun/struct.RecordingStreamBuilder.html) docs for other options (saving to file, connecting to a remote viewer, etc).
