| 1 | # Supported protocols |
| 2 | |
| 3 | Matterbridge supports many protocols, although not all of them support all features. Here's a list of officially-maintained and 3rd-party-maintained networks for matterbridge. |
| 4 | |
| 5 | Please let us know if you are able to regularly test and maybe maintain a specific protocol [here](https://github.com/matterbridge-org/community/issues/1). |
| 6 | |
| 7 | ## Natively supported |
| 8 | |
| 9 | - [Discord](https://discordapp.com) |
| 10 | - Matterbridge docs: |
| 11 | - [discord docs](discord/) |
| 12 | - [discord settings](discord/settings.md) |
| 13 | - Channel format: |
| 14 | - by name: `channel_name` (without the leading `#`) |
| 15 | - by ID: `ID:channel_id` |
| 16 | - [IRC](http://www.mirc.com/servers.html) |
| 17 | - Matterbridge docs: |
| 18 | - [irc docs](irc/) |
| 19 | - [irc settings](irc/settings.md) |
| 20 | - Channel format: `#channel_name` (it's all lowercase, and don't forget the leading `#`) |
| 21 | - [Jabber](https://joinjabber.org/) is the same as XMPP |
| 22 | - Matterbridge docs: |
| 23 | - [xmpp docs](xmpp/) |
| 24 | - [xmpp settings](xmpp/settings.md) |
| 25 | - Channel format: `channel_name` (for `channel_name@muc.server.org` where `muc.server.org` has been configured as `Muc` for the corresponding xmpp account) |
| 26 | - [Mastodon](https://joinmastodon.org/) |
| 27 | - Matterbridge docs: |
| 28 | - [mastodon docs](mastodon/) |
| 29 | - [mastodon application](mastodon/application.md) |
| 30 | - [Matrix](https://matrix.org) |
| 31 | - Matterbridge docs: |
| 32 | - [matrix docs](matrix/) |
| 33 | - [matrix settings](matrix/settings.md) |
| 34 | - Channel format: `#channel_name:server.org` |
| 35 | - [Mattermost](https://github.com/mattermost/mattermost-server/) (no active maintainer) |
| 36 | - Matterbridge docs: |
| 37 | - [matterbridge docs](matterbridge/) |
| 38 | - [matterbridge settings](matterbridge/settings.md) |
| 39 | - Channel format: |
| 40 | - by name: `channel_name` as seen in the URL `https://yourmattermostserver/yourteam/channels/channel_name` |
| 41 | - by ID: `ID:channel_id` |
| 42 | - [Microsoft Teams](https://teams.microsoft.com) (no active maintainer) |
| 43 | - Matterbridge [msteams docs](msteams/) |
| 44 | - Channel format: `19:82caxx@thread.skype` as seen in the URL `?threadId=19:82caxx@thread.skype` |
| 45 | - [Mumble](https://www.mumble.info/) |
| 46 | - Matterbridge [mumble docs](mumble/) |
| 47 | - Channel format: `channel_id` as seen in the channel's `Edit` window |
| 48 | - [Nextcloud Talk](https://nextcloud.com/talk/) (no active maintainer) |
| 49 | - Matterbridge [nctalk docs](nctalk/) |
| 50 | - Channel format: `channel_id` as seen at the end of URL (eg. `xs25tz5y`) |
| 51 | - [Rocket.chat](https://rocket.chat) (no active maintainer) |
| 52 | - Matterbridge docs: |
| 53 | - [rocketchat docs](rocketchat/) |
| 54 | - [rocketchat settings](rocketchat/settings.md) |
| 55 | - Channel format: `#channel_name` (don't forget the leading `#`, even on private channels) |
| 56 | - [Slack](https://slack.com) (no active maintainer) |
| 57 | - Matterbridge docs: |
| 58 | - [slack docs](slack/) |
| 59 | - [slack settings](slack/settings.md) |
| 60 | - Channel format: |
| 61 | - by name: `channel_name` (without the leading `#`) |
| 62 | - by ID: `ID:channel_id` (does not work with webhooks!) |
| 63 | - [Ssh-chat](https://github.com/shazow/ssh-chat) (no active maintainer) |
| 64 | - Matterbridge [sshchat docs](sshchat/) |
| 65 | - Channel format: Only a single `sshchat` channel is supported |
| 66 | - [Telegram](https://telegram.org) |
| 67 | - Matterbridge docs: |
| 68 | - [telegram docs](telegram/) |
| 69 | - [telegram settings](telegram/settings.md) |
| 70 | - Channel format: |
| 71 | - for channels/groups: `-channel_id` where `channel_id` is a large number (see FAQ) |
| 72 | - for forum topics (sub-groups): `-100channel_id/topic_id` (see FAQ), except the first `General` topic which is `-100channel_id` (**not** `-100channel_id/1`) |
| 73 | - [Twitch](https://twitch.tv) (no active maintainer) |
| 74 | - Matterbridge [twitch docs](twitch/) |
| 75 | - Channel format: `#channel_name` (it's all lowercase, and don't forget the leading `#`) |
| 76 | - [VK](https://vk.com/) (no active maintainer) |
| 77 | - Matterbridge [vk docs](vk/) |
| 78 | - Channel format: `channel_id` (see FAQ) |
| 79 | - [WhatsApp](https://www.whatsapp.com/) |
| 80 | - Matterbridge docs: |
| 81 | - [whatsapp docs](whatsapp/) |
| 82 | - [whatsapp settings](whatsapp/settings.md) |
| 83 | - Channel format: |
| 84 | - by JID: `channel_id@g.us` (if `Channel=""`, matterbridge will list all channels known to the bot) |
| 85 | - by name: `channel_name` (**not recommended**, and matterbridge will warn you against it because group names can change over time) |
| 86 | - [XMPP](https://xmpp.org) |
| 87 | - Matterbridge docs: |
| 88 | - [xmpp docs](xmpp/) |
| 89 | - [xmpp settings](xmpp/settings.md) |
| 90 | - Channel format: `channel_name` (for `channel_name@muc.server.org` where `muc.server.org` has been configured as `Muc` for the corresponding xmpp account) |
| 91 | - [Zulip](https://zulipchat.com) (no active maintainer) |
| 92 | - Matterbridge docs: |
| 93 | - [zulip docs](zulip/) |
| 94 | - [zulip settings](zulip/settings.md) |
| 95 | - Channel format: `stream/topic:channel_name` (where `channel_name` has no leading `#`) |
| 96 | |
| 97 | ## Dropped official support |
| 98 | |
| 99 | - [Keybase](https://keybase.io) |
| 100 | - Dropped because noone is maintaining it on our side |
| 101 | - Reach out [here](https://github.com/matterbridge-org/community/issues/1) if you want to help bring it back |
| 102 | - [Gitter](https://gitter.im) |
| 103 | - Has moved to matrix protocol |
| 104 | - [Harmony](https://harmonyapp.io) |
| 105 | - Does not exist anymore? |
| 106 | - [Steam](https://store.steampowered.com/) |
| 107 | - Not supported anymore, see [here](https://github.com/Philipp15b/go-steam/issues/94) for more info. |
| 108 | |
| 109 | ## 3rd party via matterbridge api |
| 110 | |
| 111 | - [Delta Chat](https://github.com/deltachat-bot/matterdelta) |
| 112 | - [Minecraft](https://github.com/raws/mattercraft) |
| 113 | - [Minecraft](https://gitlab.com/Programie/MatterBukkit) |
| 114 | - [MatterLink](https://github.com/elytra/MatterLink) (Matterbridge link for Minecraft Forge server chat, archived) |
| 115 | - [MatterCraft](https://github.com/raws/mattercraft) (Matterbridge link for Minecraft Forge server chat) |
| 116 | - [MatterBukkit](https://gitlab.com/Programie/MatterBukkit) (Matterbridge link for Minecraft Bukkit/Spigot server chat) |
| 117 | - [pyCord](https://github.com/NikkyAI/pyCord) (crossplatform chatbot) |
| 118 | - [Mattereddit](https://github.com/bonehurtingjuice/mattereddit) (Reddit chat support) |
| 119 | - [ServUO-matterbridge](https://github.com/kuoushi/ServUO-Matterbridge) (A matterbridge connector for ServUO servers) |
| 120 | - [beerchat](https://github.com/mt-mods/beerchat) (Matterbridge link for minetest) |
| 121 | - [nextcloud talk](https://github.com/nextcloud/talk_matterbridge) (Integrates matterbridge in Nextcloud Talk) |
| 122 | |
| 123 | |
| 124 | ### Past 3rd party projects |
| 125 | |
| 126 | - [Discourse](https://github.com/DeclanHoare/matterbabble) |
| 127 | - [Facebook messenger](https://github.com/powerjungle/fbridge-asyncio) |
| 128 | - [Facebook messenger](https://github.com/VictorNine/fbridge) |
| 129 | - [Minecraft](https://github.com/elytra/MatterLink) |
| 130 | - [Reddit](https://github.com/bonehurtingjuice/mattereddit) |
| 131 | - [MatterAMXX](https://github.com/andrewlindberg/MatterAMXX): [Counter-Strike, half-life and more](https://forums.alliedmods.net/showthread.php?t=319430) |
| 132 | - [Vintage Story](https://github.com/NikkyAI/vs-matterbridge) (last commit: February 4th 2021) |
| 133 | - [Ultima Online Emulator](https://github.com/kuoushi/ServUO-Matterbridge) |
| 134 | - [Teamspeak](https://github.com/Archeb/ts-matterbridge) |
| 135 | - [ts-matterbridge](https://github.com/Archeb/ts-matterbridge) (Integrate teamspeak chat with matterbridge) (archived September 25th 2022) |
| 136 | |
