Discord読み上げBot「shovel」の使い方

Discord読み上げBot「shovel」の使い方を説明します。読み上げの始め方、単語登録の方法、声の設定方法を紹介します。Botの更新とあわせてこちらのページを更新しますので、転載は行わず当ページへリンクしていただくようご協力ください。

shovelの本、通販実施中

技術書典7にて、同人誌「DiscordBot運営実践入門」を頒布しました。
本書は「shovel」の開発・運営についての経験をもとに、セキュリティやユーザーサポートなど、BotやWebサービスを運用するうえで必要となるものごとについて手広くカバーした本です。
shovelユーザーに行ったアンケート結果なども掲載しています。興味のある方は是非ご一読ください。

とらのあな
BOOTH

基本的な使い方

招待のしかた

以下URLから招待できます。
shovel_red, shovel_greenは、shovel(青)もあわせて使っていただくと便利です。

shovel(青)
shovel_red
shovel_green

shovel_red, shovel_greenの使い方

shovelは、「コマンド」を使って操作します。「コマンド」は、「プレフィックス」に「コマンド文字列」をつづけることで起動できます。
「プレフィックス」は、3つのshovelそれぞれで異なります。

メッセージが表示されないときは

shovelからのメッセージは、すべて「埋め込み」という形式で表示されます。
shovelの投稿内容がからっぽに見えるときは、以下手順で「埋め込み」が表示されるように設定を変更してください。

1. 「設定」を開く
2. 「テキスト・画像」を開く
3. 「チャットで投稿されたリンクのサイト情報を表示する」をONに変更

読み上げ

読み上げをはじめる / s(shovel)

コマンドを実行したテキストチャンネルの読み上げを開始します。
あなたが参加しているボイスチャンネルに入るので、あらかじめボイスチャンネルに入ったうえで、このコマンドを実行してください。

あなたが参加していないボイスチャンネルで読み上げをさせたい場合、上記のようにボイスチャンネル名を指定して実行してください。
「ボイスチャンネル1」はボイスチャンネルの名前に置き換えてください。

すでに読み上げを開始しているとき、別のテキストチャンネルでこのコマンドを使うと、
そのテキストチャンネルも読み上げ対象になります。（上限3チャンネル）

読み上げを終わる / e(end)

すべてのテキストチャンネルの読み上げを終了します。このコマンドを実行しなくても、ボイスチャンネルにメンバーがいなくなるとshovelは読み上げを終了します。

読み上げを実施していないときにこのコマンドを実行すると、読み上げを強制終了できます。
読み上げがうまくいかないときや、読み上げ終了後もボイスチャンネルにshovelが残ったとき、もう一度このコマンドを実行してみてください。

特定チャンネルの読み上げ終了 /ec(end_channel)

コマンドを実行したテキストチャンネルのみ、読み上げを終了します。
他のチャンネルの読み上げは継続したまま、あるチャンネルのみ読み上げを終了したいときに利用します。

基本：辞書操作

shovelは、ひとつのサーバーにつき、ひとつの辞書を持ちます。

辞書に単語を登録する / aw(add_word)

「単語」と「読み方」のペアを、辞書に登録します。
すでに同じ単語が登録されている場合、読み方を上書きします。

辞書の単語を削除する / dw(delete_word)

単語を削除します。

応用：辞書操作

辞書をみる / export_word

登録されている単語の一覧が記録された辞書ファイルを取得します。

まとめて単語登録 / import_word

添付ファイルに含まれる単語をまとめて辞書に登録します。
export_wordで取得したファイルをこのコマンドに添付することで、ほかのサーバーに登録されている単語をまるまる持ってくることができます。

単語を全て削除する / delete_all_word

そのサーバーの辞書の内容をすべて削除します。

応用：声設定

shovelはあなたの声を自動的に生成しますが、声を変えたいときは、コマンドを使って自分で設定することもできます。

声を設定する / uv(update_voice)

声設定を変更します。
!sh uvに続いて、声種別、喋る速さ、声の高さの順に指定します。

上記のテキストボックスの内容は、「通常の声種別」「喋る速さ 0.3」「声の高さ -0.4」のように設定するコマンドです。

速度・高さは、-1.0～1.0の範囲で指定します。
種別は、以下の5種類から選択できます。

• normal (通常)
• happy (テンションたかめ)
• bashful (ささやき声)
• angry (強め)
• sad (しょんぼり)

声の設定を確認する / gv(get_voice)

このコマンドで、現在の声設定を確認できます。
声設定を一度も設定したことがなければ、自動的に生成された声設定の内容を表示します。

応用：詳細設定

読み上げ先を変更する / m(move)

読み上げを流すボイスチャンネルを変更します。

読み上げ文字数を変更する / read_limit

1つの投稿につき、だいたい何文字くらいまで読み上げるかを設定します。
この文字数を超えた場合、「以下略」と言います。

複数行読み上げ設定 / read_multi

2行目以降を読み上げるかどうかを設定します。on / offを指定してください。
通常はoffになっています。

名前読み上げ設定 / read_name

読み上げ時、発言者の名前を一緒に読み上げるかどうかを設定します。on / offを指定してください。
通常はoffになっています。

絵文字読み上げ設定 / read_emoji

読み上げ時、絵文字を読み上げるかどうかを設定します。on / offを指定してください。
通常はonになっています。

shovelの操作を制限する / white_list_role

指定した役職を持つユーザー以外の、shovelのサーバーに関する設定の書き込み（辞書操作、サーバー設定）を制限することができます。
この設定をしても、読み上げの開始・終了、声設定やhelp等はだれでも行うことができます。

制限される操作

この機能を使うと、以下のコマンドは役職名役職を持つユーザー以外実行不可となります。
※ もともと管理者しか使えないコマンドはリストから省いています

!sh read_multi
!sh read_name
!sh read_limit
!sh aw(add_word)
!sh dw(delete_word)
!sh export_word

制限対象外の操作

この機能を使っても、以下のコマンドはだれでも使えます。

!sh s(shovel)
!sh e(end)
!sh m(move)
!sh ec(end_channel)
!sh uv(update_voice)
!sh gv(get_voice)
!sh about
!sh help

設定を確認する / ss(server_settings)

サーバーの設定を確認します。

応用：小技

ある文章だけ読み上げさせない

「;（半角セミコロン）」を発言の最初につけると、その文章は読み上げなくなります。
長文を引用したいときなどに便利です。

プライバシーポリシー

shovelは、読み上げに必要な最低限の情報のみを取得し、用途が終わり次第、すみやかに除去します。
機能をみたすために、shovelに指示したコマンドの内容、shovelに対して行った各種設定はディスク上に保持しますが、それ以外の読み上げ内容や会話をディスク上に保持したり、第三者に譲渡したり、管理者が閲覧することは一切ありません。
なお、これはcodがホストするshovel(ID: 533698325203910668),にのみ適用されるものであり、その他ユーザーによりホストされるshovelについては、ホストユーザーによるプライバシーポリシーに従うものとします。