From 0ff59e0241078e2cc3aa248dd010fc653eed2949 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?=E3=81=86=E3=81=95=E3=81=BF=E3=82=87=E3=82=93=28myon2019?=
 =?UTF-8?q?=29/mtripg6666tdr?=
 <56076195+mtripg6666tdr@users.noreply.github.com>
Date: Thu, 25 Aug 2022 17:44:46 +0900
Subject: [PATCH] Docs: update commandlist (#328)

---
 docs/commands.md            | 348 +++++++++++++++++++++++-------------
 util/generateCommandList.js |  19 +-
 2 files changed, 236 insertions(+), 131 deletions(-)

diff --git a/docs/commands.md b/docs/commands.md
index a66210f5f..61142140a 100644
--- a/docs/commands.md
+++ b/docs/commands.md
@@ -13,205 +13,311 @@
 ## ボイスチャンネル操作系
 ### `切断`コマンド
 ボイスチャンネルから切断します。  
-#### エイリアス
-`終了`, `dc`, `disconnect`, `leave`, `quit`
+- エイリアス
+  - `終了`
+  - `dc`
+  - `disconnect`
+  - `leave`
+  - `quit`
+---
 ### `接続`コマンド
 ボイスチャンネルに参加します  
-#### エイリアス
-`join`, `参加`, `connect`
+- エイリアス
+  - `join`
+  - `参加`
+  - `connect`
+---
+### `ボリューム`コマンド
+音量を調節します。20から200の間で指定します(デフォルト100)。何も引数を付けないと現在の音量を表示します。不安定になった場合には100に戻してください。  
+- エイリアス
+  - `volume`
+  - `vol`
+- 使い方: `volume 120`
+- 使用例: `volume <音量>`
+---
 
 ## 音楽プレイヤー制御系
+### `エフェクト`コマンド
+エフェクトコントロールパネルを表示します  
+- エイリアス
+  - `effect`
+  - `音声エフェクト`
+  - `音声効果`
+  - `効果`
+---
 ### `フレーム`コマンド
 現在の再生位置の動画のフレーム画像を可能な場合取得します。引数が指定された場合その時点でのフレームを取得します  
-#### エイリアス
-`frame`, `キャプチャ`, `capture`
-#### 使い方
-フレーム [時間]
-#### 使用例
-フレーム 1:20
+- エイリアス
+  - `frame`
+  - `キャプチャ`
+  - `capture`
+- 使い方: `フレーム [時間]`
+- 使用例: `フレーム 1:20`
+---
 ### `ループ`コマンド
 トラックごとのループを設定します。  
-#### エイリアス
-`トラックループ`, `loop`, `repeat`, `trackloop`, `trackrepeat`
+- エイリアス
+  - `トラックループ`
+  - `loop`
+  - `repeat`
+  - `trackloop`
+  - `trackrepeat`
+---
 ### `現在再生中`コマンド
 現在再生中の曲の情報を表示します。 `l`を引数にするとより長く概要を表示します(可能な場合)。  
-#### エイリアス
-`今の曲`, `np`, `nowplaying`
+- エイリアス
+  - `今の曲`
+  - `np`
+  - `nowplaying`
+---
 ### `ワンスループ`コマンド
 現在再生中の再生が終了後、もう一度だけ同じ曲をループ再生します。  
-#### エイリアス
-`onceloop`, `looponce`
+- エイリアス
+  - `onceloop`
+  - `looponce`
+---
 ### `一時停止`コマンド
 再生を一時停止します。  
-#### エイリアス
-`一旦停止`, `停止`, `pause`, `stop`
+- エイリアス
+  - `一旦停止`
+  - `停止`
+  - `pause`
+  - `stop`
+---
 ### `再生`コマンド
 キュー内の楽曲を再生します。引数として対応しているサイトの楽曲のURLを指定することもできます。  
-#### エイリアス
-`play`, `p`
+- エイリアス
+  - `play`
+  - `p`
+---
 ### `キューループ`コマンド
 キュー内のループを設定します。  
-#### エイリアス
-`queueloop`, `loopqueue`
+- エイリアス
+  - `queueloop`
+  - `loopqueue`
+---
 ### `頭出し`コマンド
 再生中の曲の頭出しを行います。  
-#### エイリアス
-`rewind`, `gotop`, `top`
+- エイリアス
+  - `rewind`
+  - `gotop`
+  - `top`
+---
+### `シーク`コマンド
+楽曲をシークします。  
+- エイリアス
+  - `seek`
+- 使い方: `検索 <時間(秒数または時間:分:秒の形式で)>`
+- 使用例: `シーク 0:30`
+---
 ### `スキップ`コマンド
 現在再生中の曲をスキップします。  
-#### エイリアス
-`skip`, `s`
+- エイリアス
+  - `skip`
+  - `s`
+---
 ### `サムネイル`コマンド
 現在再生中のサムネイルを表示します。検索パネルが開いていて検索パネル中の番号が指定された場合にはその曲のサムネイルを表示します。  
-#### エイリアス
-`thumbnail`, `t`
-#### 使い方
-サムネイル [検索パネル中のインデックス]
-#### 使用例
-サムネイル 5
+- エイリアス
+  - `thumbnail`
+  - `t`
+- 使い方: `サムネイル [検索パネル中のインデックス]`
+- 使用例: `サムネイル 5`
+---
 
 ## プレイリスト操作系
 ### `bgm`コマンド
 開発者が勝手に作った勉強用・作業用BGMのプリセットプレイリストを表示し、聞きたいものを選択して再生することができます。  
-#### エイリアス
-`study`
+- エイリアス
+  - `study`
+---
 ### `この曲で終了`コマンド
 現在再生中の曲(再生待ちの曲)をのぞいてほかの曲をすべて削除します  
-#### エイリアス
-`end`
+- エイリアス
+  - `end`
+---
+### `均等再生`コマンド
+追加ユーザーごとにキュー内の楽曲を均等に再生します  
+- エイリアス
+  - `equallyplayback`
+  - `eqpb`
+  - `equally`
+---
 ### `エクスポート`コマンド
 キューの内容をインポートできるようエクスポートします。  
-#### エイリアス
-`export`
+- エイリアス
+  - `export`
+---
 ### `インポート`コマンド
 指定されたメッセージからキューをインポートします。exportコマンドで出力されたファイルが添付されたURL、もしくはキューの埋め込みのあるメッセージのURLを引数として指定してください。  
-#### エイリアス
-`import`
-#### 使い方
-インポート <インポート元のURL>
-#### 使用例
-import https://discord.com/channels/...
+- エイリアス
+  - `import`
+- 使い方: `インポート <インポート元のURL>`
+- 使用例: `import https://discord.com/channels/...`
+---
 ### `leaveclean`コマンド
 ボイスチャンネルから離脱した人がリクエストした曲をキューから削除して整理します  
-#### エイリアス
-`lc`
+- エイリアス
+  - `lc`
+---
 ### `最後の曲を先頭へ`コマンド
 キューの最後の曲をキューの先頭に移動します。  
-#### エイリアス
-`movelastsongtofirst`, `mlstf`, `ml`, `mltf`, `mlf`, `m1`
+- エイリアス
+  - `movelastsongtofirst`
+  - `mlstf`
+  - `ml`
+  - `mltf`
+  - `mlf`
+  - `m1`
+---
 ### `移動`コマンド
 曲を指定された位置から指定された位置までキュー内で移動します。2番目の曲を5番目に移動したい場合は`mv 2 5`のようにします。  
-#### エイリアス
-`mv`, `move`
-#### 使い方
-移動 <from> <to>
-#### 使用例
-移動 2 5
+- エイリアス
+  - `mv`
+  - `move`
+- 使い方: `移動 <from> <to>`
+- 使用例: `移動 2 5`
+---
 ### `ニュース`コマンド
 現在配信されているニューストピックスを閲覧・視聴できます。  
-#### エイリアス
-`news`
+- エイリアス
+  - `news`
+---
 ### `キュー`コマンド
 キューを表示します。  
-#### エイリアス
-`キューを表示`, `再生待ち`, `queue`, `q`
+- エイリアス
+  - `キューを表示`
+  - `再生待ち`
+  - `queue`
+  - `q`
+---
 ### `related`コマンド
 YouTubeから楽曲を再生終了時に、関連曲をキューに自動で追加する機能の有効/無効を設定します  
-#### エイリアス
-`関連動画`, `関連曲`, `おすすめ`, `オススメ`, `related`, `relatedsong`, `r`, `recommend`
+- エイリアス
+  - `関連動画`
+  - `関連曲`
+  - `おすすめ`
+  - `オススメ`
+  - `related`
+  - `relatedsong`
+  - `r`
+  - `recommend`
+---
 ### `削除`コマンド
 キュー内の指定された位置の曲を削除します。  
-#### エイリアス
-`消去`, `rm`, `remove`
-#### 使い方
-削除 <削除する位置>
-#### 使用例
-rm 5
+- エイリアス
+  - `消去`
+  - `rm`
+  - `remove`
+- 使い方: `削除 <削除する位置>`
+- 使用例: `rm 5`
+---
 ### `すべて削除`コマンド
 キュー内の曲をすべて削除します。
 ※接続中の場合ボイスチャンネルから離脱します。  
-#### エイリアス
-`すべて削除`, `rmall`, `allrm`, `removeall`
+- エイリアス
+  - `すべて削除`
+  - `rmall`
+  - `allrm`
+  - `removeall`
+---
 ### `検索`コマンド
 曲をYouTubeで検索します。直接URLを直接指定することもできます。  
-#### エイリアス
-`search`, `se`
-#### 使い方
-検索 <キーワード>
-#### 使用例
-検索 夜に駆ける
+- エイリアス
+  - `search`
+  - `se`
+- 使い方: `検索 <キーワード>`
+- 使用例: `検索 夜に駆ける`
+---
 ### `キュー内を検索`コマンド
 キュー内を検索します。引数にキーワードを指定します。  
-#### エイリアス
-`searchq`, `seq`, `sq`
-#### 使い方
-seq <キーワード>
-#### 使用例
-seq milk boy
+- エイリアス
+  - `searchq`
+  - `seq`
+  - `sq`
+- 使い方: `seq <キーワード>`
+- 使用例: `seq milk boy`
+---
 ### `サウンドクラウドを検索`コマンド
 曲をSoundCloudで検索します  
-#### エイリアス
-`soundcloudを検索`, `searchs`, `ses`, `ss`
-#### 使い方
-ses <キーワード>
-#### 使用例
-ses sakura trip
+- エイリアス
+  - `soundcloudを検索`
+  - `searchs`
+  - `ses`
+  - `ss`
+- 使い方: `ses <キーワード>`
+- 使用例: `ses sakura trip`
+---
 ### `シャッフル`コマンド
 キューの内容をシャッフルします。  
-#### エイリアス
-`shuffle`
+- エイリアス
+  - `shuffle`
+---
 
 ## ユーティリティ系
 ### `キャンセル`コマンド
 実行中のキャンセル可能な処理がある場合それをすべて中止します。  
-#### エイリアス
-`cancel`, `中止`, `abort`
+- エイリアス
+  - `cancel`
+  - `中止`
+  - `abort`
+---
 ### `インボーク`コマンド
 指定されたコマンドを実行します。基本的に使用しないでください  
-#### エイリアス
-`invoke`
-#### 使い方
-invoke <コマンド>
-#### 使用例
-invoke play 夜に駆ける
+- エイリアス
+  - `invoke`
+- 使い方: `invoke <コマンド>`
+- 使用例: `invoke play 夜に駆ける`
+---
 ### `歌詞`コマンド
 指定された曲の歌詞を検索します。`utaten`をキーワードに入れると、Utatenを優先して検索します。  
-#### エイリアス
-`lyrics`, `l`, `lyric`
-#### 使い方
-l <タイトル、アーティスト等>
-#### 使用例
-l 夜に駆ける
+- エイリアス
+  - `lyrics`
+  - `l`
+  - `lyric`
+- 使い方: `l <タイトル、アーティスト等>`
+- 使用例: `l 夜に駆ける`
+---
 ### `リセット`コマンド
 サーバーのキュー、設定やデータを削除して初期化します。
 ※接続中の場合ボイスチャンネルから離脱します。  
-#### エイリアス
-`reset`
+- エイリアス
+  - `reset`
+---
 ### `システム情報`コマンド
-ホストされているサーバーやプロセスに関する技術的な情報を表示します。引数(`mem`または`cpu`)を指定して特定の内容のみ取得することもできます。  
-#### エイリアス
-`ログ`, `log`, `システム情報`, `systeminfo`, `sysinfo`
-#### 使い方
-sysinfo [mem|cpu]
-#### 使用例
-sysinfo mem
+ホストされているサーバーやプロセスに関する技術的な情報を表示します。引数(`mem`、`cpu`、`basic`のうちいずれか)を指定して特定の内容のみ取得することもできます。  
+- エイリアス
+  - `ログ`
+  - `log`
+  - `システム情報`
+  - `systeminfo`
+  - `sysinfo`
+- 使い方: `sysinfo [mem|cpu]`
+- 使用例: `sysinfo mem`
+---
 ### `アップタイム`コマンド
 ボットのアップタイムおよびping時間(レイテンシ)を表示します。  
-#### エイリアス
-`アップタイム`, `ピング`, `uptime`, `ping`
+- エイリアス
+  - `アップタイム`
+  - `ピング`
+  - `uptime`
+  - `ping`
+---
 
 ## ボット操作全般
 ### `コマンド`コマンド
 コマンド一覧を表示します。コマンド名を渡すとそのコマンドの詳細を表示します。  
-#### エイリアス
-`command`, `commands`, `cmd`
-#### 使い方
-command [コマンド名]
-#### 使用例
-command search
+- エイリアス
+  - `command`
+  - `commands`
+  - `cmd`
+- 使い方: `command [コマンド名]`
+- 使用例: `command search`
+---
 ### `ヘルプ`コマンド
 ヘルプを表示します  
-#### エイリアス
-`help`
+- エイリアス
+  - `help`
+---
 
 (c) 2022 mtripg6666tdr
diff --git a/util/generateCommandList.js b/util/generateCommandList.js
index 12b81d8d8..726c3d59e 100644
--- a/util/generateCommandList.js
+++ b/util/generateCommandList.js
@@ -5,12 +5,12 @@ const { CommandsManager } = require("../dist/Commands");
 const { categories, categoriesList } = require("../dist/Commands/commands");
 
 /**
- * @type { import("../src/Commands").CommandInterface[] }
+ * @type { import("../src/Commands").BaseCommand[] }
  */
 const commands = new CommandsManager().commands.filter(
   /**
    * 
-   * @param { import("../src/Commands").CommandInterface } c 
+   * @param { import("../src/Commands").BaseCommand } c 
    * @returns { boolean }
    */
   c => !c.unlist
@@ -34,7 +34,7 @@ categoriesList.forEach(category => {
   addLine(`- [${categories[category]}](#${categories[category]})`);
 })
 /**
- * @type { {[key in keyof typeof categories]:import("../src/Commands").CommandInterface[] } }
+ * @type { {[key in keyof typeof categories]:import("../src/Commands").BaseCommand[] } }
  */
 // @ts-ignore
 const categorized = {};
@@ -49,21 +49,20 @@ categoriesList.forEach(category => {
   addLine(`## ${categories[category]}`);
   categorized[category].forEach(
     /**
-     * @type { (command:import("../src/Commands").CommandInterface)=>void }
+     * @type { (command:import("../src/Commands").BaseCommand)=>void }
      */
     command => {
       addLine(`### \`${command.name}\`コマンド`);
       addLine(command.description + "  ");
-      addLine(`#### エイリアス`);
-      addLine("`" + command.alias.join("`, `") + "`");
+      addLine(`- エイリアス`);
+      addLine("  - `" + command.alias.join("`\r\n  - `") + "`");
       if(command.usage){
-        addLine("#### 使い方");
-        addLine(command.usage);
+        addLine("- 使い方: `" + command.usage + "`");
       }
       if(command.examples){
-        addLine("#### 使用例");
-        addLine(command.examples);
+        addLine("- 使用例: `" + command.examples + "`");
       }
+      addLine("---");
     }
   )
   addLine("");