Lumi

Lumi 説明書

Lumiの使い方を、導入から順に説明します。急ぐ場合は「1. 導入」と「3. ルールの作り方」だけ読めば使い始められます。

Lumiとは

サーバーでの活動量に応じて、ロールを自動で付与するDiscord BOTです。活動のたびに条件を判定するので、条件を満たした人には、その場でロールが付きます。

1. 導入

BOTを招待する

ページ上の「BOTを招待」から、サーバーを選んで認可します。Lumiは管理者権限つきで招待します。

Lumiのロールを上に移動する

Lumiは、自分のロールより下にあるロールしか付けられません。サーバー設定の「ロール」で、Lumiのロールを、付与したいロールより上にドラッグしてください。管理者権限があっても、この制限は変わりません。

ここが一番つまずきやすい点です

ロールが付かないときは、まずLumiのロールの位置を確認してください。

2. ダッシュボード

ダッシュボード(BOTの管理画面)にDiscordでログインします。サーバー一覧に、設定できるサーバーが並びます。Lumiが入っているサーバーが上に表示されます。

誰が操作できるか

「ロールの管理」権限だけでは、操作できません。管理ロールは、ダッシュボードの「アクセス権限」で選びます。

最初の設定

管理ロールは、初期状態では何も選ばれていません。まず、オーナーか管理者がログインして、「アクセス権限」で、運営メンバー用のロールを選んでください。

3. ルールの作り方

ダッシュボードの「活動ロール」で、「条件」「回数」「ロール」を選んで追加します。

発言数  100 以上  →  見習い
発言数  500 以上  →  常連
VC接続時間(分)  600 以上  →  ボイス常連

数える活動

条件数えるもの
発言数メッセージを送った回数。短時間の連投は数えません(間隔は設定で変更できます)
もらったリアクション数自分の投稿に付いたリアクションの数。自分で付けたものと、BOTのものは除きます
つけたリアクション数自分が付けたリアクションの数
VC接続時間(分)ボイスチャンネルにいた時間。AFKチャンネルと、スピーカーミュート中は数えません

ランク(段階)

同じ条件に、回数の違うルールを重ねると、ランクになります。

発言数  100 以上  →  Lv1
発言数  500 以上  →  Lv2
発言数 1000 以上  →  Lv3

「下位ランクのロールを外す」にチェックを入れると、上のランクに上がったとき、下のランクのロールが外れて置き換わります。チェックなしだと、ロールは積み重なります。

分布を見て、条件を決める

ダッシュボードの「分布」では、メンバーの活動量が、どのあたりに何人いるかを見られます。

対象は、活動が記録されていて、サーバーにいる人です。サーバーを抜けた人は含みません。

ルールの編集と、ロールの剥奪

登録済みのルールは、「編集」で条件・回数・ロールを変更できます。変更後は、「更新」を押してください。

ルールに「条件を下回ったらロールを剥奪」を付けると、条件を満たさなくなった人からロールを外します。たとえば、「VC接続時間 600分以上 → ボイス常連」に付けておくと、600分に届いていない人は、このロールを持てません。

ルールを追加した直後は

すでに条件を満たしている人にも、その人が次に活動したときにロールが付きます。すぐに全員へ反映したいときは、「全メンバーに今すぐ適用」を押してください。

設定

4. 通知

「ロール付与の通知先」でチャンネルを選ぶと、ロールが付いたときに、そのチャンネルへ通知します。「通知しない」にすると、通知は出ません(初期値)。

🎉 @たろう さんが **常連** を獲得しました!(発言数 500以上)

通知メッセージは変更できます。次の変数が使えます。

変数入る内容
{user}ユーザーへのメンション
{name}表示名
{role}ロール名
{condition}達成した条件(例: 発言数 500以上)

5. 過去の発言を数える

Lumiを入れる前の発言も、数に入れられます。対象は発言数のみです。リアクションとVC時間の過去分は取り込めません。

  1. 「過去の発言数を取り込む」で、期間を選びます。開始日の初期値は、Lumiを入れた日です。空欄にすると全期間になります
  2. 「取り込み開始」を押します
  3. 進捗が%と残り時間で表示されます。完了すると、全員にロールが適用されます
発言数は上書きされます

現在の発言数は、取り込んだ結果に置き換わります。期間を限定すると、その期間の数だけになります。全期間の累計を保ちたいときは、期間を空欄にしてください。

6. コマンド

コマンドできること
/rank [user] [private]数・順位・ランク・次のランクまでの必要数。userで他の人、privateで自分だけに表示
/top [metric] [page] [private]ランキングを10位ごとに表示。ボタンでページ送り。ボタンは、コマンドを使った本人だけが押せます
/roles [private]取れるロールと、昇格の条件の一覧。自分の達成状況(達成済み・次の目標・あと何回か)も分かります
/help [public]コマンド一覧と、各機能の説明。ふだんは自分にだけ表示し、publicをオンにすると全員に表示します

同じ数の人は、同じ順位で表示します。サーバーを抜けた人は、順位から外れます(再参加すると戻ります)。

大喜利

お題を出して、みんなで回答し、リアクションで投票(草)して、結果とランキングを見られる機能です。サーバーの中だけで使えます(DMでは使えません)。

コマンドできること
/odai textお題を出します。そのチャンネルで進行中のお題があれば、終了します
/kaitou a今のお題に回答します(300文字まで)。お題の下の「回答する」ボタンからも案内されます。同じ内容の回答は、1人1回だけです
/kekka草の多い順にTOP10を発表して、お題を終わります
/rankingサーバー全体の、回答数と、もらった草の数のランキング
/bestサーバーで一番草が入っている投稿(元の投稿へのリンクつき)
/up今のお題を、チャンネルの一番下に出し直します
/kusaemoji [emoji]草として数える絵文字を設定します(管理者のみ)。このサーバー、またはLumiが入っている別のサーバーのカスタム絵文字も使えます。省略すると ☑️ に戻ります

大喜利の読み上げ(読み上げBOTとの連携)

お題と回答を、SHB2-読み上げBOTの声で、ボイスチャンネルに読み上げられます。回答は、回答した人本人の声と速度で読まれます。

  1. 読み上げBOTを、サーバーに招待します。ボイスチャンネルに入って、/join を実行し、読み上げを始めておきます
  2. サーバーの管理者が、読み上げBOTで /external を実行して、「オン」を選びます。そのサーバー専用のトークンが、1回だけ表示されます
  3. ダッシュボードの「大喜利」の「読み上げ連携」に、そのトークンを貼り付けて、「連携する」を押します
  4. 読み上げる内容(お題・回答・回答者の名前・結果)を、オン・オフで選びます

メッセージのリンクを貼ると、元のメッセージの文章と画像を、そのまま転送して、返信します。管理者が、ダッシュボードの「メッセージリンク」で有効にしたサーバーだけで動きます(初期値はオフです)。

チャンネルロール(特定のチャンネル・カテゴリで発言したらロール)

「#自己紹介 で発言したら メンバー ロール」のように、特定のチャンネルで発言した人に、ロールを付けます。ダッシュボードの「チャンネルロール」で、ルールを登録します。

再起動のお知らせ

ダッシュボードの「BOTの状態 → 再起動のお知らせ」で、お知らせするチャンネルを決めると、Lumi が止まるとき・戻ってきたときに、メッセージを送ります。

通貨(犯罪・バイト・ギャンブル)

サーバーの中だけで使える通貨で、稼いだり、遊んだりできます。サーバーの管理者が、ダッシュボードの「通貨」で有効にしたサーバーだけで動きます(初期値はオフです)。

コマンドできること
/balance手持ちと銀行の残高を見ます
/deposit /withdraw手持ちを銀行に預ける・引き出す。銀行のお金は、罰金の対象になりません
/workバイト(コンビニ・警察・ファーストフード・ラーメン屋)。給料がもらえます。警察とファーストフードは、ボーナスが出ることもあります
/beg乞食。2分おきに、小銭をめぐんでもらえます。何ももらえないこともあります
/crime犯罪(コンビニ強盗・ATM襲撃・銀行強盗・宝石強盗・海賊)。成功すると大金、失敗すると罰金と留置場です。難しい犯罪ほど、報酬が大きく、成功率が低くなります。所持金が0以下のときは、できません
/heist [target]大型犯罪(ミニゲーム)。成功するかは、運ではなく、腕で決まります。制限時間内に、ボタンで問題(計算・数列・仲間はずれ・配線・暗証番号・監視カメラの数え上げ)に答えれば成功で、大金を持ち出せます。間違えられる回数を超える、または時間切れは失敗で、重い罰金と留置場です。狙う場所(target)は5つ: 🚚 現金輸送車(易しい。4問・45秒)/ 🏦 大型銀行(標準。5問・60秒。報酬 6,000〜15,000)/ 🖼️ 美術館(1回しか間違えられない)/ 🎰 カジノ(6問)/ 💎 国立宝物庫(最難関。8問・75秒。報酬 26,000〜60,000)。難しいほど、報酬・罰金・留置場・待ち時間が大きくなります。早く終えるほど、報酬は最大+25%。待ち時間は、場所ごとです
/release【管理者向け】留置場にいる人を、釈放します(user で1人、all で全員)。ダッシュボードの「通貨 → 留置場」からも、釈放できます
/balance-edit【管理者向け】メンバーの残高を編集します(増やす・減らす・指定額にする / 手持ち・銀行)。オーナーと管理者だけが使えて、操作は履歴に残ります。ダッシュボードの「通貨 → 残高の調整」からも、できます
/jobバイトの階級と出勤回数を見ます。昇進がオンのサーバーでは、出勤を重ねると階級が上がり、給料(ボーナスも)の倍率が増えます
/wanted [user]指名手配の手配書(手配中の人と懸賞金)を見ます。指名手配がオンのサーバーのみ
/arrest user指名手配中の人を逮捕します。警察のバイトを、サーバーが決めた回数(初期値5回)以上した人だけ。成功すると懸賞金がもらえて、相手は留置場に入ります(成功率50%・待ち時間10分)
/releasenotes [version]リリースノート(更新内容)を見ます。version の欄のプルダウンから、見たい版を選べます(省略すると最新。選択肢には、新しい順に25件まで出ます)。ボタンで、新しい版・古い版へ移れます。public で、全員に表示できます
/cooldowns待ち時間(クールダウン)の一覧。犯罪・バイト・乞食・大型犯罪(指名手配がオンなら、逮捕も)が、いま使えるか、あと何分かを、まとめて見られます。留置場にいるときや、指名手配の状況も出ます。public で、全員に表示できます
/shop list / /shop buy / /useお店(オンのサーバーのみ)。タバコ・お酒などを、/shop buy で買い、/use で使うと、しばらく効果(良いことと、代償)がつきます。品は、/shop list の番号で選びます
/petペット。adopt(飼う)・feed(餌)・play(遊ぶ)・status(様子)・rename・release。育てると、ボーナスがつきます
/stock list / buy / sell株(架空の会社)。株価は5分ごとに動きます。会社は番号で選びます
/lottery info / buy / results宝くじ。くじは、番号で選びます(くじが複数あるとき)。決まった時刻に、自動で抽選します
/estate list / buy / sell / collect不動産。物件を買って、家賃(1時間ごとに溜まる)を受け取ります
/market list / /market buy闇マーケット(管理者がオンにしたサーバーのみ)。犯罪・大型犯罪に使う道具の、今日の相場と所持数を見る(list)/ 買う(buy)。オンのサーバーでは、/crime と /heist に、その専用の道具が必要で、1回の挑戦で1つ使います(成功でも失敗でも)
/blackjack-end【管理者向け】進行中のブラックジャックを、強制的に終了します(止まったゲームの後始末)。user で1人、all で全員ぶん。既定は賭け金を返します(refund をオフにすると、返さず終了)。オーナーと管理者だけが使えて、操作は履歴に残ります
/cooldown-reset【管理者向け】メンバーのクールダウンを解除します(犯罪・バイト・乞食・大型犯罪、またはすべて)。オーナーと管理者だけが使えます
/pingBOTの応答速度(Discordとの通信、コマンドが届くまでの遅れ、処理の止まり)を調べます。private で自分だけに表示できます
/bail保釈金(残り1分につき100)を払って、留置場から出ます。留置場にいる間は、犯罪とバイトができません
/chinchiroチンチロ。親と勝負します。シゴロは2倍、ゾロ目は3倍、ピンゾロは5倍。ヒフミで負けると、2倍払いです
/slotスロット。3つ揃うと大当たり。🍒が出ると、一部が戻ります
/blackjackブラックジャック。ヒット・スタンド・ダブルダウンのボタンで遊びます。ブラックジャックは3:2です
/richestお金持ちランキング(手持ち + 銀行)
/pay手持ちのお金を、他のメンバーに送金します(手数料なし)。留置場にいる間と、手持ちが足りないときは、送れません

犯罪まわりの説明を、まとめて見たいときは、/help topic:犯罪(topic は選択肢から選びます)。犯罪・大型犯罪・闇マーケット・留置場について、成功率、報酬、罰金、待ち時間、道具の今日の値段まで、このサーバーの設定に合わせて表示します。

ラーメン屋のバイト(ミニゲーム)

/work job:ラーメン屋 は、ラーメンを作るミニゲームです。お客さんの注文に、ボタンで答えて作ります。出来栄えで、給料が変わります。

ゲームバランスの編集

ダッシュボードの「通貨 → ゲームバランス」で、ゲームの数字を、サーバーごとに、すべて変えられます。空欄の項目は、初期値のままです。

職業の昇進と指名手配

どちらも、ダッシュボードの「通貨」で、サーバーごとにオン・オフと中身を決められます(初期値はオフ)。

暮らし(お店・ペット・株・宝くじ・不動産)

どれも、ダッシュボードの「通貨」で、サーバーごとにオン・オフと中身を決められます(初期値はオフ)。/help topic:暮らし で、そのサーバーの設定に合わせた説明が見られます。

闇マーケット(犯罪に道具が必要)

ダッシュボードの「通貨 → 闇マーケット」をオンにしたサーバーでは、犯罪と大型犯罪に、専用の道具が必要になります(オフのときは、これまでどおり、道具なしでできます)。

7. 数え方のルール

8. データの扱い

保存するのは、次のものだけです。

活動ロールの集計では、メッセージの本文を保存しません。本文を保存するのは、大喜利の回答(/kaitou で投稿されたもの)だけです。

9. 困ったとき

ロールが付かない

  1. Lumiのロールが、付与したいロールより下になっていないか確認します
  2. そのロールが「連携(BOT)用」の管理ロールではないか確認します。管理ロールは付与できません
  3. ルールの条件を、本当に満たしているか、/rankで確認します

ダッシュボードにサーバーが出ない

サーバーのオーナーか管理者に、ダッシュボードの「アクセス権限」で、あなたのロールを管理ロールに選んでもらってください。選ばれたあとは、いったんログアウトして、入り直してください。「ロールの管理」権限だけでは、操作できません。

コマンドが出ない

Discordを再読み込みします(Ctrl+R)。それでも出ないときは、招待リンクをもう一度開いて、同じサーバーを選び直してください。

通知が届かない

通知先が「通知しない」になっていないか、「テスト送信」で確認します。Lumiがそのチャンネルに投稿できる権限を持っているかも確認してください。