Rive

Rive is a simple yet powerful and flexible ecosystem of Rust crates for the Revolt API. It implements the entire Revolt API and is suitable for creating custom clients or bots.

The main principle of implementation is simplicity and straightforwardness. This makes it easier to understand and easier to contribute.

The ecosystem includes rive-models, rive-http, rive-gateway and more. These are explained below.

The main rive crate just re-exports these crates. Using crates individually is recommended though.

You can join the support server here.

MSRV

The minimum supported Rust version is 1.64.

Crates

These are crates that most users will use together for a full development experience. You may not need all of these, but they are often used together to accomplish most of what you need.

rive

An all-in-one crate that re-exports all other crates. It also provides an object which includes all the stuff to interact with Revolt. This is useful for quick prototyping. However, it is recommended to use each crate separately for more flexibility.

rive-models

Models defining structures, enumerations and bitflags of all Revolt API entities. Models are split into sub-modules, for example user for containing types specific to the user's entity, event for containing events coming from WebSocket or data for containing fields used in API requests.

Models can be serialized or deserialized using Serde.

rive-http

HTTP client supporting all of the Revolt REST API. It is based on reqwest.

rive-gateway

Implementation of Revolt's WebSocket API. This is responsible for receiving events in real-time from Revolt and sending some information. It is based on tokio-tungstenite.

It also includes a basic automatic heartbeat mechanism (server pinging to keep the connection alive). If you want more advanced features such as server latency measurement, you'll need to implement it yourself.

rive-autumn

An HTTP client for the Autumn, a microservice responsible for storing files and attachment on Revolt. Based on reqwest and Tokio's async I/O.

rive-cache-inmemory

An implementation of in-memory cache.

It processes incoming events, and adds/modifies/removes resources depending on the event type and data.

Credits

• Models were taken directly from the Revolt's backend.
• This project is heavily inspired by twilight. <3
• Rive logo was remixed from Google Icons.

License

Crates are distributed under GNU Lesser General Public License v2.1. Branding assets are distributed under Apache License 2.0.