72 lines
2.7 KiB
Markdown
72 lines
2.7 KiB
Markdown
[](https://github.com/poljar/weechat-matrix-rs/actions/workflows/release.yml)
|
|
[](https://matrix.to/#/!twcBhHVdZlQWuuxBhN:termina.org.uk?via=termina.org.uk&via=matrix.org)
|
|
[](https://github.com/poljar/weechat-matrix-rs/blob/master/LICENSE)
|
|
|
|
# What is weechat-matrix?
|
|
|
|
[Weechat](https://weechat.org/) is an extensible chat client.
|
|
|
|
[Matrix](https://matrix.org/blog/home) is an open network for secure,
|
|
decentralized communication.
|
|
|
|
weechat-matrix-rs is a Rust plugin for Weechat that lets Weechat communicate
|
|
over the Matrix protocol. This is a Rust rewrite of the
|
|
[weechat-matrix](https://github.com/poljar/weechat-matrix) Python script.
|
|
|
|
# Project status
|
|
|
|
This project is a work in progress and doesn't do much yet. It can connect
|
|
to a Matrix server and send messages.
|
|
|
|
If you are interested in helping out take a look at the issue tracker.
|
|
|
|
# Build
|
|
|
|
After Rust is installed the plugin can be compiled with:
|
|
|
|
cargo build --release
|
|
|
|
If you are developing on weechat-matrix-rs, use debug builds which are faster at the expense of plugin performance:
|
|
|
|
cargo build
|
|
|
|
On Linux this creates a `libmatrix.so` file in the `target/release/` (`target/debug` for dev builds) folder, this
|
|
file needs to be renamed to `matrix.so` and copied to your Weechat plugin
|
|
directory. A plugin directory can be created in your `$WEECHAT_HOME` folder, by
|
|
default `.weechat/plugins/`.
|
|
|
|
Alternatively, `make install` (`make install PROFILE=debug` for dev build) will build and install the plugin in your
|
|
`$WEECHAT_HOME` as well.
|
|
|
|
# Configuration
|
|
|
|
Configuration is completed primarily through the Weechat interface. First start Weechat, and then issue the following commands _(replace the placeholders in brackets [] with your own details)_:
|
|
|
|
1. Add a server _(make sure the url includes the scheme e.g. 'https://matrix.org')_:
|
|
|
|
/matrix server add [server-name] [server-url]
|
|
|
|
2. Set your username and password:
|
|
|
|
/set matrix-rust.server.[server-name].username [username]
|
|
/set matrix-rust.server.[server-name].password [password]
|
|
|
|
3. Now try to connect:
|
|
|
|
/matrix connect [server-name]
|
|
|
|
4. Automatically connect to the server:
|
|
|
|
/set matrix-rust.server.[server-name].autoconnect on
|
|
|
|
5. If everything works, save the configuration:
|
|
|
|
/save
|
|
|
|
|
|
# Helpful Commands
|
|
|
|
`/help matrix` will print information about the `/matrix` command.
|
|
|
|
`/matrix help [command]` will print information for subcommands, such as `/matrix help server`
|