https://github.com/HouraiTeahouse/backroll-rs

A (almost) 100% pure safe Rust implementation of GGPO-style rollback netcode.
https://github.com/HouraiTeahouse/backroll-rs

game-networking ggpo rollback-netcode

Last synced: 2 months ago
JSON representation

A (almost) 100% pure safe Rust implementation of GGPO-style rollback netcode.

• Host: GitHub
• URL: https://github.com/HouraiTeahouse/backroll-rs
• Owner: HouraiTeahouse
• License: isc
• Created: 2021-05-25T07:29:33.000Z (over 3 years ago)
• Default Branch: main
• Last Pushed: 2023-03-13T09:04:56.000Z (almost 2 years ago)
• Last Synced: 2024-10-29T22:25:52.710Z (3 months ago)
• Topics: game-networking, ggpo, rollback-netcode
• Language: Rust
• Homepage:
• Size: 3.1 MB
• Stars: 352
• Watchers: 12
• Forks: 18
• Open Issues: 14
• Metadata Files:
  • Readme: README.md
  • Funding: .github/FUNDING.yml
  • License: LICENSE

Awesome Lists containing this project

• awesome-code-for-gamedev - backroll - pure Rust implementation of GGPO rollback networking library. (Objects - Entity, Actor / Networked Objects - Synchronization)

README

        
# backroll-rs

[![crates.io](https://img.shields.io/crates/v/backroll.svg)](https://crates.io/crates/backroll)

[![Documentation](https://docs.rs/backroll/badge.svg)](https://docs.rs/backroll)

![License](https://img.shields.io/crates/l/backroll)

[![Discord](https://img.shields.io/discord/151219753434742784.svg?label=&logo=discord&logoColor=ffffff&color=7389D8&labelColor=6A7EC2)](https://discord.gg/VuZhs9V)

Backroll is a pure Rust implementation of [GGPO](https://www.ggpo.net/)

rollback networking library.

## Development Status

This is still in an early beta stage. At time of writing, the public facing API 

is stable, and has undergone limited testing. There may still be notable bugs

that have not been found yet.

## Differences with the C++ implementation

 * (Almost) 100% pure **safe** Rust. No unsafe pointer manipulation.

 * Type safety. backroll-rs heavily utilizes generics and associated types to 

   avoid serialization overhead and potentially unsafe type conversions when 

   saving and loading game state.

 * Abstracted transport layer protocols - integrate and use any transport layer

   library you need. Comes with a raw UDP socket based implementation.

 * Configurable at runtime - Many of the hard-coded constants in GGPO are exposed

   as configuration parameters during session initialization.

 * Reduced memory usage - Backroll's use of generics potentially shrinks down

   the sizes of many data types.

 * Vectorized input compression scheme - Backroll utilizes the same XOR + RLE

   encoding, but it's written to maximize CPU utilization.

 * Multithreaded I/O - All network communications run within an async task pool.

   I/O polling is no longer manual, nor blocks your game's execution.

## Repository Structure

This repo contains the following crates:

 * backroll - the main Backroll interface, intended to be used as the original

   GGPO.

 * backroll\_transport - An isolated set of transport layer abstractions. 

 * backroll\_transport\_udp - A transport layer implementation using raw UDP

   sockets. 

 * backroll\_transport\_steam - A transport layer implementation using the 

   Steam provided networking utilities. Enables access to the Steam Datagram

   Relay service.

 * bevy\_backroll - a integration plugin for [bevy](https://bevyengine.org/).

   (Complete, untested).

 * lib - third-party linking dependencies (i.e. Steam) for easier local 

   development