bevy_replicon_matchbox 0.16.0

A matchbox backend for replicon, built for Bevy
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
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48

# Bevy Replicon Matchbox

This crate integrates [`matchbox`](https://github.com/johanhelsing/matchbox) as a backend for [`bevy_replicon`](https://github.com/komora-io/bevy_replicon), enabling peer-to-peer networking via WebRTC, STUN, and ICE.

Matchbox provides convenient NAT traversal support out of the box — no need to manually manage signaling, host discovery, or ICE negotiation.

> ⚠️ **Note**: This is an early implementation and may still contain bugs or limitations.

---

## Running an Example

To run one of the examples from the [`examples`](examples) directory:

```bash
cargo run --example <example_name> server
```

in another terminal
```bash
cargo run --example <example_name> client
```

Each example starts a host peer that also acts as the listen server.

For production setups, it’s recommended to use a dedicated matchbox signaling server.



### Known Limitations

- **Empty message workaround**  
  WebRTC can silently drop empty messages. To prevent this, each message is currently prefixed with a single `byte` to ensure delivery.


- **WASM support not verified (yet)**  
  This backend has not been tested in WebAssembly environments. Compatibility is currently unverified.

## Compatible versions

| bevy | bevy_matchbox | bevy_replicon | bevy_replicon_renet |
|------|---------------|---------------|---------------------|
| 0.16 | 0.12          | 0.34          | 0.16                |


## License

Licensed under either of [Apache License, Version 2.0](LICENSE-APACHE) or [MIT License](LICENSE-MIT) at your option.