Skip to content
This repository has been archived by the owner on Sep 2, 2022. It is now read-only.

PingとMuteのDocs校閲 #74

Open
wants to merge 5 commits into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
21 changes: 11 additions & 10 deletions docs/mute.md
Original file line number Diff line number Diff line change
@@ -1,22 +1,23 @@
# muteコマンド概要
メッセージリンクを送信しても展開しない(ミュート)ように設定します。
場所あるいはアカウントごとにミュート状態のオンオフを切り替えます。
ミュートが有効な場所では、誰がメッセージリンクを送信しても展開されません。
ミュートが有効なアカウントは、どこでリンクを送信されても自身の発言なら展開されません
user以外はサーバー管理権限を保有しているユーザーのみ実行できます。
## オプション
ミュートする場所を指定します。
### /mute server
実行したサーバー全体をミュートします。
> 「全体をミュート」より「全体でミュート」のほうが通りが良い気がするが、うまく説明できない
### /mute category `<category>`
カテゴリーをミュートします。
`category`が指定されていない場合は実行されたチャンネルが属するカテゴリーが対象です。
指定したカテゴリ内のチャンネル全体をミュートします。
`category`が指定されていない場合は、実行されたチャンネルが属するカテゴリーが対象です。
> カテゴリ指定の書式は? id?名前?カテゴリ名が重複する場合はどうすれば? チャンネルとロールについても同様。
### /mute channel `<channel>`
チャンネルをミュートします
指定したチャンネル単体をミュートします
`channel`が指定されてない場合は実行されたチャンネルが対象です。
### /mute role `<role>`
ロールを保持しているメンバーをミュートします
指定したロールを保有しているメンバーをミュートします
`role`は必須です。
### /mute user
実行したユーザーをミュートします。

## ミュート処理
メッセージリンクが送信された場所(サーバー、カテゴリー、チャンネル)とユーザー情報(ロール、ユーザー)の設定を参照し、ミュートが有効化されている場所、ユーザー情報の合計数で判別しています。
奇数の場合は有効、偶数の場合は無効になります。
実行したユーザー自身をミュートします。他者を指定することは出来ません。
> ユーザーってことは全サバ共通設定? それともサバ個別?
6 changes: 3 additions & 3 deletions docs/ping.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
# pingコマンド概要
このBotのPing値を送信します
Botがアクティブなのか確認する用途を想定しています
現時点の、Botにかかっている負荷を確認することができます
しばらく待ってもBotから反応が無かった時などに使ってください

※ユーザーのPingを送信するものではありません。
数値が高いほどBotに負荷がかかった状態であり、反応が遅くなる可能性があります。