rg: ドキュメント・設定ファイルの更新

issue: #9
cre-ne-jp · Jan 11, 2016 · 9c2bd28 · 9c2bd28
1 parent dcbb9ec
commit 9c2bd28
Show file tree

Hide file tree

Showing 2 changed files with 32 additions and 0 deletions.
diff --git a/config/random_generator.yaml b/config/random_generator.yaml
@@ -1,3 +1,4 @@
 # ランダムジェネレータプラグインの設定
 RandomGenerator:
+  # 表の一覧表示を行うコマンド .rg-list の応答として、実際の一覧ではなくリファレンスなどのURLを出力したいときは以下に文字列を指定する。
   ListReply: "コマンドリファレンス http://www.cre.ne.jp/services/irc/bots/rgrb/rg-reference をご覧ください"
diff --git a/doc/plugins/random_generator.md b/doc/plugins/random_generator.md
@@ -99,3 +99,34 @@ RandomGenerator
 ##### rg-info: 「_table_」なんて表は見つからないのですわっ。
 
 決定表が見つからない場合に返ります。
+
+### 決定表の一覧
+
+#### 書式
+
+```
+.rg-list
+```
+
+#### 説明
+
+引くことが出来る決定表を一覧します。
+設定を変更することで、任意の決まったメッセージを出力することも出来ます。
+
+#### 例
+
+```
+.rg-list
+> rg-list: 10kan, 12shi, 64ke, 6you, 8planet, 9planet, (後略)
+```
+
+#### 設定
+
+設定ファイルに以下を追加して、プラグインの設定を行います。
+
+```yaml
+# ランダムジェネレータプラグインの設定
+RandomGenerator:
+  # 表の一覧表示を行うコマンド .rg-list の応答として、実際の一覧ではなくリファレンスなどのURLを出力したいときは以下に文字列を指定する。
+  ListReply: "コマンドリファレンス http://www.cre.ne.jp/services/irc/bots/rgrb/rg-reference をご覧ください"
+```