Skip to content

mc-wiki/discord-zulip-bridge

Repository files navigation

discord-zulip-bridge

Features

  • Two-way Discord-Zulip message relay
  • Supports message edit/delete/reply with SQLite
  • Converts Discord/Zulip specific message format
    • Reply (except ping)
    • Quote block
    • Message link
    • Channel mention
    • Discord message forwarding
    • Discord embeds
    • Escape wildcard mention
    • Timestamp
    • File
    • Silent mention
    • Zulip linkifier

Setup

  1. Install latest LTS Node.js
  2. Run npm install and npm run build
  3. Create .env file with:
DISCORD_TOKEN=""
DISCORD_ID="(Discord user id of the bot)"
ZULIP_ID="(Zulip user id of the bot)"
ZULIP_USERNAME="(This is the bot email)"
ZULIP_API_KEY=""
ZULIP_REALM="https://mc-wiki.zulipchat.com"
  1. Create config.json file with:
{
	"ignored_discord_users": [],
	"ignored_zulip_users": [],
	"upload_files_to_zulip": false
}
  1. Run npm start to start the bridge
  2. See Commands to set up channel links

Commands

The !bridge command is available to configure channel links. You can use this command by DMing the bot on Zulip. Note that you must be an admin to perform this.

  • Syntax: !bridge <zulipChannelMention> <discordChannelId> <includeThreads>
  • Options:
    • zulipChannelMention: Mention the channel on Zulip
    • discordChannelId: You can obtain this by turning on User Settings > Advanced > Developer Mode and right click the channel to copy its ID
    • If includeThreads is true, threads created on the Zulip/Discord channel will be synced to the respective Discord/Zulip channel.
  • Example: !bridge #**Channel>Topic** 123456789012345 true

Releases

No releases published