ノートとペンを持って考えごとをするはなこ
Documentation

Hanakoの使い方ガイド。

はじめて使う人にも、使いこなしたい人にも向けて、Hanakoの使い方をひととおりまとめました。

CHAPTER 01 / GETTING STARTED

はじめかたは、4ステップ。

ひとことで

ボイスチャンネルに入って/plz。以上です。

Hanakoは、呼んだ人がいるボイスチャンネルに参加して、呼ばれたテキストチャンネルの発言を読み上げます。面倒な設定はいりません。

STEP 1 ボイスチャンネルに入る 先にあなたが参加しておく
STEP 2 /plzと打つ 読んでほしいテキストチャンネルで
STEP 3 Hanakoが参加 そのチャンネルの発言を読み上げる
STEP 4 /byeで退出 誰もいなくなれば自動で退出

読み上げを始めてから終わるまでの流れ

覚えておくと便利なこと

  • Hanakoが参加しているときに、別のテキストチャンネルでもう一度/plzを打つと、そのチャンネルも読み上げの対象に加わります。
  • ボイスチャンネルに付いているテキストチャットで/plzを打てば、そこが読み上げの対象になります。
  • ボイスチャンネルにHanakoだけが残ると、自動で退出します。
  • メンテナンスで再起動したときは、元のボイスチャンネルに自動で再接続し、読み上げを再開します。
対応していない場所 スレッド、フォーラム、アナウンスチャンネルは読み上げできません。ステージチャンネルにも参加できません。
CHAPTER 02 / INPUT METHODS

コマンドの打ち方は、3通り。

同じコマンドを3通りの書き方で実行できます。使いやすいものを選びましょう。迷ったら、スラッシュコマンドがおすすめです。

おすすめ

スラッシュコマンド

/teach from:草 to:くさ

入力欄に/を打つと候補と説明が出ます。引数の名前が表示されるので打ち間違えにくく、一覧系の結果は自分にだけ表示されます。

テキスト

メンション

@はなこ teach 草 くさ

Hanakoにメンションして、コマンド名と引数をスペース区切りで続けます。教育のような日本語の別名も使えます。

テキスト

プリフィックス>

>teach 草 くさ

発言の先頭に>を付けます。いちばん少ない文字数で打てます。

読まれたくない発言は>で始めよう >で始まる発言は、コマンドとして存在しない内容でも読み上げられません。独り言やメモを書きたいときに便利です。

スラッシュコマンドとテキストコマンドの違い

スラッシュコマンド テキストコマンド
一覧・検索・ヘルプの結果 自分にだけ見える チャンネルの全員に見える
全削除の確認 「実行する」ボタンを押す コマンドに--forceを付ける
SEを複数まとめて追加・削除 1件ずつ まとめてできる
使える人の決まり方 サーバー管理者が自由に変更できる 固定(08章を参照)
サーバーごとに無効化 できない /text-commandsで無効にできる
  • スラッシュコマンドは、自分にだけ見える返事や確認ボタン、コマンドごとの使える人の設定など、Discordの機能をフルに使えます。
  • テキストコマンドのほうが便利なのは、SEを複数まとめて追加・削除するときだけです。
  • ふだんはスラッシュコマンド、SEをまとめて登録・整理したいときだけテキストコマンド、という使い分けがおすすめです。
  • テキストコマンドは使える人を細かく変えられません。権限をきっちり管理したいサーバーでは、/text-commandsで止めておけます。
CHAPTER 03 / HOW IT READS

発言が声になるまでの、5つの手順。

サングラスをかけてこちらを指さすはなこ(ハナキン)

発言は、次の5つの手順を順に通って声になります。思ったとおりに読まれなかったときや、まったく読まれなかったときは、この順番をたどると理由がわかります。

  1. 読むかどうかを決める 読み上げ対象チャンネルの、人間の発言だけを通します(下の表を参照)。
    @ぴよ HANAKINの動画見た https://youtu.be/abc (拍手) :hanako_hey: 今更メントスコーラ?っておもったけどNOPEでやってる動画はじめてみたかも
  2. 読める形に直す URLは「ユーアールエル」に、メンションは表示名に、絵文字は名前に置き換えます。
    @ぴよ HANAKINの動画見た ユーアールエル (拍手):hanako_hey: 今更メントスコーラ?っておもったけどNOPEでやってる動画はじめてみたかも
  3. 辞書で読み替える 教育した単語を置き換えます。SEのキーワード部分は書き換えません。
    @ぴよ ハナキンの動画見た ユーアールエル (拍手):hanako_hey: 今更メントスコーラ?っておもったけどNOPEでやってる動画はじめてみたかも
  4. 長すぎたら切る 文字数制限を超えた分を切り捨て、最後に「イか略。」と読みます。短すぎて途中で切れてしまう場合は、サーバー管理者が/limitで上限を増やすか、/limit number:0で制限をなくせます(06章を参照)。
    @ぴよ ハナキンの動画見た ユーアールエル (拍手):hanako_hey: 今更メントスコーラ?っておもったけどNOPイか略。
    // 60文字を超えた「Eでやってる動画はじめてみたかも」を切り捨て
  5. 声とSEに分けて再生する SEのキーワードは効果音に、それ以外は合成音声になり、順番に再生されます。
    🗣 @ぴよ ハナキンの動画見た ユーアールエル 🎺 (拍手) 🗣 :hanako_hey: 今更メントスコーラ?っておもったけどNOPイか略。

例:辞書に「HANAKIN → ハナキン」、SEに「(拍手)」を登録し、文字数制限を60文字にしているサーバーでの読み上げ

読み上げられない発言

発言 理由・対処
読み上げ対象でないチャンネルの発言 そのチャンネルで/plzを打つと対象に加わります
>で始まる発言、Hanakoへのメンション コマンドとして扱うため読みません
ほかのBotの発言 常に読みません
ブラックリストに入っている人の発言 07章を参照
画像やファイルだけの発言 本文がないので読みません
記号や空白だけの発言 声にできる文字がないので読みません
スレッド・フォーラム内の発言 対応していません

読み上げを止める「成敗」

長文やSEが流れ続けて困ったときは/seibaiを使います。いま読んでいる音声と、その後ろで順番待ちしている音声をすべて中断します。Hanakoは退出しないので、次の発言からまた読み上げます。

  • だれでも使えます。権限は要りません。荒らしや貼り付け事故を見かけたら、気づいた人がすぐ止められます。
  • 止まるのは「いま溜まっている分」だけ。辞書やSE、読み上げ対象チャンネルの設定はそのまま残ります。
  • テキストでも呼べます。>成敗や>stopと打っても同じです。
  • 何も読んでいないときに打つと「安心せい、みねうちにゃ…」と返ります。

知らないと、長文が終わるまで全員で待つことになります。サーバーのメンバーにも教えてあげてください。

刀を振り抜く、和装のはなこ
CHAPTER 04 / DICTIONARY

読み方を、辞書で教える。

読み間違える単語や、内輪の呼び名の読み方を教える機能です。サーバーごとに10,000件まで覚えます。サーバーの中で使われている言葉を、Hanakoに教えていきましょう。

STEP 1 発言 「電ちゃんかわいい」
STEP 2 辞書 電 ⇨ いなづま
STEP 3 読み上げ 「いなづまちゃんかわいい」

読み上げる直前に発言の中の単語を置き換えます。チャットに書かれた発言そのものは変わりません

やりたいこと コマンド
単語を教える /teach from:置換前 to:置換後
単語を忘れさせる /forget from:置換前
覚えている単語を見る /dictionary(ボタンでページ送り)
すべて忘れさせる /dictionary-clear(サーバー管理の権限が必要)

登録するときの注意

  • 置換前・置換後とも2〜50文字。1文字の単語は登録できません。
  • 同じ「置換前」は1つだけ。読み方を変えたいときは、いちど/forgetしてから教え直します。
  • 単語の一部にも反応します。短い単語を登録すると、思わぬ言葉の中で置き換わることがあります。
  • SEのキーワードになっている部分は、辞書では置き換えません(SEが優先されます)。
CHAPTER 05 / SOUND EFFECTS

キーワードで、効果音を鳴らす。

キーワードに音声ファイルを結びつけると、その言葉が発言に出てきたとき、読み上げの代わりに音を鳴らします。チャットがライブ会場のようににぎやかになります。

SEを追加する3つの方法

スラッシュ / テキスト

URLで指定

/se-add keyword:(拍手) url:https://…/clap.mp3

ネット上の音声ファイルのURLを指定します。URLは300文字まで。

スラッシュ / テキスト

ファイルを1つ添付

/se-add keyword:(拍手)を打ち、fileに添付

手元のファイルをそのまま登録できます。テキストコマンドなら@はなこ se-add (拍手)と打って添付します。

まとめて登録

複数ファイルをまとめて

@はなこ se-addと打ち、複数のファイルを添付

キーワードを書かずに添付すると、拡張子を除いたファイル名がそのままキーワードになります。テキストコマンドだけで使えます。

登録できるファイル

形式 .wav、.mp3
サイズ 1ファイル2MBまで
長さ 60秒まで
キーワード 2〜50文字(同じキーワードは1つだけ)
登録数 サーバーごとに10,000件まで
保存容量 サーバーごとに合計3GBまで(音の長さ1秒につき約0.2MBで数えます)
キーワードは記号で囲もう SEは発言の一部にも反応します。「草」のような短い言葉を登録すると、「草原」でも鳴ります。(拍手)や:clap:のように、ふだんの会話に出てこない形にしておくと誤爆しません。

探す・直す・消す

やりたいこと コマンド 補足
一覧を見る /se-list ボタンでページ送り
うろ覚えで探す /se-search keyword:拍手 完全一致 → 前方一致 → 部分一致の順に、近いものを5件まで表示。見つからなければ打ち間違いも考慮して探します
キーワードを変える /se-rename old_keyword:旧 new_keyword:新 音声はそのまま、名前だけ変更
消す /se-del keyword:(拍手) テキストコマンドなら@はなこ se-del A B Cで複数まとめて削除

音量をそろえる「SE正規化」

SEはファイルごとに音量がばらばらです。正規化をオンにすると、小さすぎるSEを指定したレベルまで持ち上げて、聞こえ方をそろえます。

正規化なし(0)
目標 80
SE ASE BSE C
/se-normalize level:80のとき
目標 80
SE ASE BSE C

小さいSEが目標レベルまで持ち上がります(イメージ図)

  • /se-normalize level:0〜100で設定します。初期値は50で、0にすると無効になります。
  • サーバー全体の設定です。変更には「サーバー管理」の権限が必要です。
CHAPTER 06 / VOICE & LIMIT

声と、読む長さの設定。

「誰の声で」「どこまで」読むかの設定です。設定がおよぶ範囲がそれぞれ違うので注意してください。

自分の発言だけ

キャラクター変更

/speaker name:キャラクター名

あなたの発言を読む声を変えるコマンドです。ほかの人の声は変わりません。設定はサーバーごとに覚えます。

今のところ使える声はdefaultの1種類だけなので、実際には変更できません。

サーバー全体

文字数制限

/limit number:30

1つの発言で読む文字数の上限を、0〜2000で決めます。超えた分は読まず、最後に「イか略。」と付けます。

初期値は/limit number:0で、制限はありません。変更には「サーバー管理」の権限が必要です。

使えるキャラクター名(現在1種類) いま使えるのは既定の声のdefaultだけです。ほかの名前を指定すると読み上げに失敗することがあるので、その場合は/speaker name:defaultで戻してください。
CHAPTER 07 / BLACKLIST

読み上げない人を、決めておく。

特定のユーザーの発言を読み上げないようにする機能です。Discord上のミュートやタイムアウトとは別で、Hanakoが「その人の発言を読まない」だけです。

やりたいこと コマンド 必要な権限
読まないようにする /blacklist-add user:@ユーザー メンバーをタイムアウト
解除する /blacklist-remove user:@ユーザー メンバーをタイムアウト
一覧を見る /blacklist-show メンバーをタイムアウト
全員を解除する /blacklist-clear サーバー管理
  • その人がコマンドを使うことは妨げません。止まるのは読み上げだけです。
  • ほかのBotの発言はもともと読まないので、登録は不要です。
CHAPTER 08 / PERMISSIONS

コマンドを使える人と、権限の設定。

ほとんどのコマンドは誰でも使えます。影響の大きいコマンドだけは、サーバーで「サーバー管理」か「メンバーをタイムアウト」の権限を持つ人しか使えません。

👥 だれでも 権限は不要
/plz /bye /seibai /speaker /teach /forget /dictionary /se-add /se-del /se-list /se-search /se-rename /help /ask
🛡️ モデレーター 「メンバーをタイムアウト」
/blacklist-add /blacklist-remove /blacklist-show
👑 サーバー管理者 「サーバー管理」
/limit /dictionary-clear /se-normalize /blacklist-clear /text-commands

コマンドを使える人の初期設定。「管理者」権限を持つ人はすべて使えます

使える人を変える

上の図は初期設定です。サーバー管理者は、Discordの「サーバー設定 → 連携サービス → はなこ」から、コマンドごとに使えるロール・メンバー・チャンネルを変更できます。たとえば、ブラックリストを全員が使えるようにしたり、/se-addを特定のロールだけに許可したりできます。

この変更が反映されるのはスラッシュコマンドだけです @はなこや>で打つテキストコマンドは、つねに上の図の初期設定で判定されます。連携サービスで細かく制限したいサーバーは、次のコマンドでテキストコマンドを止めてください。

テキストコマンドを止める

/text-commands enabled:Falseを実行すると、そのサーバーでは@はなこや>で始まるコマンドに反応しなくなります。enabled:Trueで元に戻ります。

  • 止めている間は、テキストコマンドに案内も含めて何も返しません。
  • >で始まる発言を読み上げない動作は、そのまま変わりません。
  • >をほかのBotのコマンドに使いたいサーバーにも向いています。

Hanako自身に必要な権限

Hanakoが動くには、対象のチャンネルで次の権限が必要です。足りないときは、Hanakoがどの権限が足りないかを教えてくれます。

場所 権限
ボイスチャンネル チャンネルを見る/接続/発言
テキストチャンネル チャンネルを見る/メッセージを送信/埋め込みリンク/メッセージ履歴を読む/リアクションの追加

データはサーバーごとに完全に分けて保存

辞書・SE・ブラックリスト・各種設定は、Discordサーバーごとに別々に保存されます。ほかのサーバーの設定が混ざったり、見えたりすることはありません。保存する情報の詳細はプライバシーポリシーをご覧ください。

CHAPTER 09 / COMMANDS

すべてのコマンドを、ひと目で。

下の欄に言葉を入れると、一覧を絞り込めます。

機能 スラッシュコマンド テキストコマンド(別名) 必要な権限
🗣️ 読み上げ
ボイスチャンネルに参加 /plz お願い / plz / summon / s —
ボイスチャンネルから退出 /bye さようなら / bye / b —
読み上げを中止 /seibai 成敗 / seibai / stop —
文字数制限(0で解除) /limit 30 制限 / limit / readlimit サーバー管理
読み上げキャラクター変更 /speaker 名前 キャラクター変更 / speaker —
📚 辞書
単語を教育 /teach 置換前 置換後 教育 / teach / mk / wbook-add —
単語を忘却 /forget 単語 忘却 / forget / rm / wbook-delete —
辞書の一覧 /dictionary 辞書 / dictionary / dic / wbook-list —
辞書を全削除 /dictionary-clear 白紙 / alldelete / wbook-alldel サーバー管理
🎺 SE(効果音)
SEを追加(URLまたはファイル添付) /se-add キーワード 音声教育 / se-add —
SEを削除 /se-del キーワード 音声忘却 / se-delete / se-del —
SEの一覧 /se-list 音声辞書 / 音声一覧 / se-dic / se-list —
SEを検索 /se-search キーワード se? —
SEの名前変更 /se-rename 旧 新 音声名置換 / se-rename —
SE音量の正規化(0〜100) /se-normalize 80 SE正規化 / se-normalize / senorm サーバー管理
🛡️ ブラックリスト
ユーザーを追加 /blacklist-add @user 沈黙 / blacklist-add メンバーをタイムアウト
ユーザーを除外 /blacklist-remove @user 恩赦 / blacklist-remove メンバーをタイムアウト
一覧を表示 /blacklist-show 名簿 / blacklist-show メンバーをタイムアウト
全員を解除 /blacklist-clear 大赦 / blacklist-clear サーバー管理
✨ その他
ヘルプ /help 使い方 / help —
質問(はい/いいえで答えます) /ask 質問 / ask —
テキストコマンドの有効・無効 /text-commands (スラッシュコマンドのみ) サーバー管理

一致するコマンドはありません。別の言葉で探してみてください。

テキストコマンドは、表の別名のどれかを@はなこか>に続けて打ちます。たとえば>sや@はなこ お願いのように打ちます。

CHAPTER 10 / FAQ

よくある質問と、その対処。

Hanakoの返事や起きていることから、原因と対処を探せるようにまとめました。

Hanakoが来ない

「通話チャンネルに参加してから呼んでね!」と言われる

あなたがボイスチャンネルに入っていません。先にボイスチャンネルに参加してから/plzを打ってください。

「〜の権限がないみたい…」と言われる

そのボイスチャンネルで、Hanakoに「チャンネルを見る」「接続」「発言」のいずれかが許可されていません。返事に足りない権限の名前が出るので、サーバーの管理者にチャンネルの権限設定を確認してもらってください。

「満員で入れないよ」「タイムアウト中だから入れないよ」と言われる

ボイスチャンネルの人数制限に達しているか、Hanako自身がタイムアウトされています。人数制限を広げるか、Hanakoのタイムアウトを解除してください。

「ステージチャンネルには参加できないの」「このチャンネルは読み上げに対応していないの」と言われる

ステージチャンネルへの参加と、スレッド・フォーラムなどの読み上げには対応していません。通常のボイスチャンネルに入り、通常のテキストチャンネル(またはボイスチャンネル内のチャット)で呼んでください。

読んでくれない・読み方がおかしい

自分の発言だけ読まれない
  • ブラックリストに入っていないか、モデレーターに/blacklist-showで確認してもらってください。
  • 発言が>で始まっていないか確認してください。
  • /speakerで存在しないキャラクター名を設定していると読めません。/speaker name:defaultで戻してください。
このチャンネルの発言が読まれない

Hanakoは/plzを打ったチャンネルだけを読みます。読んでほしいチャンネルで、もう一度/plzを打ってください。スレッドの中は読めません。

途中で切れて「イか略。」と言う

文字数制限にかかっています。サーバー管理者が/limit number:0で制限をなくすか、より大きい数字に設定し直せます。

変なところで言葉が置き換わる・SEが鳴る

辞書もSEも、単語の一部に反応します。/dictionaryや/se-searchで原因の登録を探し、/forgetや/se-delで消すか、/se-renameで記号つきのキーワードに変えてください。

読み上げが止まらない・たまりすぎた

/seibaiで、再生中と順番待ちの音声をすべて中断できます。何も読んでいないときに打つと「安心せい、みねうちにゃ…」と返ります。

コマンドが使えない

「このコマンドは『〜』の権限を持っている人だけが使えるよ」と言われる

そのコマンドには権限が必要です。必要な権限は08章の図で確かめられます。権限を持っている人に頼むか、サーバー管理者に使える人の設定を変えてもらってください。

@はなこや>のコマンドに何も反応しない
  • サーバーでテキストコマンドが無効になっている可能性があります。スラッシュコマンドを使うか、サーバー管理者に/text-commands enabled:Trueを実行してもらってください。
  • コマンド名を打ち間違えると、Hanakoは何も返しません。>で始まる独り言と区別できないためです。
スラッシュコマンドの候補に出てこない

権限がないコマンドは、Discordが候補から隠します。また、スラッシュコマンドはサーバーの中でしか使えず、HanakoとのDMでは使えません。

SEを登録できない

「これサウンドファイルじゃなさそう」「変換できなかったにゃ」と言われる

対応しているのは.wavと.mp3です。動画ファイルや別の形式の音声は、mp3かwavに変換してから登録してください。URLで指定する場合は、再生ページではなく音声ファイルそのもののURLが必要です。

「〜秒より長い音声は登録できないにゃ」と言われる/大きいファイルが登録できない

SEは60秒・2MBまでです。短く切るか、ビットレートを下げてから登録してください。

「SEの保存容量がいっぱい」と言われる

SEはサーバーごとに合計3GBまで保存できます。音は変換して保存するため、元のファイルの大きさではなく音の長さで決まり、1秒につき約0.2MBです。使っていないSEを/se-delで消すと、また登録できます。登録済みのSEが消されることはありません。

「すでに登録済みのキーワードです」「一文字登録はできません」と言われる

キーワードは2〜50文字で、サーバー内で重複できません。音を差し替えたいときは、先に/se-delで消してから登録し直します。

それでも解決しないとき

Hanakoを招待してくれた人に聞いてみてください。Bot本体の不具合と思われる場合は、GitHubのIssueに投稿すると、ほかの利用者の助けにもなります。

サーバーデータの削除・開示の請求は、お問い合わせフォームから受け付けています。削除の請求は、はなこを退出させたサーバーのみが対象です。

まとめ

ここまで、Hanakoの使い方をひととおり説明しました。Hanakoを使えば、Discordサーバーはもっと楽しく、誰でも会話に加わりやすい場所になるはずです。ぜひ今日から試してみてください。