aioappsrv/README.md

52 lines
1.6 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
2020-12-23 05:52:13 +01:00
A simple non-puppeting bridge between Matrix and Discord written in Python.
2020-11-12 15:59:10 +01:00
## Installation
`pip install -r requirements.txt`
## Usage
* Run `main.py` to generate `config.json`
* Edit `config.json`
2021-01-24 07:35:45 +01:00
```
{
"homeserver": "https://matrix.org",
"username": "@name:matrix.org",
"password": "my-secret-password",
"token": "my-secret-token",
"discord_prefix": "my-command-prefix", # Prefix for Discord commands
"bridge": {
"channel_id": "room_id", # Bridge multiple channels and rooms
"channel_id2": "room_id2"
}
}
```
2021-02-06 07:53:49 +01:00
* Logs are saved to the `bot.log` file in `$PWD`.
2021-01-02 13:58:24 +01:00
* Normal Discord bot functionality like commands can be added to the bot via [cogs](https://discordpy.readthedocs.io/en/latest/ext/commands/cogs.html), example [here](https://gist.github.com/EvieePy/d78c061a4798ae81be9825468fe146be).
2021-01-27 13:18:09 +01:00
* Replace `guild.emojis` with `self.discord_client.emojis` (`Callbacks()`, `process_message()`) to make the Discord bot use emojis from ALL it's guilds.
2021-01-21 08:20:58 +01:00
2020-11-16 09:41:13 +01:00
NOTE: [Privileged Intents](https://discordpy.readthedocs.io/en/latest/intents.html#privileged-intents) must be enabled for your Discord bot.
2021-01-21 08:58:40 +01:00
## Screenshots
2021-02-01 07:16:20 +01:00
TODO
2021-01-21 08:58:40 +01:00
2020-11-12 15:59:10 +01:00
## What Works
- [x] Sending messages
2020-11-13 11:08:28 +01:00
- [x] Discord webhooks (with avatars)
2020-12-02 16:04:12 +01:00
- [x] Attachments (Converted to URLs)
- [x] Typing status (Not very accurate)
2020-11-15 16:33:54 +01:00
- [x] Redacting messages
- [x] Editing messages
- [x] Replies
- [x] Bridging multiple channels/rooms
2021-02-01 07:14:17 +01:00
- [x] `:emote:` in Matrix message converted to Discord emotes
2021-01-10 18:40:11 +01:00
- [x] Discord emotes bridged as inline images (Works on Element Web, Fluffychat)