nimble-seer 0.0.16-dev

Nimble Prediction
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27

# Nimble-Seer

[![Crates.io](https://img.shields.io/crates/v/nimble-seer)](https://crates.io/crates/nimble-seer)
[![Documentation](https://docs.rs/nimble-seer/badge.svg)](https://docs.rs/nimble-seer)

`nimble-seer` is a Rust library designed to handle predicted steps and provide callbacks for
deterministic simulations. It efficiently manages predicted game state steps and syncs them
with authoritative steps, ensuring a smooth and predictable simulation experience.

## ✨ Features

- **Predicted Steps Queue**: Manages a queue of predicted steps, allowing for simulation without immediate authoritative feedback.
- **Callbacks**: Provides `SeerCallback` trait to handle actions before, during, and after each tick in the simulation.
- **Authoritative Step Integration**: Syncs predicted steps with authoritative steps, discarding outdated predictions.

## 📦 Installation

Add the following to your `Cargo.toml` file:

```toml
[dependencies]
nimble-seer = "0.0.14-dev"
```

## License

This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.