Mercurial > irccd

comparison plugins/roulette/roulette.7 @ 845:00a4720c4874

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
doc: rewrite documentation in manual pages, closes #1674 Get rid of markdown documentation and the custom generator tools, instead use raw manual pages.
author David Demelier <markand@malikania.fr>
date Mon, 08 Jul 2019 16:15:57 +0200
parents
children a23b7b574ed2
comparison
equal deleted inserted replaced
844:dc6b42d7b97a 845:00a4720c4874
1 .\"
2 .\" Copyright (c) 2013-2019 David Demelier <markand@malikania.fr>
3 .\"
4 .\" Permission to use, copy, modify, and/or distribute this software for any
5 .\" purpose with or without fee is hereby granted, provided that the above
6 .\" copyright notice and this permission notice appear in all copies.
7 .\"
8 .\" THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
9 .\" WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
10 .\" MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
11 .\" ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
12 .\" WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
13 .\" ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
14 .\" OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
15 .\"
16 .Dd @IRCCD_MAN_DATE@
17 .Dt IRCCD-PLUGIN-ROULETTE 7
18 .Os
19 .\" NAME
20 .Sh NAME
21 .Nm roulette
22 .Nd irccd roulette plugin
23 .\" DESCRIPTION
24 .Sh DESCRIPTION
25 The
26 .Nm
27 plugin is a funny script that let you do a russian roulette game but without any
28 injuries.
29 .Pp
30 Note: the bot will perform a kick command if the user is being shot so you must
31 be sure to have channel operator mode set on irccd.
32 .\" INSTALLATION
33 .Sh INSTALLATION
34 The plugin
35 .Nm
36 is distributed with irccd. To enable it add the following to your plugins
37 section:
38 .Pp
39 .Bd -literal
40 [plugins]
41 roulette = ""
42 .Ed
43 .\" USAGE
44 .Sh USAGE
45 The
46 .Nm
47 plugin simply reacts to the special command.
48 .Bd -literal -offset Ds
49 markand: !roulette
50 irccd: markand, you're lucky this time
51 markand: !roulette
52 irccd: markand, you're lucky this time
53 markand: !roulette
54 markand was kicked by irccd [markand, HEADSHOT]
55 .Ed
56 .\" TEMPLATES
57 .Sh TEMPLATES
58 The
59 .Nm
60 plugin supports the following templates in
61 .Va [templates.hangman]
62 section:
63 .Bl -tag -width 8n -offset Ds
64 .It Va lucky
65 The text to show on luck. Keywords:
66 .Em count
67 (the number of turns left in the cylinder).
68 .It Va shot
69 The text to show on shot.
70 .El
71 .Pp
72 All templates support the following standard keywords:
73 .Em channel , command , nickname , origin , plugin , server .
74 .\" EXAMPLES
75 .Sh EXAMPLES
76 Example of configuration file:
77 .Bd -literal
78 [format.roulette]
79 lucky = "#{nickname} you're gonna get shot"
80 shot = "BIM"
81 .Ed
82 .\" SEE ALSO
83 .Sh SEE ALSO
84 .Xr irccd 1 ,
85 .Xr irccd-templates 7