aioappsrv/README.md

32 lines
1.3 KiB
Markdown
Raw Normal View History

2020-11-11 16:46:15 +01:00
# matrix-discord-bridge
2020-11-12 15:59:10 +01:00
A simple bridge between Matrix and Discord written in Python.
2020-11-12 15:59:10 +01:00
This repository contains two bridges:
2021-12-09 09:13:13 +01:00
* A [puppeting appservice](appservice): The puppeting bridge written with minimal dependencies. Running this requires a self-hosted homeserver.
2020-11-12 15:59:10 +01:00
2022-09-23 15:36:03 +02:00
* A [non-puppeting bridge](bridge): The non-puppeting plaintext bridge written with `matrix-nio` and `discord.py`, most people would want to use this one if running on heroku or similar and don't have their own server. **NOTE:** This is unmaintained and might break in the future due to Discord changes.
2020-11-12 15:59:10 +01:00
Check their READMEs for specific information.
2021-01-21 08:58:40 +01:00
2022-01-09 12:59:04 +01:00
![Demo](demo.png)
2020-11-12 15:59:10 +01:00
## What Works
- [x] Puppeting (Appservice only, regular bridge only uses webhooks on Discord.)
- [x] Attachments (Converted to URLs.)
- [x] Typing Indicators (Per-user indicators on Appservice, otherwise sent as bot user.)
- [x] Message redaction
- [x] Replies
- [x] Bridging multiple channels
- [x] Discord emojis displayed as inline images
- [x] Sending Discord emotes from Matrix (`:emote_name:`)
- [x] Mentioning Discord users via partial username (`@partialname`)
2021-07-25 09:26:52 +02:00
## TODO
- [ ] Handle cases where the webhook is messed with on the Discord side (Deleted/Edited by someone other than the bot).
- [ ] Use embeds on Discord side for replies.
- [ ] Unbridging.