Ruma – Your home in Matrix.

A set of Rust crates (libraries) for interacting with the Matrix chat network.

website • chat • documentation (unstable)

Getting started

If you want to build a Matrix client or bot, have a look at matrix-rust-sdk. It builds on Ruma and includes handling of state storage, end-to-end encryption and many other useful things.

For homeservers, bridges and harder-to-categorize software that works with Matrix, you're at the right place. To get started, add ruma to your dependencies:

# crates.io release
ruma = { version = "0.1", features = [...] }
# git dependency (the next branch contains some breaking changes main doesn't)
ruma = { git = "https://github.com/ruma/ruma", branch = "next", features = [...] }

ruma re-exports all of the other crates, so you don't have to worry about them. Check out the documentation on docs.rs (or on docs.ruma.io if you use use the git dependency).

Status

As of 2021-05-06, we support the vast majority of endpoints in all of the various Matrix APIs, the notable exception being the identity service API, where a few endpoints are still missing.

Contributing

See CONTRIBUTING.md.

Minimum Rust version

Ruma currently requires Rust 1.45. In general, we will never require beta or nightly for crates.io releases of our crates, and we will try to avoid releasing crates that depend on features that were only just stabilized.

There are two exceptions to this:

ruma-signatures (and hence ruma with the federation-api feature) since it depends on ring, which is only guaranteed to work on the latest stable.
ruma-client depends on some I/O libraries (and also on ring, conditionally), so it is also only guaranteed to work on the latest stable.

License

MIT

Frinksy / ruma