Mercurial > irccd
annotate plugins/roulette/roulette.md @ 189:bb70bb9e41eb
Irccd: use native Duktape API
author | David Demelier <markand@malikania.fr> |
---|---|
date | Fri, 03 Jun 2016 13:28:10 +0200 |
parents | 175bc5d41cc4 |
children | c143682678b9 |
rev | line source |
---|---|
0 | 1 --- |
2 title: "Roulette plugin" | |
3 header: "Roulette plugin" | |
4 --- | |
5 | |
6 The plugin **roulette** is a funny script that let you do a russian roulette game but without any injuries. | |
7 | |
8 ## Installation | |
9 | |
10 The plugin **roulette** is distributed with irccd. To enable it add the following to your `plugins` section: | |
11 | |
12 ````ini | |
13 [plugins] | |
14 roulette = "" | |
15 ```` | |
16 | |
17 ## Usage | |
18 | |
19 The plugin **roulette** just reacts to the special command. | |
20 | |
21 Example: | |
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 | 31 |
32 ## Configuration | |
33 | |
34 The following options are available under the `[plugin.roulette]` section: | |
35 | |
146
175bc5d41cc4
Plugin roulette: use new format section, #410
David Demelier <markand@malikania.fr>
parents:
48
diff
changeset
|
36 **Deprecated in irccd 2.1.0:** |
175bc5d41cc4
Plugin roulette: use new format section, #410
David Demelier <markand@malikania.fr>
parents:
48
diff
changeset
|
37 |
175bc5d41cc4
Plugin roulette: use new format section, #410
David Demelier <markand@malikania.fr>
parents:
48
diff
changeset
|
38 - **format-lucky**: Use `[format.roulette] lucky` instead, |
175bc5d41cc4
Plugin roulette: use new format section, #410
David Demelier <markand@malikania.fr>
parents:
48
diff
changeset
|
39 - **format-shot**: Use `[format.roulette] shot` instead, |
175bc5d41cc4
Plugin roulette: use new format section, #410
David Demelier <markand@malikania.fr>
parents:
48
diff
changeset
|
40 |
175bc5d41cc4
Plugin roulette: use new format section, #410
David Demelier <markand@malikania.fr>
parents:
48
diff
changeset
|
41 ## Formats |
175bc5d41cc4
Plugin roulette: use new format section, #410
David Demelier <markand@malikania.fr>
parents:
48
diff
changeset
|
42 |
175bc5d41cc4
Plugin roulette: use new format section, #410
David Demelier <markand@malikania.fr>
parents:
48
diff
changeset
|
43 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
|
44 |
175bc5d41cc4
Plugin roulette: use new format section, #410
David Demelier <markand@malikania.fr>
parents:
48
diff
changeset
|
45 - **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
|
46 - **shot**: (string) the text to show on shot. |
0 | 47 |
48 ### Keywords supported | |
49 | |
50 The following keywords are supported: | |
51 | |
146
175bc5d41cc4
Plugin roulette: use new format section, #410
David Demelier <markand@malikania.fr>
parents:
48
diff
changeset
|
52 | Format | Keywords | Notes | |
175bc5d41cc4
Plugin roulette: use new format section, #410
David Demelier <markand@malikania.fr>
parents:
48
diff
changeset
|
53 |-----------|----------------------------------------------------|-----------------------------------| |
175bc5d41cc4
Plugin roulette: use new format section, #410
David Demelier <markand@malikania.fr>
parents:
48
diff
changeset
|
54 | (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
|
55 | **lucky** | count | the number of cylinder count left | |
0 | 56 |
57 Example: | |
58 | |
33
e8babd617778
Plugin roulette: improve documentation
David Demelier <markand@malikania.fr>
parents:
20
diff
changeset
|
59 <div class="panel panel-info"> |
e8babd617778
Plugin roulette: improve documentation
David Demelier <markand@malikania.fr>
parents:
20
diff
changeset
|
60 <div class="panel-heading">~/.config/irccd/irccd.conf</div> |
e8babd617778
Plugin roulette: improve documentation
David Demelier <markand@malikania.fr>
parents:
20
diff
changeset
|
61 <div class="panel-body"> |
0 | 62 ````ini |
146
175bc5d41cc4
Plugin roulette: use new format section, #410
David Demelier <markand@malikania.fr>
parents:
48
diff
changeset
|
63 [format.roulette] |
175bc5d41cc4
Plugin roulette: use new format section, #410
David Demelier <markand@malikania.fr>
parents:
48
diff
changeset
|
64 lucky = "#{nickname} you're gonna get shot" |
175bc5d41cc4
Plugin roulette: use new format section, #410
David Demelier <markand@malikania.fr>
parents:
48
diff
changeset
|
65 shot = "BIM" |
0 | 66 ```` |
33
e8babd617778
Plugin roulette: improve documentation
David Demelier <markand@malikania.fr>
parents:
20
diff
changeset
|
67 </div> |
e8babd617778
Plugin roulette: improve documentation
David Demelier <markand@malikania.fr>
parents:
20
diff
changeset
|
68 </div> |