matrix-puppet-discord_ynh/README.md
2022-11-07 15:01:38 +01:00

3.1 KiB

Matrix-Discord bridge for YunoHost

Integration level Working status Maintenance status
Install Matrix-Discord bridge with YunoHost

Lire ce readme en français.

This package allows you to install Matrix-Discord bridge quickly and simply on a YunoHost server. If you don't have YunoHost, please consult the guide to learn how to install it.

Overview

This is a discord puppeting bridge for matrix. It handles bridging private and group DMs, as well as Guilds (servers). It is based on mx-puppet-bridge.

Features

  • Direct (1:1) Chats
  • DM Group Chats
  • Plain Text
  • Formatted Messages
  • Media/files
  • Redactions/Deletions
  • Presence (Discord → Matrix only)
  • Typing notifications (Discord → Matrix only)
  • Replies
  • Edits
  • Reactions
  • Stickers
  • Multi-user
  • Friends management
  • Initiate chats from matrix

How to

See https://gitlab.com/mx-puppet/discord/mx-puppet-discord for documentation.

Shipped version: 0.1.7~ynh4

Screenshots

Screenshot of Matrix-Discord bridge

Disclaimers / important information

After the install is complete, start a chat with @_discordpuppet_bot:yourserver.com. When it joins, type help in the chat to see instructions.

You also may modify the /etc/matrix-puppet-discord/user.config.yaml file to customize some configuration (like permissions to use the bridge). Ensure then to restart the bridge (systemctl restart matrix-puppet-discord).

Documentation and resources

Developer info

Please send your pull request to the testing branch.

To try the testing branch, please proceed like that.

sudo yunohost app install https://github.com/YunoHost-Apps/matrix-puppet-discord_ynh/tree/testing --debug
or
sudo yunohost app upgrade matrix-puppet-discord -u https://github.com/YunoHost-Apps/matrix-puppet-discord_ynh/tree/testing --debug

More info regarding app packaging: https://yunohost.org/packaging_apps