Discord Bot Construction Kit 🤖

merefield · 2019 年 7 月 10 日午前 8:29

このプラグインの目的

このプラグインは以下のことを実現します：

Discourse サーバーを介して Discord ボットを動作させ、両システムを連携させる機能を提供します。このリポジトリをフォークし、簡単な Ruby コードを追加することで、あらゆるボット機能を実装できます。
既存の機能は例や便利なユーティリティとして機能します：

特定の条件を満たすコンテンツの双方向自動投稿を提供します。
任意のタイミングでメッセージを Discourse にコピーするコマンド
Discord サーバーのロールメンバーシップと Discourse インスタンスのグループメンバーシップを同期させるコマンド

このプラグインは、追加機能を実装するための拡張可能なスケルトンを提供します。一般的に有用な追加機能の PR は歓迎します。

^{これらは同期コマンドそのものではなく、可能なボット相互作用の一例です。スクリーンショットの 2 番目のコマンドは開発中に非推奨となりました；）}

設定にはある程度の複雑さが伴いますが、両システムのファンで、少なくとも機能的・概念的なレベルで各システムの仕組みを理解する時間を割く意欲がある方には最適です。このプラグインを最大限に活用するには、Discourse と Discord のユーザー管理の仕組みに関する基礎知識が必要です。

ボットコマンド

以下の 4 つのコマンドがあります：

Ping!
!disckick
!discsync
!disccopy

Ping!

ボットが応答しているか確認するには、「Ping!」と入力してください。ボットは「 : Pong!」と応答するはずです。素晴らしいですね：D（これはちょっとしたネタです！）

!disckick <min_trust_level: デフォルト 2>

このコマンドを入力すると、Discourse 上に存在するが、指定した値より低い信頼レベル（Trust Level）を持つユーザーが全員キックされます。値を指定しない場合、デフォルトは 2 です。

例：

!discsync <clean up: デフォルト false, min_visibility: デフォルト 0, include automated groups: デフォルト false>

このコマンドは、指定された条件（または指定がない場合はデフォルト）に一致するすべてのグループを Discord のロールにコピーしようとします。その後、Discourse のグループメンバーシップに基づいてロールを埋めようとします。これは一方向の同期のみで、Discourse のデータは一切変更されません。

!disccopy <number_of_messages> <optional_target_category_name> <optional_target_topic_name>

Discord チャット内から、Discord のメッセージ履歴を Discourse インスタンスにコピーできます。一度に数千件のメッセージを処理可能ですが、その場合は時間がかかります。

双方向通信

設定は以下の通りです。

プラグイン設定で、Discord の「Announcements Channel」を指定できます。
割り当てられた Discord の Announcements Channel にメッセージを入力すると、プラグイン設定で指定された Discourse のトピックに投稿されます。
誰かが特定のカテゴリに投稿したり、新しいトピックを作成したり（またはその両方）した場合に、Discord の Announcements Channel に投稿する Discourse のカテゴリリストを設定できます。
自動化されたメッセージ単位のチャットコピー：チャンネル名がカテゴリ名と一致する場合、そのチャンネルのメッセージが自動的に Discourse にコピーされます。

さらに、discordrb API がサポートする Discord イベントを管理するための新しいファイルを追加しました。Announcements ロジックが最初の例です（コミュニティ全体に有用であれば、新しいものを開発して PR を送ってください）。

NB：Discord から Discourse にコピーされたメッセージについては、ユーザーは正しく表示されます（そのユーザーが Discord ログインを使用して Discourse にログインしている場合）。つまり、Discord ボットはユーザーをマッチングできます。

このプラグインの現状

このプラグインは設定が複雑です。これは避けられないことでした。

しかし、一度セットアップが完了すれば、使用するのは子供のお遊びのように簡単です。

コードは現在ベータ版として扱ってください。テスト済みであり、本番環境でも動作していますが、バグが含まれている可能性があります。本番環境のメイン Discord サーバーに適用する前に、まずは新しい Discord サーバーでテストすることを推奨します（新規構築中の場合は除きます）。

バグが発生した場合、Discourse インスタンスよりも Discord インスタンスの方が影響を受けやすいです。なぜなら、Discourse 側には変更が加えられないからです。ただし、ほとんどの事象は回復可能であり、通常は操作を繰り返すだけで問題を解決できます。Discourse はメンバーシップとグループ情報のマスターとして使用され、このデータを使用して Discord サーバーのメンバーシップとロールが更新されます。

設定手順

前提条件

管理者権限を持つ Discord サーバー
Discord アプリ（下記参照）
Discord ボット（下記参照）
Discourse サーバーへの ssh ルートアクセス
プラグインをインストールするための app.yml の更新
プラグインをインストールするとログインページに Discord OAuth ログインが表示されるため、Discourse のすべてのユーザーは Discord OAuth ログインでログインする必要があります。

Discord アプリ

こちらにアクセスしてアプリを作成してください：

「New Application」をクリックします。

ボットを作成する必要があります。以下のような画面になります（「public」にはしないようにしてください）：

ブラウザでボットを承認する必要があります。詳細は OAuth2 - Documentation - Discord を参照してください。

ボットの設定が完了したら、トークンをコピーしてください。後で Discourse にこのトークンを入力する必要があります。

app.yml の変更

plugin

Discord Social Login が Discourse コアにネイティブで組み込まれた現在、必要なプラグインはこれだけです（やったー）

その後、通常通りプロンプトで ./launcher rebuild app を実行してください。

これで問題なく動作するはずです。

Discourse の設定画面でボットの認証情報をまだ入力していないため、初回ビルド時にコンソールやログにボットの起動失敗を示すエラーが表示される可能性があります（これをより graceful に処理するタスクが残っており、完了次第この部分は削除します）。ただし、害はなく、Discourse 自体は正常に動作します。

Discourse の管理画面に入ったら、「Plugin Settings」に以下の情報を入力してください：

ID は Discord のインターフェースから取得します。これらの ID をコピーできるようにするには、開発者モードを有効にする必要があります。Discord で「Settings」→「Appearance」→「ADVANCED」へ進み、開発者モードを有効にしてください：

その後、インターフェースから ID を取得できます。例：

Discord OAuth 設定も入力する必要があります。Client ID と Secret は、先ほど作成した同じ Discord アプリから取得します。

これらを設定したら、Linux のルートプロンプトに戻り、以下を入力してください：

./launcher restart app

Discord と Discourse サーバーが正しく設定されていれば、ボットがサーバーに参加しているのが確認できるはずです。

万が一ボットがダウンした場合（オフラインになる）、同じ手順を繰り返して再起動させる必要があります。Discourse コアサーバーからのボットの独立性を高めることは今後の課題です。とはいえ、長期間本番環境でボットを運用してきましたが、まだダウンしたことはありません。

今後のコマンドについて

Discourse と Discord の連携を活用し、コミュニティ全体に有用だと考えられる新しいコマンドのアイデアがあれば、返信でお知らせください。実装の可能性を検討します。NB：このボットは Discourse の範囲外のタスクを実行するものではありません。

制限事項

このプラグインの主な目的は、ユーザーが自身の Discord サーバーで、Discourse サーバーを動力源とするボットを作成し、基本的なメンバーシップ管理機能を実行できるようにすることでした。また、将来の両システム間の追加のボットのような相互作用のための基盤も提供します。ボットを使用する動機の一つは、単にそれがとても面白いからです。

ボットコマンドは本質的に任意（ad hoc）です。

既知の問題

サーバー上で rails console セッションに入ると、ボットが自身のインスタンスを起動してしまいます。これにより、ボットが二重に応答しているように見えます（実際にはボットが 2 つ起動しています）。rails console では、::DiscordBot::Bot.discord_bot.stop と入力して追加のボットを停止してください。これはもはや必要ありません！
‘online’ Discourse アップグレード中は、ロボットがアップグレードプロセス中に再起動され続けるため、少しおしゃべりになります。これは、ウェブサーバーから分岐したスレッドではなく、独立した管理プロセスでボットを実行する良い方法を見つけることに関連しています。ただし、これはすべて無害であると考えられますし、ボットの出力が Discord の管理者チャンネルにのみ表示されるのであれば、気にするでしょうか？ボットがリビルド中に 2 回のみ自己紹介を行うように変更したため、ほぼ解決しました。

謝辞

このプラグインの完成までに長い時間を要しましたが、@Wedgebert、@FoohonPie などのバックラーの方々に感謝します。Jeff さんの寛大なご支援に感謝します。また、@angus さんには激励と金銭的サポートの対応に感謝します。

このプラグインは、以前の段階で @Watercolor_Games さんが行った仕事に触発されたものであり、@featheredtoast さんが構築した Discord OAuth プラグインに依存しています。

また、準公式の Discord 対応 discordrb Ruby ライブラリと、システムをアクセス可能にするための Discord チームの素晴らしい取り組みに依存しています。依存関係の解決に非常に迅速に対応してくれた @Falco さんにも感謝します。

もちろん、Discourse の素晴らしいプラグインエコシステム（やったー！）がなければ、これは不可能でした。

この手順書の現状

時間とともに改善され、フィードバックを歓迎します。不明な点が残っている箇所もあるでしょう。

Owen_Walters · 2019 年 7 月 14 日午前 3:42

こんにちは、これにすごく興味があります。

逆も可能でしょうか？Discord サーバー用の Discourse 設定を作成できる方法があれば嬉しいです。ロールが付与された際の Discord API イベントがあるかどうかわかりませんが、Discord でログインしたタイミングを確認するか、CRON を使ってチェックすることはできるかもしれません。

merefield · 2019 年 7 月 14 日午前 5:26

はい、もちろん可能です。

一つの方法は、bot コマンドとしてアドホックに実装し、一定期間後にコマンドを再実行する「繰り返し機能」を備えることです（便利ですが、あまり透明性がなく、個別の繰り返しを管理する方法がありません）。

あるいは、前述したように、Discourse 内で Sidekiq ジョブとしてスケジュールされたタスクとして実装することもできます。これは別々のプラグインになるかもしれません（実際、bot 専用ソリューションに移行する前に、このアプローチの骨格を作り始めていました。なぜなら「bot」アプローチは Discord の「それ」らしく、楽しく、独自の手法と結果をもたらすからです）。しかし、Discourse から bot コマンドを起動できるようになれば、この問題は不要になります（まだテストする機会がありませんでしたが）。そうなれば、一度コードを書けばどちらの方式でも動作させることができます（素晴らしい！）。

どちらのソリューションも、同じ OAuth ログインに依存します。

これは素晴らしいアイデアですが、現在、納期を控えた他のクライアントワークが多数あるため、優先順位をつけることができません。もしこの拡張機能の開発にご協力いただけるようであれば、PM（プライベートメッセージ）でオフラインで話し合い、スケジュールを組みましょう。

Owen_Walters · 2019 年 7 月 14 日午前 6:49

試してみるのも面白いかもしれませんが、このようなアドオンを開発・保守するボランティアをするには、私のスキルレベルは程遠いです。いつか雑なフォークを作るかもしれませんが、公式のものに私の名前を付けるのは絶対に避けたいです。

merefield · 2019 年 7 月 14 日午前 6:55

思い切り汚れてみましょう。それが学ぶ唯一の方法です。:).

merefield · 2019 年 7 月 17 日午後 3:33

軽微なバグ修正をデプロイしました:

neemiasvf · 2019 年 7 月 17 日午後 4:15

再構築中にこれを受け取りました:

ボットは依然としてオフラインです。すべてを三重に確認しましたが、すべて正しく設定されています。次にどう進めればよいかわかりません… サーバーインスタンスでポートを開く必要があるかもしれません？

merefield · 2019 年 7 月 17 日午後 4:17

アップデート直後に早速テストいただきありがとうございます。再現を試みて、改めてご連絡いたします。ポート設定については変更しておりません。

merefield · 2019 年 7 月 17 日午後 4:43

こちらでは再構築に問題はありません。Bot も正常に起動しています…その間にサーバー設定を変更しましたか？

400 Bad Request というエラーは、あなたのサーバーが Discord サーバーに破損した、あるいは不正なリクエストを送信し、それに対する応答だったことを示唆しています。つまり、リクエストは正常に受信され、ブロックはされていないようです。

このエラーは、以下のケースで発生する可能性があります。

不正な形式のリクエスト
認証の欠如
レート制限の超過

残念ながら、エラーメッセージからはこれらのうちどの問題が原因かを特定することができません。

おそらく Discourse は起動していると思いますか？すべてのプラグイン設定が正しく入力されているか確認してください。

一時的な不具合の可能性を排除するため、機会を見て ./launcher restart app を実行してみてください…これによりサイトは数秒間ダウンしますが（ご迷惑をおかけして申し訳ありません）。

Falco · 2019 年 7 月 17 日午後 8:03

bot が after_initialize ブロック内で実行されているのが確認できました。これにより、bot の設定が誤っている場合や Discord がダウンしている場合に、マイグレーション（および再ビルド）が防止されます。

この例外を処理して、単にログに記録するのはどうでしょうか？

merefield · 2019 年 7 月 17 日午後 8:06

これは別スレッドで実行されるのでしょうか？であれば、問題にならないと予想されますが。

ただし、このコールバックは再構築中に何度か実行されるようです。そのため、主な問題は、認証が短時間に何度も失敗した場合、設定が誤った bot が実際にレート制限を超えてしまう可能性があることです。その場合、最悪のケースでは、アカウントが一定期間ブロックされる可能性があります。

いずれにせよ、現在の実装に基づいて即座にパッチを適用し、影響を軽減します。ご提案ありがとうございます。

更新：@falco さん、これは完了しました。例：

ransim · 2019 年 7 月 31 日午後 9:20

まず、このツールを作成していただきありがとうございます。動作するようになれば、ボランティアコミュニティの Discourse と Discord の管理において大きな助けになるはずです。

このボットを実行しようとしたところ、400 エラーが発生しています。このプラグインを追加する前は、公式の Discord 認証プラグインとチャット統合プラグインを介した Webhook を正常に使用していました。それらが引き続き適切に機能していることは確認済みです。

Discord アプリ内でボットを作成し、Discord サーバー内でボットを承認しました。メンバーリストにはオフラインとして表示されています。ドキュメントには適用する権限値について記載されていませんでしたが、私がこれまで遭遇したほとんどの Discord ボットがこれを求めていたため、管理者権限（8）を設定しました。

次に、Discord サーバー内で、アプリの名前にちなんで名付けられたロールの ID と、管理用テキストチャンネルの ID をコピーしました。念のため、そのチャンネルにアプリのロールをフル権限で追加し、その後 Discourse に ID を入力して再起動しました。

残念ながら、何をやっても 400 エラーが返ってきます。念のため再構築も試みました。

merefield · 2019 年 7 月 31 日午後 9:29

ありがとうございます、温かいお言葉です。また、支援者の皆様のご厚意のおかげで実現できました。

はい、素晴らしいです。管理者権限が必要です。

これはこの問題の2件目の報告です。

設定からトークンの最後の文字を意図的に削除した場合（これが何であるか覚えておいてください）、代わりに401エラーになりますか？

混乱を招くかもしれないので、これをダイレクトメッセージに移動させましょう（解決策はいつでもここに投稿できます）

ransim · 2019 年 8 月 1 日午後 2:26

もし他の誰かにもこの投稿が届くかもしれないので、更新情報をお知らせします。現在、この問題の原因を特定するために調査を進めていますが、まだ絞り込めていません。もし他にも同様の問題に遭遇している方がいれば、その旨をお知らせください。他の皆様によるテストが非常に役立ちます。

merefield · 2019 年 8 月 1 日午後 4:48

これはすでに修正されました。原因特定には少し手間取りました。

問題提起と原因究明のために協力してくれた @ransim に感謝します。

Discord API の #ruby_discordrb チャンネルの皆さんにも、忍耐強く瞬時に助けてくれたことに心から感謝します！

@neemiasvf

p0nda · 2019 年 8 月 30 日午前 3:04

@merefield 問題ありません。あなたのプラグインは素晴らしいです。ただ、現在いくつかの問題に遭遇しています。
例えばこのように：

Discourse Sync:  開始中。お待ちください。Discord サービスへの敬意から、レート制限が適用されています。
Discourse Sync:  同期対象のグループがあるか確認中...
Discourse Sync:  1 つの同期対象グループが見つかりました
Discourse Sync:  Discord に登録済みアカウントを持つユーザーのリストを作成中...
Discourse Sync:  Discord に登録済みアカウントを持つユーザーが所属している Discourse のグループのリストを作成中...
Discourse Sync:  Discord ユーザーを含む同期対象のグループは 0 件見つかりませんでした
Discourse Sync:  指定されたまたはデフォルトの条件を使用して、同期対象のグループ内にユーザーが見つかりませんでした！

私のコマンドは：!discsync 4

コマンド変更後：!discsync false 5 false

Discourse Sync:  開始中。お待ちください。Discord サービスへの敬意から、レート制限が適用されています。
Discourse Sync:  同期対象のグループがあるか確認中...
Discourse Sync:  10 の同期対象グループが見つかりました
Discourse Sync:  Discord に登録済みアカウントを持つユーザーのリストを作成中...
Discourse Sync:  Discord に登録済みアカウントを持つユーザーが所属している Discourse のグループのリストを作成中...

merefield · 2019 年 9 月 1 日午後 8:50

@p0nda さん、返信が遅くなり申し訳ありません。

パラメータを含める場合は、すべてを含める必要があります。何かが奇妙に解釈されている可能性があります。

blueve.in · 2019 年 9 月 17 日午前 12:38

拡張されたボット設定が表示されないのですが？app.ymlの変更とプラグインのインストールは完了しています。OAuthの設定は機能しているのですが、ボット設定が反映されません。何かアイデアはありますか？

blueve.in · 2019 年 9 月 17 日午前 11:14

OAuth 設定は存在しますが、ボット設定はありません

i3itCoin · 2019 年 9 月 17 日午前 11:16

これら

トピック		返信	表示
Discourse Trust Levels for Discord Development	61	10337	2019 年 11 月 29 日
Discord and Discourse - Better Together \| Blog Blog	12	4884	2021 年 12 月 28 日
Discord login and obtain discord roles in discourse Feature	3	2264	2019 年 11 月 21 日
Request widgetbot.io Feature	2	1157	2021 年 10 月 12 日
[PAID] 2-way sync Discord <-> Discourse Marketplace	2	991	2023 年 3 月 10 日