Weechat is an extensible chat client.
Matrix 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 Python script.
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.
After Rust is installed the plugin can be compiled with:
cargo build
On Linux this creates a libmatrix.so file in the target/debug/ 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 will build and install the plugin in your
$WEECHAT_HOME as well.
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):
-
Add a server (make sure the url includes the scheme e.g. 'https://matrix.org'):
/matrix server add [server-name] [server-url] -
Set your username and password:
/set matrix-rust.server.[server-name].username [username] /set matrix-rust.server.[server-name].password [password] -
Now try to connect:
/matrix connect [server-name] -
Automatically connect to the server:
/set matrix-rust.server.[server-name].autoconnect on -
If everything works, save the configuration:
/save
/help matrix will print information about the /matrix command.
/matrix help [command] will print information for subcommands, such as /matrix help server
