diff plugins/roulette/roulette.md @ 146:175bc5d41cc4

Plugin roulette: use new format section, #410
author David Demelier <markand@malikania.fr>
date Thu, 19 May 2016 22:29:15 +0200
parents ce3e96deb9e4
children c143682678b9
line wrap: on
line diff
--- a/plugins/roulette/roulette.md	Thu May 19 22:21:54 2016 +0200
+++ b/plugins/roulette/roulette.md	Thu May 19 22:29:15 2016 +0200
@@ -31,21 +31,28 @@
 
 ## Configuration
 
-The **roulette** plugin can be configured to use different formats.
-
 The following options are available under the `[plugin.roulette]` section:
 
-  - **format-lucky**: (string) the text to show on luck,
-  - **format-shot**: (string) the text to show on shot.
+**Deprecated in irccd 2.1.0:**
+
+  - **format-lucky**: Use `[format.roulette] lucky` instead,
+  - **format-shot**: Use `[format.roulette] shot` instead,
+
+## Formats
+
+The **roulette** plugin supports the following formats in `[format.roulette]` section:
+
+  - **lucky**: (string) the text to show on luck,
+  - **shot**: (string) the text to show on shot.
 
 ### Keywords supported
 
 The following keywords are supported:
 
-| Format           | Keywords                                           | Notes                             |
-|------------------|----------------------------------------------------|-----------------------------------|
-| (any)            | channel, command, nickname, origin, plugin, server | all formats                       |
-| **format-lucky** | count                                              | the number of cylinder count left |
+| Format    | Keywords                                           | Notes                             |
+|-----------|----------------------------------------------------|-----------------------------------|
+| (any)     | channel, command, nickname, origin, plugin, server | all formats                       |
+| **lucky** | count                                              | the number of cylinder count left |
 
 Example:
 
@@ -53,9 +60,9 @@
  <div class="panel-heading">~/.config/irccd/irccd.conf</div>
  <div class="panel-body">
 ````ini
-[plugin.roulette]
-format-lucky = "#{nickname} you're gonna get shot"
-format-shot = "BIM"
+[format.roulette]
+lucky = "#{nickname} you're gonna get shot"
+shot = "BIM"
 ````
  </div>
 </div>