discord-bcdicebot

概要

Discord で BCDice を使うための bot です。各サーバに対して、ユーザが導入して利用します。

DOWNLOAD

必要なもの

このアプリは Discord のチャットに参加するユーザのうち、1人の環境で動かす必要があります。動かす人には以下の準備が求められます

Java 8 ないしそれ以降の実行環境

Java 実行環境 のインストール方法は Javaをインストールするには をご覧ください。

BCDice-API サーバ

BCDice-API が動作しているサーバを用意してください。ローカルでも構いませんし、貸してくれる人から借りてもかまいません。

サーバに導入する手順

概要

1. Discord の開発者ページからダイスボットを作成しサーバに導入する
2. DOWNLOAD から Discord-Bcdicebot をダウンロードし、start.bat ないし start.sh に Bot の Token 情報と BCDice-API の情報を記入する
3. start.bat ないし start.sh を実行する

詳細1. ダイスボットを登録し、サーバに導入する

Discord に新規の Bot を作成します。サーバに導入するため、サーバ管理者がこれを実行することになるでしょう。

1. 開発者ページ にアクセスし、画面右上の New Application をクリックします
2. 名前とアイコンを設定し、Discord Application を作成します
3. 名前とアイコンの下にある APPLICATION ID の数字をメモします
4. 画面左側のメニューから Bot を選択し、Add Bot と書かれたボタンをクリックし、このダイスボット用のユーザを作成します
5. Bot の Username の下に "Token:click to reveal" というのがあるのでクリックし、出てくるランダムな文字列をメモします。この文字列は他の人に教えないこと。
   この文字列は NDA0MgAIC0QK18lU0dxMt99F.HuWAIt.Nh9OTLbjxdMp3pcmw3Lsqd4aQlb のような形式の値となります（この値はダミーです）。
   General Information 記載の d70963bg6e4df564f3648c87c514f15bef8ce3b38af1156800bcc3395c062f80 のような値ではありません。
6. 次の URL にアクセスします
   https://discordapp.com/oauth2/authorize?client_id=[Client Id の数字]&scope=bot&permissions=0
7. アクセスした画面から Bot を導入できるので、入れたいサーバに Bot を導入します

詳細2. start.bat または start.sh を編集する

DOWNLOAD から Discord-Bcdicebot をダウンロードし、解凍します。
その上で同梱されている start.bat を以下のように編集します（Linux/macOS を使っている方は以下を参考に start.sh を編集してください）。

@echo off
cd /d %~dp0

set DISCORD_BOT_TOKEN=詳細1.の5で得たランダムな文字列
set BCDICE_API_URL=BCDice-APIサーバのURL
set IGNORE_ERROR=
set BCDICE_PASSWORD=管理用のパスワード。ここに入れた文字列がパスワードとして設定される
set BCDICE_API_SECONDARY=予備のBCDice-APIサーバのURL
REM set BCDICE_DEFAULT_SYSTEM=DiceBot
REM set BCDICE_MENTION_MODE=1
REM set BCDICE_RESULT_DISPLAY_FORMAT=V1

java -jar discord-bcdicebot.jar %DISCORD_BOT_TOKEN% %BCDICE_API_URL% %IGNORE_ERROR%
pause

BCDICE_API_URL と BCDICE_API_SECONDARY の右に入力する値はhttps://api-status.bcdice.org/ に記載されている公開サーバを利用する方が良いでしょう。 各公開サーバには利用ルールがあるため、利用前に事前にご確認ください。

詳細3. start.bat または start.sh を実行する

先に編集した start.bat をダブルクリックすることでダイスボットが起動します。黒い背景に白い文字が出ているウィンドウが表示され、そこにダイスボットの実行ログが表示されます。

ダイスボットを終了する時は表示されているウィンドウを消すか、キーボードの Ctrl+C を押してください。

なんか動かない……

Windows 環境の方は同梱してある validate.bat をダブルクリックすることで何が問題なのか確認するツールが動作します。 それでもわからない場合は validate.bat の結果を後述の "質問・バグ報告はどこに" 記載の連絡先に送ってください。

利用する

ダイスを振る

チャットにただただ BCDice のコマンドを書き込めばダイスが振られます。
例えば 2d6 等と書き込めばサイコロを2つ振った合計値が得られます。
どのようなコマンドが利用できるのかは BCDice コマンドリストをご参照ください。

BCDice にはない独自の振り方として、[と]でカンマ区切りのリストを与えるとそのリストのそれぞれについてダイスを振ることができます。
例えば[こぶた,たぬき,きつね,ねこ] 2d6 とすることでこぶた、たぬき、きつね、ねこのそれぞれについて 2d6 を振ることが可能です。

設定を変更する

以下のような設定をアプリの機能で実施可能です。

例えば CoC 7版のダイスボットを使いたい時は使いたいテキストチャンネルでbcdice set Cthulhu7thと入力し、ダイスボットのシステムを CoC 7版のものに設定します。
その上でCC<=25 【目星】等と書き込めば CoC 7版の判定ができます。

管理コマンドを使う

パスワードは start.bat ないし start.sh で設定した BCDICE_PASSWORD の値を用いてください。

https://bcdice.onlinesession.app/
https://bcdice.trpg.net/

Room-System List
655334231928733699:SwordWorld2.5
768400929514061826:SwordWorld2.0
665445513117564962:SwordWorld2.5
643025877055176707:DoubleCross
general:DiceBot
		

bcdice admin myPassw0rd import
655334231928733699:SwordWorld2.5
768400929514061826:SwordWorld2.0
665445513117564962:SwordWorld2.5
643025877055176707:DoubleCross

Bot が登録されている Discord サーバの情報を取得する

Bot が登録されているサーバの一覧を取得するには次のようにします。
bcdicediscord [パスワード] listServers

Bot が登録されているサーバに存在する部屋の一覧を取得するには次のようにします。情報は
bcdicediscord [パスワード] listRooms

Bot が登録されているサーバに存在する部屋の ID 一覧を取得するには次のようにします。
bcdicediscord [パスワード] listRoomIds

オリジナルダイスボット表の管理

管理者はオリジナルダイスボット表を追加することもできます。

オリジナルダイスボット表を追加する場合は Discord にオリジナルダイスボット表の情報をアップロードし、アップロード時のコメントに次のように記載してください。
bcdice admin [パスワード] addDiceBot [オリジナルダイスボット表名]
追加した後オリジナルダイスボット表の名前がチャット上で発言されるとオリジナルダイスボット表が振られます。 この際にアップロードするオリジナルダイスボット表のサンプルは オリジナル表 · BCDiceコマンドガイド ないしはdiscord-bcdicebot/originalDiceBots/サンプルダイスボット-夜食表を参照してください。
両者でフォーマットが異なりますが、どちらも利用できます。
また、追加するダイスボット表は UTF-8 で作成されている必要があります。 Windows 付属のメモ帳であれば名前を付けて保存する際に保存ボタンの左に「文字コード」を選択できる箇所があります。ここで UTF-8 を選択した上で保存してください。

オリジナルダイスボット表を削除する際は以下のようにしてください。
bcdice admin [パスワード] removeDiceBot [オリジナルダイスボット表名]
オリジナルダイスボット表の一覧は次のようにすると確認できます。
bcdice admin [パスワード] listDiceBot

中級者以上向け：heroku を使って動かす手順

PaaS サービス heroku を使って discord-bcdicebot を動かすことも可能です。
少なくとも2021年8月時点ではクレジットカード情報を登録することで無料の範囲内でダイスボットを常動させる事が可能です。

ただし、Git と Heroku を使える必要があり、Heroku については英語で書かれたウェブサイト上での操作が必要となります。

1. Git を導入します。Git： https://git-scm.com/
2. Heroku のアカウントを作成します。Heroku: https://www.heroku.com/home
3. Heroku CLI を導入します。インストールガイド： https://devcenter.heroku.com/articles/heroku-cli
4. GitHub からソースコードを clone してきます。URL は git@github.com:Shunshun94/discord-bcdicebot.git
5. clone してきたディレクトリ内で heroku login を実行し、ログインします
6. clone してきたディレクトリ内で heroku create を実行し、heroku 上に App を作成します
7. clone してきたディレクトリ内で git push heroku master を実行し、heroku 上にソースコードを push します
8. clone してきたディレクトリ内で以下を実行し、環境変数を設定します
   • 先の 4. でメモした Token を登録します
     heroku config:set DISCORD_BOT_TOKEN=NDA0MgAIC0QK18lU0dxMt99F.HuWAIt.Nh9OTLbjxdMp3pcmw3Lsqd4aQlb (トークンはダミーです)
   • 利用する BCDice-API サーバの URL を登録します
     heroku config:set BCDICE_API_URL=http://xxxx.xxxxx.xxxxx.example.com/ (URL はダミーです)
   • 管理用パスワードを設定します
     heroku config:set BCDICE_PASSWORD=MY_PASSWORD (MY_PASSWORD を任意の文字列に書き換えてください)
9. (必須ではない) 以下の環境変数を設定します。
   • 予備の BCDice-API サーバを登録します。
     heroku config:set BCDICE_API_SECONDARY=http://xxxx.xxxxx.xxxxx.example.com/ (URL はダミーです)
   • どのシステムのダイスボットを使うのか設定していない部屋で利用するダイスボットを設定します。
     heroku config:set BCDICE_DEFAULT_SYSTEM=DiceBot (DiceBot は任意のシステムに書き換えてください)
   • ダイスを振った時に振った人にメンションを飛ばすようにします。
     heroku config:set BCDICE_MENTION_MODE=1
   • ダイスを振った時の結果にシステム名を添えるようにします。
     heroku config:set BCDICE_RESULT_DISPLAY_FORMAT=V1
10. Heroku の Dashboard から worker を起動します。
    Heroku の Dashboard：https://dashboard.heroku.com/

連絡先

バグ報告など

Twitter アカウントは@Shunshun94。ないしはリポジトリに issue を追加してください。

寄付先

Amazon のウィッシュリスト

ライセンス

使用しているライブラリ

• (Eclipse Public License - v 1.0) (GNU Lesser General Public License) Logback Classic Module (ch.qos.logback:logback-classic:1.2.3 - http://logback.qos.ch/logback-classic)
• (Eclipse Public License - v 1.0) (GNU Lesser General Public License) Logback Core Module (ch.qos.logback:logback-core:1.2.3 - http://logback.qos.ch/logback-core)
• (Apache License, Version 2.0) xsalsa20poly1305 (com.codahale:xsalsa20poly1305:0.10.1 - https://github.com/codahale/xsalsa20poly1305)
• (MIT License) minimal-json (com.eclipsesource.minimal-json:minimal-json:0.9.5 - https://github.com/ralfstx/minimal-json)
• (The Apache Software License, Version 2.0) Jackson-annotations (com.fasterxml.jackson.core:jackson-annotations:2.9.0 - http://github.com/FasterXML/jackson)
• (The Apache Software License, Version 2.0) Jackson-core (com.fasterxml.jackson.core:jackson-core:2.9.3 - https://github.com/FasterXML/jackson-core)
• (The Apache Software License, Version 2.0) jackson-databind (com.fasterxml.jackson.core:jackson-databind:2.9.3 - http://github.com/FasterXML/jackson)
• (The Apache Software License, Version 2.0) com.neovisionaries:nv-websocket-client (com.neovisionaries:nv-websocket-client:2.6 - https://github.com/TakahikoKawasaki/nv-websocket-client)
• (Apache 2.0) OkHttp Logging Interceptor (com.squareup.okhttp3:logging-interceptor:3.9.1 - https://github.com/square/okhttp/logging-interceptor)
• (The Apache Software License, Version 2.0) okhttp (com.squareup.okhttp3:okhttp:4.9.1 - https://square.github.io/okhttp/)
• (The Apache Software License, Version 2.0) Okio (com.squareup.okio:okio:2.8.0 - https://github.com/square/okio/)
• (The Apache Software License, Version 2.0) Vavr (io.vavr:vavr:0.10.1 - http://vavr.io)
• (The Apache Software License, Version 2.0) Vavr Match (io.vavr:vavr-match:0.10.1 - http://vavr.io)
• (Eclipse Public License 1.0) JUnit (junit:junit:4.13.1 - http://junit.org)
• (Apache License, Version 2.0) Apache Commons Lang (org.apache.commons:commons-lang3:3.9 - http://commons.apache.org/proper/commons-lang/)
• (Apache License, Version 2.0) Apache Log4j API (org.apache.logging.log4j:log4j-api:2.14.0 - https://logging.apache.org/log4j/2.x/log4j-api/)
• (Apache License, Version 2.0) Apache Log4j Core (org.apache.logging.log4j:log4j-core:2.14.0 - https://logging.apache.org/log4j/2.x/log4j-core/)
• (Bouncy Castle Licence) Bouncy Castle Provider (org.bouncycastle:bcprov-jdk15on:1.59 - http://www.bouncycastle.org/java.html)
• (New BSD License) Hamcrest Core (org.hamcrest:hamcrest-core:1.3 - https://github.com/hamcrest/JavaHamcrest/hamcrest-core)
• (Apache License, Version 2.0) Javacord (org.javacord:javacord:3.3.2 - https://www.javacord.org)
• (Apache License, Version 2.0) Javacord (api) (org.javacord:javacord-api:3.3.2 - https://www.javacord.org)
• (Apache License, Version 2.0) Javacord (core) (org.javacord:javacord-core:3.3.2 - https://www.javacord.org)
• (The Apache Software License, Version 2.0) IntelliJ IDEA Annotations (org.jetbrains:annotations:13.0 - http://www.jetbrains.org)
• (The Apache License, Version 2.0) org.jetbrains.kotlin:kotlin-stdlib (org.jetbrains.kotlin:kotlin-stdlib:1.4.10 - https://kotlinlang.org/)
• (The Apache License, Version 2.0) org.jetbrains.kotlin:kotlin-stdlib-common (org.jetbrains.kotlin:kotlin-stdlib-common:1.4.0 - https://kotlinlang.org/)
• (MIT License) SLF4J API Module (org.slf4j:slf4j-api:1.7.25 - http://www.slf4j.org)

利用しているサービス

ゲーム設定型ダイスボット「ボーンズ＆カーズ」

どどんとふを初めとする多くのオンセツールで採用されているダイスボット。略称は BCDice。修正BSDライセンスでライセンスされています。

BCDice-API

BCDice に HTTP による API を付与するラッパ。MIT ライセンスでライセンスされています。

Discord

ボイスチャットアプリ。パソコンからでも携帯からでも利用可能。

本アプリのライセンス

このアプリ (ソースコードなどを含む) は GPLv3 でライセンスします。
ソースコードはhttps://github.com/Shunshun94/discord-bcdicebotから入手可能です。

Q&A

質問・バグ報告はどこに

@Shunshun94 ないしは github の issues に。

どんな出力が出たのか、出力をコピペして頂けると調査が捗ります。

ダイスを振った時にメンションしてほしいんだけど

環境変数 BCDICE_MENTION_MODE になんらかの値を入れた状態で bot を起動してください

Version 2? Version 1 との差異として気を付けるべき点は何？

以下について変更が入っています。

• 古いオリジナルダイスボット表で利用できた help のフォーマットが利用できなくなります。help の際は表の内容を全部出力します
• BCDice-API v2 の API が有効でないサーバでは利用できません

Version 1 を使いたいのだけれども

こちらからダウンロードいただけます。ただし今後更新はされません

なんで Java なの。Ruby とか○○とかじゃないの

一般ユーザの PC に Ruby や○○の実行環境が導入されているとは思えなかった

じゃあ単体実行できるバイナリでいいじゃん

Mac ユーザやら Linux ユーザやらごとにバイナリを作るのが面倒だった。 Linux はともかく Mac ユーザはいる気がしたから

ダイスを振るコマンド以外を入力すると [ERROR][500] ～ って出る。設定は合っているはずなのに

start.bat の IGNORE_ERROR=0 の 0　を 1 と書き入れてみてください。治るかもしれません

管理用のパスワードはどこ？

環境変数BCDICE_PASSWORDの値が使われます。
環境変数を指定していない場合は起動直後に Admin Password: SGO7C0XYtBJouE75 みたいな文字列がでます。この英数字ランダム16桁の文字列がパスワードです。起動するたびに変わるので注意してください

謝辞

お世話になった方々

BCDice を作成・公開してくださったFacelessさんと、 Ruby 移植をしてくださったたいたい竹流さん。 さらにメンテを引き継いでくださっている酒田　シンジさん。 そもそも、BCDice が無ければこのアプリは着想すらありませんでした。 BCDice が多機能である点、2017年現在、国内オンラインセッションツールのデファクトスタンダードであるどどんとふが採用しているダイスボットであるため、 国内におけるダイスボットのデファクトスタンダードが BCDice となっていたことが実装の必要を感じたそもそもの理由でした。

BCDice-API を実装・公開してくださった酒田　シンジさん。 BCDice-API が無ければ本アプリの実装は気が遠くなるものだったに違いありません。

発表前の動作確認に付き合ってくださったかし＊さんと離凛さん。 色々な想定漏れについて指摘していただき、公開前にアプリが大幅に改善されました。

PR や問題の指摘等をくださった酒田　シンジさん、シーラさん、 cardinalさん、おちゃさん、 yoshi さん、水篠 日和さん。（順番は時期順） 頂いた PR やご指摘等に基づいて色々と修正や追加機能、利用しやすくするための措置をとれました。

DiscordでDiceBot(BCDice)を使う方法その1・その2を書いてくださった えいむさん。画像つきのかなりわかりやすいガイドを書いて頂き、導入して頂きやすくなりました。

関連アプリの紹介

Nanasu さんが作ってくださったBCDiscord for Browser　のコマンドは本アプリの物を参考にしてくださいました。 ブラウザのみで動くため、大変に便利です。

更新履歴

v2.5.2

start.sh を修正しました（詳細）。連絡くださったおちゃさん、ありがとうございます！

v2.5.1

本ドキュメントのタイポを修正しました

v2.5.0

テキストチャットに入力された情報がダイスコマンドか否かのチェックに BCDice が提供している情報を用いるように変更しました

シークレットダイスの挙動について修正しました。古いシークレットダイスの情報を削除できるようにしました

v2.4.0

DiscordでDiceBot(BCDice)を使う方法へのリンクを追加しました。書いてくださったえいむさん、ありがとうございます！

導入手順を全体的に修正しました

validate.bat を追加しました

環境変数 BCDICE_RESULT_DISPLAY_FORMAT の値が V1 の場合、ダイスを振った際にシステム名を付けて結果を表示するように変更

v2.3.0

いくつかのライブラリについて更新

2 NotDiceRollのようなフォーマットの発言を行った際に警告メッセージが暴発する問題に対処しました

v2.2.3

一部のダイスを振った結果の表示が崩れる問題に対処しました

オリジナルダイスボット表に関する一部挙動を修正しました（詳細）。連絡くださった水篠 日和さん、ありがとうございます！

管理用の部屋一覧を取得するコマンドの挙動を一部修正しました

v2.2.2

自動テストに関連する不備に対処しました（詳細）。連絡くださったおちゃさん、ありがとうございます！

v2.2.1

start.sh の文字コードが変わっていて正しく機能しなかった問題に対処しました（詳細）。連絡くださったおちゃさん、ありがとうございます！

v2.2.0

Heroku 上で動かすための設定ファイル Procfile を追加しました。ファイルを共有してくださった yoshi さん、ありがとうございます！（詳細）

Bot が登録されているサーバの情報を取得できるようにしました

オリジナルダイスボット表に関する問題をいくらか修正しました

v2.1.0

環境変数 BCDICE_MENTION_MODE に何らかの値が入っている場合、ダイスを振った際に振った人にメンションを付けて結果を表示するように変更

v2.0.2

bcdice help SYSTEM_NAME がうまく動かない問題を報告いただき、修正しました。h-mikisato さん、ありがとうございます！（詳細）

システム設定のインポート・エクスポートの出力を修正しました

オリジナルダイスボット表の繰り返しコマンドについて出力を修正しました

v2.0.1

オリジナルダイスボット表に関する問題を修正しました

v2.0.0

BCDice-API 2.0 に対応しました

コマンド中に全角スペースが含まれている場合、半角スペースとして扱うようにしました

v1.14.5

このファイルのタイポを修正頂きました（詳細）。yoshi さん、ありがとうございます！

v1.14.4

利用しているライブラリを更新しました

v1.14.3

利用しているライブラリを更新しました

アプリ内で使っている用語のいくつかを修正しました

v1.14.2

ヘルプとマニュアルの修正を実施しました

v1.14.1

利用する予定の BCDice API サーバを一覧する機能を追加しました

利用する予定の BCDice API サーバから特定のサーバを削除する機能を追加しました

挙動を安定させるために若干修正を加えました

複数回振る時の挙動に関するバグを修正しました

v1.14

オリジナルのダイスボット表にヘルプテキストを追加できるようにしました

複数回ロールする機能で発生していたいくつかのバグを修正しました

Discord の API 仕様変更の予定に追随しました

v1.13.1

マニュアルを少し修正

v1.13

ダイスを一度に複数回振る機能を追加しました

BCDice API サーバが不調の際に別の BCDice API サーバに自動で切り替える機能を追加しました

ダイスボットの種類を指定していない際に利用されるデフォルトのダイスボットを指定する機能を追加しました

v1.12.2

システムの名称にスペースが入っている場合にダイスボットの設定やコマンドの参照ができない問題を修正しました

v1.12.1

ダイスを振る際に接頭語を必要とする設定にしている際、オリジナルのダイスボットについて接頭語の設定が有効になってなかった問題を修正しました

v1.12

BCDice-API へのリクエスト送信頻度を下げる機能を追加しました

管理者がオリジナルのダイスボット表を追加できる機能を追加しました

v1.11

たまに BCDice-API へのリクエストが上手くいかない問題に対して対処しました

パスワードを指定する機能を追加しました

v1.10

Linux/macOS 環境向けの起動スクリプトを追加。スクリプトを共有くださったおちゃさん、ありがとうございます！

v1.9

ダイスボットのスペルが間違えている時に警告が出ない問題を解消しました

v1.8.1(2019/07/24)

本ドキュメントの軽微な修正を実施しました

v1.8(2019/07/23)

ダイスコマンドに関するバグを修正しました (詳細)。

管理用コマンドとして BCDice-API の接続先を変更する機能を追加しました

管理用コマンドとして全部屋に設定されたダイスボット一覧を取得する機能を追加しました

管理用コマンドとして全部屋にダイスボットを設定する機能を追加しました

v1.7(2019/06/10)

bcdice list でダイスボットの一覧が表示されないことがある問題を修正しました

v1.6(2018/11/11)

一部のエラーを無視する機能を追加しました。詳しくは上述の ダイスを振るコマンド以外を入力すると [ERROR][500] ～ って出る。設定は合っているはずなのに を参照してください

設定用コマンドを一部修正しました

v1.5(2018/03/24)

ダイスコマンドに関するバグを修正しました (詳細)。問題の指摘と修正手法の共有をしてくださったcardinal さん、ありがとうございます！

v1.4(2017/10/07)

利用しているライブラリ起因の問題に対してライブラリをバージョンアップして対応しました。問題の指摘をくださったシーラさん、ありがとうございます！

アプリ終了後に待機するように start.bat を変更しました。ログの収集が容易になりました

v1.3(2017/07/13)

Channel 毎に異なるダイスボットを利用できるように変更しました。特に設定していない場合は general のものを利用しています

v1.2(2017/07/06)

BCDice-API v0.4.0 に対応しました。問題の指摘をくださった酒田　シンジさん、ありがとうございます！

v1.1.1(2017/06/30)

本ドキュメントの権利的な問題に対応しました

v1.1(2017/06/30)

いくらかの内部的な問題を修正。機能への変更はありません

v1.0 (2017/06/26)

公開