#networking #game #raknet

rust-raknet

RakNet Protocol implementation by Rust

2 unstable releases

Uses new Rust 2021

new 0.10.0 Aug 6, 2022
0.9.0 Jun 12, 2022
0.8.0 May 11, 2022
0.1.1 Mar 28, 2022

#352 in Network programming

Download history 21/week @ 2022-04-18 41/week @ 2022-04-25 57/week @ 2022-05-02 53/week @ 2022-05-09 29/week @ 2022-05-16 5/week @ 2022-05-23 33/week @ 2022-05-30 22/week @ 2022-06-06 25/week @ 2022-06-13 6/week @ 2022-06-20 17/week @ 2022-06-27 6/week @ 2022-07-04 15/week @ 2022-07-11 25/week @ 2022-07-18 31/week @ 2022-07-25 17/week @ 2022-08-01

88 downloads per month

MIT license

165KB
3K SLoC

rust-raknet Build Status ChatOnDiscord Crate Crate

RakNet Protocol implementation by Rust.

Raknet is a reliable udp transport protocol that is generally used for communication between game clients and servers, and is used by Minecraft Bedrock Edtion for underlying communication.

Raknet protocol supports various reliability options, and has better transmission performance than TCP in unstable network environments. This project is an incomplete implementation of the protocol by reverse engineering.

Reference : http://www.jenkinssoftware.com/raknet/manual/index.html

This project is not affiliated with Jenkins Software LLC nor RakNet.

Features

  • Async
  • MIT License
  • Pure Rust implementation
  • Fast Retransmission
  • Selective Retransmission (TCP/Full Retransmission)
  • Non-delayed ACK (TCP/Delayed ACK)
  • RTO Not Doubled (TCP/RTO Doubled)
  • Linux/Windows/Mac/BSD support
  • Compatible with Minecraft 1.18.x

Get Started

# Cargo.toml
[dependencies]
rust-raknet = "*"

Documentation : https://docs.rs/rust-raknet/latest/rust_raknet/

Reliability

  • unreliable
  • unreliable sequenced
  • reliable
  • reliable ordered
  • reliable sequenced

Example

//server

async fn serve(){
    let mut listener = RaknetListener::bind("127.0.0.1:19132".parse().unwrap()).await.unwrap();
    listener.listen().await;
    loop{
        let mut socket = listener.accept().await.unwrap();
        let buf = socket.recv().await.unwrap();
        if buf[0] == 0xfe{
            //do something
        }
    }
	listener.close().await.unwrap();
}

//client

async fn connect(){
    let mut socket = RaknetSocket::connect("127.0.0.1:19132".parse().unwrap()).await.unwrap();
    socket.send(&[0xfe], Reliability::ReliableOrdered).await.unwrap();
    let buf = socket.recv().await.unwrap();
    if buf[0] == 0xfe{
        //do something
    }
    socket.close().await.unwrap();
}

Benchmark

Use Tcp to compare with this project. Set the server packet loss rate to 50%, the client connects to the server, and the server sends an 800-byte packet every 30ms, a total of 100 times. The client counts the delay time of each received data, and calculates the average time of receiving 100 times. The following results are obtained.

Test code: https://github.com/b23r0/rust-raknet/blob/main/example/test_benchmark/src/main.rs

Result:

image

(June 12, 2022)

In the network environment with high packet loss rate, this project can reduce the delay time by about 50% compared with TCP.

Contribution

Options :

  • Report a BUG
  • Submit an ISSUE about suggestion
  • Submit a improved PR
  • Add an example of using rust-raknet
  • Supplement the documentation on using rust-raknet

This project exists thanks to all the people who contribute.

Dependencies

~2.8–8MB
~128K SLoC