An early attempt at an irssi Matrix module. Very early alpha state.
Find a file
Andrej Kacian adf15859b3 Require Irssi version at least 1.5
This is because of MSGLEVEL_PUBNOTICES that we use,
which does not yet exist in Irssi 1.4.x.
Closes issue #7.
2024-06-19 23:04:29 +02:00
src Fix a crash on room join 2024-03-31 23:02:07 +02:00
.gitignore Update .gitignore file 2021-07-27 20:42:08 +02:00
autogen.sh Do not hardcode sh-path 2024-06-18 14:25:00 +03:00
configure.ac Require Irssi version at least 1.5 2024-06-19 23:04:29 +02:00
COPYING Add license file 2021-07-09 00:16:54 +02:00
Makefile.am Add user-install make target 2021-07-09 00:16:54 +02:00
README.md Specify required Irssi version in README 2023-11-07 11:00:46 +01:00

Matrix client module for Irssi

This is still an early work in progress. The module so far can:

  • define a Matrix connection (with some manual Irssi config editing)
  • connect to a Matrix server
  • authenticate using either a password or an existing access token
  • recognize joined rooms and create channel windows in Irssi for each
  • poll for new events
  • show some basic room events like joins, leaves and text messages
  • send basic text messages to rooms
  • ...and that's it

Installation

Requires:

To build, use the usual autotools steps:

  • ./autogen.sh
  • ./configure
  • make && sudo make install

Usage

Due to how networks and servers work in Irssi, the way to define a Matrix connection is a bit peculiar:

  1. Load the module in Irssi
/load matrix
  1. Add a network definition manually in your irssi configuration, in "chatnets" section. Something like:
matrix_foo = { type = "matrix"; };
  1. Start Irssi and load the "matrix" module.
  2. Create a server in the added network, using your Matrix ID as server address.
/server add -network matrix_foo @foo:example.org 0 secretpassword

...or, if you want to use access token from an existing Matrix login session...

/server add -network matrix_foo -access_token mysecrettoken @foo:example.org
  1. Connect to the network, or to the server
/connect matrix_foo

...or...

/connect @foo:example.org

Contact

I am "Ticho" on #irssi channel on Libera IRC network, or "@ticho:cyberdi.sk" on Matrix.