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 |
|
23 markand: !roulette |
|
24 irccd: markand, you're lucky this time |
|
25 markand: !roulette |
|
26 irccd: markand, you're lucky this time |
|
27 markand: !roulette |
|
28 markand was kicked by irccd [markand, HEADSHOT] |
|
29 |
|
30 ## Configuration |
|
31 |
|
32 The **roulette** plugin can be configured to use different formats. |
|
33 |
|
34 The following options are available under the `[plugin.roulette]` section: |
|
35 |
|
36 - **format-lucky**: (string) the text to show on luck, |
|
37 - **format-shot**: (string) the text to show on shot. |
|
38 |
|
39 ### Keywords supported |
|
40 |
|
41 The following keywords are supported: |
|
42 |
|
43 | Format | Keywords | Notes | |
|
44 |------------------|-----------------------------------|-----------------------------------| |
|
45 | (any) | server, channel, nickname, origin | all formats | |
|
46 | **format-lucky** | count | the number of cylinder count left | |
|
47 |
|
48 Example: |
|
49 |
|
50 ````ini |
|
51 [plugin.roulette] |
|
52 format-lucky = "#{nickname} you're gonna get shot" |
|
53 format-shot = "BIM" |
|
54 ```` |