No description

Find a file

Damir Jelić 92ff15943c server: Turn the connected flag into a property. This way we update the necessary bar items automatically, when we change the flag.		2019-01-24 11:54:22 +01:00
contrib	matrix: Add initial upload support.	2019-01-13 12:33:25 +01:00
matrix	server: Turn the connected flag into a property.	2019-01-24 11:54:22 +01:00
tests	Add test for normalization of spaces in inline code.	2019-01-16 16:37:53 +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
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	Fix Markdown for command segments in README	2019-01-23 22:02:19 +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
http-parser
future (Python2 users only, see below)
atomicwrite
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. If you are unsure, Python2 is a good first guess.

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
```

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