Mercurial > irccd

annotate plugins/roulette/roulette.md @ 647:23fd8bad4006

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Irccd: style (plugin) #782
author David Demelier <markand@malikania.fr>
date Sat, 24 Mar 2018 07:55:14 +0100
parents c143682678b9
children ebe561276c33
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"
275
c143682678b9 CMake: improve documentation related to plugins
David Demelier <markand@malikania.fr>
parents: 146
diff changeset
4 guide: yes
0
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
5 ---
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
6
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
7 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
8
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
9 ## Installation
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
10
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
11 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
12
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
13 ````ini
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
14 [plugins]
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
15 roulette = ""
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
16 ````
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
17
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
18 ## Usage
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
19
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
20 The plugin **roulette** just reacts to the special command.
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
21
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
22 Example:
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
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
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
32
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
33 ## Configuration
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
34
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
35 The following options are available under the `[plugin.roulette]` section:
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
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
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
48
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
49 ### Keywords supported
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
50
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
51 The following keywords are supported:
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
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
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
57
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
58 Example:
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 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
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
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
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
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>