https://github.com/baines/morpheus
IRC ↔ Matrix gateway
https://github.com/baines/morpheus
c irc-gateway matrix
Last synced: 24 days ago
JSON representation
IRC ↔ Matrix gateway
- Host: GitHub
- URL: https://github.com/baines/morpheus
- Owner: baines
- License: mit
- Created: 2017-07-22T22:56:47.000Z (almost 9 years ago)
- Default Branch: master
- Last Pushed: 2018-04-02T10:24:17.000Z (about 8 years ago)
- Last Synced: 2025-12-02T13:44:12.597Z (7 months ago)
- Topics: c, irc-gateway, matrix
- Language: C
- Size: 48.8 KB
- Stars: 4
- Watchers: 2
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: readme.md
- License: LICENSE
Awesome Lists containing this project
README
# What is this?
Morpheus is a **Work in progress** IRC gateway to a [Matrix](https://matrix.org) server.
It translates between the two protocols so that you can view Matrix rooms via
any IRC client.
# Is it a bridge like appservice-irc?
Matrix's appservice-irc bridges rooms on an existing Matrix server with rooms on
an existing IRC server. With morpheus *there is no IRC server*.
In other words, morpheus acts as an IRCd itself, providing a view onto a Matrix
server through the IRC protocol
# Why would I want this?
There are two main reasons:
1) You have an IRC bot that you want to have on a Matrix server without changing
any of its code.
2) You are connected to other IRC networks in your favourite IRC client, and
would rather use that than a separate program to talk on Matrix.
# What works currently?
* Multiple clients
* Everything going via epoll
* Logging in via PASS + USER
* Joining / Parting rooms
* Messages to channels
* canonical alias is used as the IRC channel name
* Private messages to users
* transparently creates / re-uses 1:1 private rooms
* works with query buffers in IRC clients
* Message formatting
* converts between IRC control codes and org.matrix.custom.html format
* Setting room topics
* Converting inline media to links
* IRCv3 Capabilities
* server-time for old messages
* away-notify for presence updates (not fully implemented)
* Other stuff I'm probably forgetting
# What needs to be done?
* Kicking / banning
* Giving unique nicks to users from other homeservers
* Sort of done, via 4-digit suffix, but not ideal.
* TLS support on the IRC socket via mbedTLS
* It may be worth leaving this to something external like stunnel.
* Considerations for large servers like matrix.org, i.e. not flooding the nick list with inactive names.
* Although presence seems broken on matrix.org...
* Other stuff, see TODO.txt
# Other caveats?
* It's written in C and has not been thoroughly tested or cleaned up (yet),
so there are probably horrendous memory corrupting, world-destroying bugs
lurking within. Use at your own risk!
* GNU/Linux only currently.
# Usage
Edit start.sh, setting `MTX_URL` and maybe `MTX_LISTEN_PORT`.
`MTX_URL` should be a url like `https://localhost:8448` or `https://matrix.org`,
pointing to the remote matrix server.
`MTX_LISTEN_PORT` is the port on which the local "IRCd" side of morpheus will listen.
Next, add a server to your IRC client. Assuming you're running morpheus on your local
computer, you'd add a server of 127.0.0.1/PORT where PORT is what you set `MTX_LISTEN_PORT`
to, or 1999 by default. Set the username and server password to your matrix userid and password.
If all goes well, you should be connected to the matrix server when you connect to morpheus.
# Misc
You can change the device_id and device_name that will be sent to the matrix
server with the `MTX_DEVICE_ID` and `MTX_DEVICE_NAME` environment variables.
This is not especially useful currently, however.