search

Xide / bevy-websocket-adapter

Simple adapter to receive WebSocket messages in your bevy games as native Rust types.
4 stars 6 forks source link

readme

Bevy websocket adapter

Simple adapter to receive WebSocket messages in your bevy games as native Rust types.

crates.io docs.rs license

:construction: This is a work in progress, many major features are not implemented

It uses tokio as the async backend and tungstenite for websocket protocol implementation.

You can check the examples directory for more details on the usage of this crate.

Table of content

Message format

All websocket messages must be JSON object in this format:

{
    "t": "MyMessageType",
    "d": "..."
}
:warning: The t field MUST be unique across all your messages types, one value of t will always map to the same native rust type.

The contents of d can be any valid JSON value. Your native rust type must be able to serialize/deserialize the contents of d using the serde_json crate.

Roadmap