cshrix-bot

Master
Develop

Matrix bot using the cshrix library.

This bot is a work in progress, when it is more finalized, the core library to interact with Matrix will be extracted into its own repository.

Acknowledgements

Big thanks to the almighty @expectocode for coming up with a name for this project.

License

Copyright © 2019 by Adam Hellberg.

This Source Code Form is subject to the terms of the Mozilla Public License, v. 2.0. If a copy of the MPL was not distributed with this file, You can obtain one at http://mozilla.org/MPL/2.0/.

See the file LICENSE for more details.

Code of Conduct

This project is covered under a Code of Conduct, please remember to adhere by this when interacting with the project.

Contributing

Please see the CONTRIBUTING document for our contribution guidelines.

End-to-end (E2E) encryption

In order for E2EE features to work, libolm must be available on the system PATH or located alongside the executable (cshrix calls into it using P/Interop).

Linux

Check if your distro's package manager has libolm available. It usually goes under the name libolm and/or libolm-dev.

Debian/Ubuntu

Debian: buster/sid and later.

Ubuntu: 18.04 (bionic) and later.

# apt install libolm-dev

Arch

libolm is available in the AUR and as a git version.

Windows

As of right now (2019-04-23), no official Windows releases of libolm exist. Build the library manually and place it either somewhere on the PATH or alongside the executable.

macOS

Unknown. If someone has information about libolm on macOS, please make a PR and update this section.