Mercurial > irccd
annotate plugins/roulette/roulette.md @ 655:cda30ca5bb76
Irccd: style (controller) #782
author | David Demelier <markand@malikania.fr> |
---|---|
date | Tue, 27 Mar 2018 20:30:59 +0200 |
parents | c143682678b9 |
children | ebe561276c33 |
rev | line source |
---|---|
0 | 1 --- |
2 title: "Roulette plugin" | |
3 header: "Roulette plugin" | |
275
c143682678b9
CMake: improve documentation related to plugins
David Demelier <markand@malikania.fr>
parents:
146
diff
changeset
|
4 guide: yes |
0 | 5 --- |
6 | |
7 The plugin **roulette** is a funny script that let you do a russian roulette game but without any injuries. | |
8 | |
9 ## Installation | |
10 | |
11 The plugin **roulette** is distributed with irccd. To enable it add the following to your `plugins` section: | |
12 | |
13 ````ini | |
14 [plugins] | |
15 roulette = "" | |
16 ```` | |
17 | |
18 ## Usage | |
19 | |
20 The plugin **roulette** just reacts to the special command. | |
21 | |
22 Example: | |
23 | |
20
8384df86e195
Docs: use nohighlight on non code, #418
David Demelier <markand@malikania.fr>
parents:
0
diff
changeset
|
24 ````nohighlight |
8384df86e195
Docs: use nohighlight on non code, #418
David Demelier <markand@malikania.fr>
parents:
0
diff
changeset
|
25 markand: !roulette |
8384df86e195
Docs: use nohighlight on non code, #418
David Demelier <markand@malikania.fr>
parents:
0
diff
changeset
|
26 irccd: markand, you're lucky this time |
8384df86e195
Docs: use nohighlight on non code, #418
David Demelier <markand@malikania.fr>
parents:
0
diff
changeset
|
27 markand: !roulette |
8384df86e195
Docs: use nohighlight on non code, #418
David Demelier <markand@malikania.fr>
parents:
0
diff
changeset
|
28 irccd: markand, you're lucky this time |
8384df86e195
Docs: use nohighlight on non code, #418
David Demelier <markand@malikania.fr>
parents:
0
diff
changeset
|
29 markand: !roulette |
8384df86e195
Docs: use nohighlight on non code, #418
David Demelier <markand@malikania.fr>
parents:
0
diff
changeset
|
30 markand was kicked by irccd [markand, HEADSHOT] |
8384df86e195
Docs: use nohighlight on non code, #418
David Demelier <markand@malikania.fr>
parents:
0
diff
changeset
|
31 ```` |
0 | 32 |
33 ## Configuration | |
34 | |
35 The following options are available under the `[plugin.roulette]` section: | |
36 | |
146
175bc5d41cc4
Plugin roulette: use new format section, #410
David Demelier <markand@malikania.fr>
parents:
48
diff
changeset
|
37 **Deprecated in irccd 2.1.0:** |
175bc5d41cc4
Plugin roulette: use new format section, #410
David Demelier <markand@malikania.fr>
parents:
48
diff
changeset
|
38 |
175bc5d41cc4
Plugin roulette: use new format section, #410
David Demelier <markand@malikania.fr>
parents:
48
diff
changeset
|
39 - **format-lucky**: Use `[format.roulette] lucky` instead, |
175bc5d41cc4
Plugin roulette: use new format section, #410
David Demelier <markand@malikania.fr>
parents:
48
diff
changeset
|
40 - **format-shot**: Use `[format.roulette] shot` instead, |
175bc5d41cc4
Plugin roulette: use new format section, #410
David Demelier <markand@malikania.fr>
parents:
48
diff
changeset
|
41 |
175bc5d41cc4
Plugin roulette: use new format section, #410
David Demelier <markand@malikania.fr>
parents:
48
diff
changeset
|
42 ## Formats |
175bc5d41cc4
Plugin roulette: use new format section, #410
David Demelier <markand@malikania.fr>
parents:
48
diff
changeset
|
43 |
175bc5d41cc4
Plugin roulette: use new format section, #410
David Demelier <markand@malikania.fr>
parents:
48
diff
changeset
|
44 The **roulette** plugin supports the following formats in `[format.roulette]` section: |
175bc5d41cc4
Plugin roulette: use new format section, #410
David Demelier <markand@malikania.fr>
parents:
48
diff
changeset
|
45 |
175bc5d41cc4
Plugin roulette: use new format section, #410
David Demelier <markand@malikania.fr>
parents:
48
diff
changeset
|
46 - **lucky**: (string) the text to show on luck, |
175bc5d41cc4
Plugin roulette: use new format section, #410
David Demelier <markand@malikania.fr>
parents:
48
diff
changeset
|
47 - **shot**: (string) the text to show on shot. |
0 | 48 |
49 ### Keywords supported | |
50 | |
51 The following keywords are supported: | |
52 | |
146
175bc5d41cc4
Plugin roulette: use new format section, #410
David Demelier <markand@malikania.fr>
parents:
48
diff
changeset
|
53 | Format | Keywords | Notes | |
175bc5d41cc4
Plugin roulette: use new format section, #410
David Demelier <markand@malikania.fr>
parents:
48
diff
changeset
|
54 |-----------|----------------------------------------------------|-----------------------------------| |
175bc5d41cc4
Plugin roulette: use new format section, #410
David Demelier <markand@malikania.fr>
parents:
48
diff
changeset
|
55 | (any) | channel, command, nickname, origin, plugin, server | all formats | |
175bc5d41cc4
Plugin roulette: use new format section, #410
David Demelier <markand@malikania.fr>
parents:
48
diff
changeset
|
56 | **lucky** | count | the number of cylinder count left | |
0 | 57 |
58 Example: | |
59 | |
33
e8babd617778
Plugin roulette: improve documentation
David Demelier <markand@malikania.fr>
parents:
20
diff
changeset
|
60 <div class="panel panel-info"> |
e8babd617778
Plugin roulette: improve documentation
David Demelier <markand@malikania.fr>
parents:
20
diff
changeset
|
61 <div class="panel-heading">~/.config/irccd/irccd.conf</div> |
e8babd617778
Plugin roulette: improve documentation
David Demelier <markand@malikania.fr>
parents:
20
diff
changeset
|
62 <div class="panel-body"> |
0 | 63 ````ini |
146
175bc5d41cc4
Plugin roulette: use new format section, #410
David Demelier <markand@malikania.fr>
parents:
48
diff
changeset
|
64 [format.roulette] |
175bc5d41cc4
Plugin roulette: use new format section, #410
David Demelier <markand@malikania.fr>
parents:
48
diff
changeset
|
65 lucky = "#{nickname} you're gonna get shot" |
175bc5d41cc4
Plugin roulette: use new format section, #410
David Demelier <markand@malikania.fr>
parents:
48
diff
changeset
|
66 shot = "BIM" |
0 | 67 ```` |
33
e8babd617778
Plugin roulette: improve documentation
David Demelier <markand@malikania.fr>
parents:
20
diff
changeset
|
68 </div> |
e8babd617778
Plugin roulette: improve documentation
David Demelier <markand@malikania.fr>
parents:
20
diff
changeset
|
69 </div> |