No description

Find a file

Damir Jelić 1f67491325 config: Small config description fixes.		2019-01-31 10:51:51 +01:00
contrib	contrib: Add the matrix_decrypt helper.	2019-01-24 15:33:34 +01:00
matrix	config: Small config description fixes.	2019-01-31 10:51:51 +01:00
tests	Add (disabled) test for unbalanced asterisks at the start of line.	2019-01-27 15:25:43 +01:00
.gitignore	Update gitignore.	2018-11-23 18:39:03 +01:00
.pylintrc	matrix: Style fixes and cleanup.	2018-08-29 19:42:44 +02:00
.travis.yml	tests: Add travis config.	2019-01-25 22:36:25 +01:00
LICENSE	Add a license file.	2018-01-26 18:23:00 +01:00
main.py	matrix: Don't send out read markers with an empty event id.	2019-01-16 21:21:50 +01:00
Makefile	Merge branch 'olm-command'	2019-01-23 16:39:19 +01:00
README.md	readme: Add travis badge.	2019-01-27 16:26:55 +01:00
requirements.txt	tests: Add travis config.	2019-01-25 22:36:25 +01:00

README.md

What is Weechat-Matrix?

Weechat is an extensible chat client.

Matrix is an open network for secure, decentralized communication.

Weechat-Matrix is a Python plugin for Weechat that lets Weechat communicate over the Matrix protocol.

Project Status

Weechat-Matrix already supports large parts of the Matrix protocol, end to end encryption support is still experimental.

Installation

Installation is easy. As your regular user, just run: make install in this repository directory.

The following Python modules must also be available on your system:

pyOpenSSL
typing
webcolors
future (Python2 users only, see below)
atomicwrites
matrix-nio
attrs
logbook
pygments

Note that weechat only supports Python2 OR Python3, and that setting is determined at the time that Weechat is compiled. Weechat-Matrix can work with either Python2 or Python3, but when you install dependencies you will have to take into account which version of Python your Weechat was built to use.

To check the python version that weechat is using, run:

/python version

Uploads

Uploads are done using a helper script, the script found under contrib/matrix_upload should be installed under your PATH.

Configuration

Configuration is completed primarily through the Weechat interface. First start Weechat, and then issue the following commands:

Start by loading the Weechat-Matrix plugin:
```
/script load matrix.py test
```

Now set your username and password:

/set matrix.server.matrix.org.username johndoe
/set matrix.server.matrix.org.password jd_is_awesome

Now try to connect:
```
/matrix connect matrix.org
```
If everything works, save the configuration
```
/save
```

For using a custom (not matrix.org) matrix server:

Add your custom server to the plugin:

/matrix server add myserver myserver.org

Add the appropriate credentials

/set matrix.server.myserver.username johndoe
/set matrix.server.myserver.password jd_is_awesome

If everything works, save the configuration
```
/save
```

Bar items

There are two bar items provided by this script:

matrix_typing_notice - shows the currently typing users
matrix_modes - shows room and server info (encryption status of the room, server connection status)

They can be added to the weechat status bar as usual: /set weechat.bar.status.items

The matrix_modes bar item is replicated in the already used buffer_modes bar item.

Typing notices and read receipts

The sending of typing notices and read receipts can be temporarily disabled via the /room command, they can also be permanently configured using standard weechat conditions settings with the following settings:

matrix.network.read_markers_conditions
matrix.network.typing_notice_conditions

Helpful Commands

/help matrix will print information about the /matrix command.

/help olm will print information about the /olm command that is used for device verification.

/matrix help [command] will print information for subcommands, such as /matrix help server