matrix-docker-ansible-deploy/docs/configuring-playbook-bridge-mx-puppet-discord.md

1.7 KiB

Setting up MX Puppet Discord (optional)

Note: bridging to Discord can also happen via the matrix-appservice-discordand mautrix-discord bridges supported by the playbook. The mautrix-discord bridge is the most fully-featured and stable of the 3 Discord bridges supported by the playbook, so it's the one we recommend.

The playbook can install and configure mx-puppet-discord for you.

See the project page to learn what it does and why it might be useful to you.

Note: we actually use the Beeper-maintained fork of mx-puppet-discord, because matrix-discord/mx-puppet-discord is a low-quality and poorly maintained project.

To enable the Discord bridge just use the following playbook configuration:

matrix_mx_puppet_discord_enabled: true

Usage

Once the bot is enabled you need to start a chat with Discord Puppet Bridge with the handle @_discordpuppet_bot:YOUR_DOMAIN (where YOUR_DOMAIN is your base domain, not the matrix. domain).

Three authentication methods are available, Legacy Token, OAuth and xoxc token. See mx-puppet-discord documentation for more information about how to configure the bridge.

Once logged in, send list to the bot user to list the available rooms.

Clicking rooms in the list will result in you receiving an invitation to the bridged room.

Also send help to the bot to see the commands available.