https://github.com/ruma/ruma

A set of Rust crates for interacting with the Matrix chat network.
https://github.com/ruma/ruma

chat library matrix-org rust

Last synced: 11 days ago
JSON representation

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

• Host: GitHub
• URL: https://github.com/ruma/ruma
• Owner: ruma
• License: mit
• Created: 2020-06-03T12:05:42.000Z (over 4 years ago)
• Default Branch: main
• Last Pushed: 2024-04-22T01:37:34.000Z (7 months ago)
• Last Synced: 2024-04-22T12:01:46.665Z (7 months ago)
• Topics: chat, library, matrix-org, rust
• Language: Rust
• Homepage: https://ruma.io
• Size: 11 MB
• Stars: 550
• Watchers: 18
• Forks: 138
• Open Issues: 94
• Metadata Files:
  • Readme: README.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE

Awesome Lists containing this project

• awesome-starred - ruma/ruma - A set of Rust crates for interacting with the Matrix chat network. (rust)

README

        
# Ruma – Your home in Matrix.

A set of [Rust] crates (libraries) for interacting with the [Matrix] chat

network.

[website] • [chat] • [documentation][docs] ([unstable][unstable-docs])

[Rust]: https://rust-lang.org/

[Matrix]: https://matrix.org/

[website]: https://ruma.dev/

[chat]: https://matrix.to/#/#ruma:matrix.org

[docs]: https://docs.rs/ruma/

[unstable-docs]: https://docs.ruma.dev/ruma/

## 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:

```toml

# crates.io release

ruma = { version = "0.11.0", features = ["..."] }

# git dependency

ruma = { git = "https://github.com/ruma/ruma", branch = "main", features = ["..."] }

```

`ruma` re-exports all of the other crates, so you don't have to worry about

them as a user. Check out the documentation [on docs.rs][docs] (or on

[docs.ruma.dev][unstable-docs] if you use use the git dependency).

You can also find a small number of examples in our dedicated

[examples repository](https://github.com/ruma/examples).

[matrix-rust-sdk]: https://github.com/matrix-org/matrix-rust-sdk#readme

[feat]: https://github.com/ruma/ruma/blob/1166af5a354210dcbced1eaf4a11f795c381d2ec/ruma/Cargo.toml#L35

## Status

Ruma 0.11.0 supports all events and REST endpoints of Matrix 1.12.

Various changes from in-progress or finished MSCs are also implemented, gated

behind the `unstable-mscXXXX` (where `XXXX` is the MSC number) Cargo features.

A few less formalized things are gated behind the `unstable-unspecified` Cargo

feature.

## Contributing

See [CONTRIBUTING.md](CONTRIBUTING.md).

## Minimum Rust version

Ruma currently requires Rust 1.75. 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.

`ruma-signatures` is an exception: It uses cryptographic libraries that often

use relatively new features and that we don't want to use outdated versions of.

It is guaranteed to work with whatever is the latest stable version though.

## License

[MIT](https://opensource.org/licenses/MIT)