#webrtc #udp #wasm #networking #gamedev

naia-shared

Common functionality shared between naia-server & naia-client crates

5 unstable releases

0.3.0 Oct 11, 2020
0.2.0 Aug 17, 2020
0.1.2 Jul 7, 2020
0.1.1 Jul 6, 2020
0.1.0 Jul 1, 2020

#57 in Game dev

38 downloads per month
Used in 2 crates

MIT/Apache

77KB
1.5K SLoC

Build Status Latest Version API Documentation Discord chat MIT/Apache

naia

a networking architecture for interactive applications

A cross-platform (currently WebAssembly & Linux) networking engine that intends to make multiplayer game development in Rust dead simple and lightning fast.

At the highest level, you register Event and Actor implementations in a module shared by Client & Server. Then, naia will facilitate sending/receiving those Events between Client & Server, and also keep a pool of tracked Actors synced with each Client for whom they are "in-scope". Actors are "scoped" to Clients with whom they share the same Room, as well as being sufficiently customizable to, for example, only keep Actors persisted & synced while within a Client's viewport or according to some other criteria.

It is built on top of naia-socket, which provides cross-platform unreliable & unordered messaging.

The API is heavily inspired by the Nengi.js & Colyseus Javascript multiplayer networking libraries. The internals follow the Tribes 2 Networking model fairly closely.

Thank very much to Kyren for support & webrtc-unreliable, and to the Laminar authors, for the cannibalized code within.

Any help is very welcome, please get in touch! I'm still very new to Rust and this project is overly ambitious, and so I intend to be very open to any criticism / feedback in order to better this project.

Examples

More comprehensive documentation / tutorials are on their way, but for now, the best way to get started with naia is to go through the single example, which demonstrates most of the functionality.

Server:

To run the UDP server example on Linux: (that will be able to communicate with Linux clients)

1. cd examples/server
2. cargo run --features "use-udp"

To run the WebRTC server example on Linux: (that will be able to communicate with Web clients)

1. cd examples/server
2. cargo run --features "use-webrtc"

Client:

To run the UDP client example on Linux: (that will be able to communicate with a UDP server)

1. cd examples/client
2. cargo run

To run the WebRTC client example on Web: (that will be able to communicate with a WebRTC server)

1. cargo install cargo-web  // should only need to do this once if you haven't already
2. Enter in your IP Address at the appropriate spot in examples/client/src/app.rs
3. cd examples/client
4. npm install              // should only need to do this once to install dependencies
5. npm run start            // this will open a web browser, and hot reload
6. Open your debug console to see communications from the server

Dependencies

~0.5–1MB
~17K SLoC