https://github.com/etkecc/rust-mxlink

A library for connecting (linking) to the Matrix Client Server API (for building bots, etc.)
https://github.com/etkecc/rust-mxlink

Last synced: 6 months ago
JSON representation

A library for connecting (linking) to the Matrix Client Server API (for building bots, etc.)

• Host: GitHub
• URL: https://github.com/etkecc/rust-mxlink
• Owner: etkecc
• License: lgpl-3.0
• Created: 2024-09-11T11:41:58.000Z (about 1 year ago)
• Default Branch: main
• Last Pushed: 2025-04-12T04:38:53.000Z (8 months ago)
• Last Synced: 2025-05-28T17:57:19.119Z (6 months ago)
• Language: Rust
• Size: 293 KB
• Stars: 3
• Watchers: 2
• Forks: 2
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

          
## Matrix Link

Matrix Link (`mxlink`) is a Rust library (a higher-level abstraction on top of [matrix-rust-sdk](https://github.com/matrix-org/matrix-rust-sdk)) for building Matrix services (bots, etc.)

It's similar to [headjack](https://github.com/arcuru/headjack), but tries to be less opinionated and more [featureful](#-features).

It finds use in the [🤖 baibot](https://github.com/etkecc/baibot) Matrix bot.

### ✨ Features

- 🎈 Easy to use API for getting started with [matrix-rust-sdk](https://github.com/matrix-org/matrix-rust-sdk). See the [examples](./examples/) directory or [baibot](https://github.com/etkecc/baibot)

- 🔒 Encryption

  - (Optional) At-rest encryption of the session file

  - At-rest encryption of the SQLite data store (performed by matrix-rust-sdk itself)

- 🔄 (Optional) Support for using matrix-rust-sdk's [recovery](https://docs.rs/matrix-sdk/latest/matrix_sdk/encryption/recovery/index.html) module for backing up and restoring encryption keys (in case of session / SQLite store data loss)

- 🖴 [Helpers](./src/helpers/account_data_config) for working with Matrix Account Data on a per-room level or globally

- 🗂 Some convenience functions around Matrix APIs