# README

DiscordSlackSynchronizer

概要

　Slack → Discord，Discord → Slack の同期を行う。

使用方法

settings.jsonの追加

バイナリと同階層に次を配置。ただし、後述の環境変数を指定することで設定ファイルを他の場所に配置することも可能。

[
    {
        "discord_server": "DISCORD_SERVER_ID",
        "channel": [
            {
                "slack": "SLACK_CHANNEL_ID",
                "discord": "DISCORD_CHANNEL_ID",
                "hook": "https://discordapp.com/api/webhooks/DISCORD_CHANNEL_HOOK_URL",
                "setting": {
                    "slack2discord": true,
                    "discord2slack": true,
                    "ShowChannelName": false
                }
            },
            {
                "slack": "SLACK_CHANNEL_ID",
                "discord": "all",
                "setting": {
                    "slack2discord": true,
                    "discord2slack": true,
                    "ShowChannelName": true,
                    "SendMuteState":false,
                    "SendVoiceState": true
                }
            }
        ]
    }
]

"discord":"all"以下の設定は全てのdiscordチャンネルに反映されます。
- この設定は必ず一番下に記述してください
その他の個別に指定したチャンネル設定はそちらが優先される。

Discordへアプリ追加

追加時は、次のスコープが必要

ManageWebhook
ReadMessages/ViewChannels
Read Message History
UseVoiceActivity

Slackへアプリ追加

次のスコープが必要

channels:history
channels:read

chat:write
chat:write.customize
chat:write.public

files:read
files:write

emoji:read

groups:history
groups:read

reactions:read

remote_files:write
remote_files:read

users.profile:read
users:read

chat:write:user
emoji:read:user

チャンネルの追加

Slackの該当チャンネルルに該当Botを招待

環境変数

さらに、次の環境変数を追加する必要がある。

SLACK_API_TOKEN=xoxb-xoxb-*****
SLACK_API_USER_TOKEN=xoxp-*****
SLACK_EVENT_TOKEN=xapp-*****

DISCORD_BOT_TOKEN=Discord Bot Token
DISCORD_ENABLE_MODIFY_MESSAGES=yes/no # Discordのメッセージ編集の許可

Discordの全チャンネルをSlackのそれぞれの同名のチャンネルに共有する

CreateSlackChannelOnSendを有効にすると、Discordの新規チャンネルにより、Slackのチャンネルも作られる。

all-allは現在1slack-discord関係にしか対応していません。

[
  {
    "discord_server": "*****************",
    "slack_suffix": "-discord",
      {
        "slack": "all",
        "discord": "all",
        "setting": {
          "slack2discord": true,
          "discord2slack": true,
          "ShowChannelName": false,
          "SendVoiceState": false,
          "SendMuteState": false,
          "CreateSlackChannelOnSend": true
        }
      },
  }
]

参考

WebhookURLs.jsonの内容はプログラム起動時にキャッシュされるので、設定変更した場合再起動が必要。
複数サーバ／複数チャンネルも対応。
Discordに転送しない場合，slackMap.jsonの"hook"の記述は不要。

WebConfigurator

追加で起動時に次の環境変数の指定が必要

SOCK_TYPE=tcp/unix/指定がなければ無効化
LISTEN_ADDRESS=Listen addr

デーモン化するときの都合などで settings.json を移動させなければいけない場合は、次の環境変数で、設定ファイルのディレクトリを指定することで設定が可能

STATE_DIRECTORY=/var/lib/...(例)

DiscordPrimaryIDPluginInterface

このBotでは、DISCORD_ENABLE_MODIFY_MESSAGES=yes を設定することで、ユーザによるメッセージの編集を許可できます。

この機能において、メッセージの編集を作成者のみが行えるように、Discordのメッセージ送信時、初期状態ではメッセージの送信者名の後に、Discordのユーザ番号を付加することで、メッセージの送信者情報を保持します。

もし、利用するコミュニティに於いて、ユーザに対して一意に定まるユーザID(以下PrimaryID)が別に存在する場合、それを用いることもできます。

次のようなインターフェイスを満たしたバイナリを、DiscordSlackSynchronizerの配置ディレクトリから見て、 plugin/discord(.exe) に置いておくことで、これを実現できます。

実行時に、プログラムに対し、次のような標準入力が与えられます。

MODE
ID

ここで MODE と ID は次の組み合わせであたえられます。

MODE	ID
GetPrimaryID	探したいユーザのDiscordID
GetDiscordID	探したいユーザのPrimaryID

プログラムはこれに対し、次のような標準出力を与える必要があります。

MODE	出力
GetPrimaryID	探したいユーザのPrimaryID
GetDiscordID	PrimaryIDに対応するユーザが持つDiscordIDをカンマ区切りで表したもの

Copyright