Mercurial > irccd

annotate plugins/roulette/roulette.md @ 33:e8babd617778

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Plugin roulette: improve documentation
author David Demelier <markand@malikania.fr>
date Mon, 22 Feb 2016 13:31:12 +0100
parents 8384df86e195
children ce3e96deb9e4
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
0
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
1 ---
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
2 title: "Roulette plugin"
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
3 header: "Roulette plugin"
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
4 ---
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
5
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
6 The plugin **roulette** is a funny script that let you do a russian roulette game but without any injuries.
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
7
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
8 ## Installation
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
9
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
10 The plugin **roulette** is distributed with irccd. To enable it add the following to your `plugins` section:
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
11
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
12 ````ini
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
13 [plugins]
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
14 roulette = ""
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
15 ````
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
16
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
17 ## Usage
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
18
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
19 The plugin **roulette** just reacts to the special command.
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
20
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
21 Example:
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
22
20
8384df86e195 Docs: use nohighlight on non code, #418
David Demelier <markand@malikania.fr>
parents: 0
diff changeset
23 ````nohighlight
8384df86e195 Docs: use nohighlight on non code, #418
David Demelier <markand@malikania.fr>
parents: 0
diff changeset
24 markand: !roulette
8384df86e195 Docs: use nohighlight on non code, #418
David Demelier <markand@malikania.fr>
parents: 0
diff changeset
25 irccd: markand, you're lucky this time
8384df86e195 Docs: use nohighlight on non code, #418
David Demelier <markand@malikania.fr>
parents: 0
diff changeset
26 markand: !roulette
8384df86e195 Docs: use nohighlight on non code, #418
David Demelier <markand@malikania.fr>
parents: 0
diff changeset
27 irccd: markand, you're lucky this time
8384df86e195 Docs: use nohighlight on non code, #418
David Demelier <markand@malikania.fr>
parents: 0
diff changeset
28 markand: !roulette
8384df86e195 Docs: use nohighlight on non code, #418
David Demelier <markand@malikania.fr>
parents: 0
diff changeset
29 markand was kicked by irccd [markand, HEADSHOT]
8384df86e195 Docs: use nohighlight on non code, #418
David Demelier <markand@malikania.fr>
parents: 0
diff changeset
30 ````
0
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
31
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
32 ## Configuration
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
33
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
34 The **roulette** plugin can be configured to use different formats.
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
35
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
36 The following options are available under the `[plugin.roulette]` section:
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
37
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
38 - **format-lucky**: (string) the text to show on luck,
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
39 - **format-shot**: (string) the text to show on shot.
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
40
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
41 ### Keywords supported
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
42
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
43 The following keywords are supported:
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
44
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
45 | Format | Keywords | Notes |
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
46 |------------------|-----------------------------------|-----------------------------------|
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
47 | (any) | server, channel, nickname, origin | all formats |
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
48 | **format-lucky** | count | the number of cylinder count left |
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
49
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
50 Example:
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
51
33
e8babd617778 Plugin roulette: improve documentation
David Demelier <markand@malikania.fr>
parents: 20
diff changeset
52 <div class="panel panel-info">
e8babd617778 Plugin roulette: improve documentation
David Demelier <markand@malikania.fr>
parents: 20
diff changeset
53 <div class="panel-heading">~/.config/irccd/irccd.conf</div>
e8babd617778 Plugin roulette: improve documentation
David Demelier <markand@malikania.fr>
parents: 20
diff changeset
54 <div class="panel-body">
0
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
55 ````ini
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
56 [plugin.roulette]
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
57 format-lucky = "#{nickname} you're gonna get shot"
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
58 format-shot = "BIM"
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
59 ````
33
e8babd617778 Plugin roulette: improve documentation
David Demelier <markand@malikania.fr>
parents: 20
diff changeset
60 </div>
e8babd617778 Plugin roulette: improve documentation
David Demelier <markand@malikania.fr>
parents: 20
diff changeset
61 </div>