Mercurial > irccd
annotate plugins/hangman/hangman.md @ 379:4507a0895cd3
Irccd: improve --help and --version
author | David Demelier <markand@malikania.fr> |
---|---|
date | Sun, 18 Dec 2016 16:22:18 +0100 |
parents | c143682678b9 |
children | 722f2bbd654a |
rev | line source |
---|---|
0 | 1 --- |
2 title: "Hangman plugin" | |
3 header: "Hangman plugin" | |
275
c143682678b9
CMake: improve documentation related to plugins
David Demelier <markand@malikania.fr>
parents:
141
diff
changeset
|
4 guide: yes |
0 | 5 --- |
6 | |
7 Hangman is a plugin to play the hangman game. | |
8 | |
9 ## Installation | |
10 | |
11 The plugin **hangman** is distributed with irccd. To enable it add the following to your `plugins` section: | |
12 | |
13 ````ini | |
14 [plugins] | |
15 hangman = "" | |
16 ```` | |
17 | |
18 ## Usage | |
19 | |
20 The **hangman** plugin starts when a user execute its special command with no arguments. | |
21 | |
30
1ea775153cdc
Plugin hangman: various fixes in the documentation
David Demelier <markand@malikania.fr>
parents:
20
diff
changeset
|
22 ````nohighlight |
0 | 23 markand: !hangman |
24 irccd: markand, the game is started, the word to find is: _ _ _ _ _ _ _ _ _ _ _ | |
25 ```` | |
26 | |
27 ### Proposal | |
28 | |
29 There are two ways for proposing a response to the game. You can either just ask for a letter or for a whole word. | |
30 | |
31 #### By letter | |
32 | |
30
1ea775153cdc
Plugin hangman: various fixes in the documentation
David Demelier <markand@malikania.fr>
parents:
20
diff
changeset
|
33 When asking a letter, the message must be one letter. |
0 | 34 |
20
8384df86e195
Docs: use nohighlight on non code, #418
David Demelier <markand@malikania.fr>
parents:
0
diff
changeset
|
35 ````nohighlight |
0 | 36 markand: c |
37 irccd: markand, nice! the word is now c _ _ _ _ | |
38 jean: k | |
30
1ea775153cdc
Plugin hangman: various fixes in the documentation
David Demelier <markand@malikania.fr>
parents:
20
diff
changeset
|
39 irccd: jean, there is no 'k'. |
0 | 40 ```` |
41 | |
42 #### By full word | |
43 | |
30
1ea775153cdc
Plugin hangman: various fixes in the documentation
David Demelier <markand@malikania.fr>
parents:
20
diff
changeset
|
44 When asking by a word, just put one word as command argument. |
0 | 45 |
20
8384df86e195
Docs: use nohighlight on non code, #418
David Demelier <markand@malikania.fr>
parents:
0
diff
changeset
|
46 ````nohighlight |
0 | 47 markand: !hangman couch |
48 irccd: markand, this is not the word. | |
49 jean: !hangman candy | |
30
1ea775153cdc
Plugin hangman: various fixes in the documentation
David Demelier <markand@malikania.fr>
parents:
20
diff
changeset
|
50 irccd: jean, congratulations, the word is candy. |
0 | 51 ```` |
52 | |
53 ## Configuration | |
54 | |
55 The following options are available under the `[plugin.hangman]` section: | |
56 | |
30
1ea775153cdc
Plugin hangman: various fixes in the documentation
David Demelier <markand@malikania.fr>
parents:
20
diff
changeset
|
57 - **file**: (string) the path to the database file (Optional, default: configuration directory), |
0 | 58 - **collaborative**: (bool) set to true to enable collaborative mode, a player can't propose two consecutives proposals (Optional, default: true), |
141
2ce88e3a4759
Plugin hangman: use new format section, #410
David Demelier <markand@malikania.fr>
parents:
44
diff
changeset
|
59 |
2ce88e3a4759
Plugin hangman: use new format section, #410
David Demelier <markand@malikania.fr>
parents:
44
diff
changeset
|
60 **Deprecated in irccd 2.1.0:** |
2ce88e3a4759
Plugin hangman: use new format section, #410
David Demelier <markand@malikania.fr>
parents:
44
diff
changeset
|
61 |
2ce88e3a4759
Plugin hangman: use new format section, #410
David Demelier <markand@malikania.fr>
parents:
44
diff
changeset
|
62 - **format-asked**: Use `[format.hangman] asked` instead, |
2ce88e3a4759
Plugin hangman: use new format section, #410
David Demelier <markand@malikania.fr>
parents:
44
diff
changeset
|
63 - **format-dead**: Use `[format.hangman] dead` instead, |
2ce88e3a4759
Plugin hangman: use new format section, #410
David Demelier <markand@malikania.fr>
parents:
44
diff
changeset
|
64 - **format-found**: Use `[format.hangman] found` instead, |
2ce88e3a4759
Plugin hangman: use new format section, #410
David Demelier <markand@malikania.fr>
parents:
44
diff
changeset
|
65 - **format-running**: Use `[format.hangman] running` instead, |
2ce88e3a4759
Plugin hangman: use new format section, #410
David Demelier <markand@malikania.fr>
parents:
44
diff
changeset
|
66 - **format-start**: Use `[format.hangman] start` instead, |
2ce88e3a4759
Plugin hangman: use new format section, #410
David Demelier <markand@malikania.fr>
parents:
44
diff
changeset
|
67 - **format-win**: Use `[format.hangman] win` instead, |
2ce88e3a4759
Plugin hangman: use new format section, #410
David Demelier <markand@malikania.fr>
parents:
44
diff
changeset
|
68 - **format-wrong-word**: Use `[format.hangman] wrong-word` instead, |
2ce88e3a4759
Plugin hangman: use new format section, #410
David Demelier <markand@malikania.fr>
parents:
44
diff
changeset
|
69 - **format-wrong-letter**: Use `[format.hangman] wrong-letter` instead. |
2ce88e3a4759
Plugin hangman: use new format section, #410
David Demelier <markand@malikania.fr>
parents:
44
diff
changeset
|
70 |
2ce88e3a4759
Plugin hangman: use new format section, #410
David Demelier <markand@malikania.fr>
parents:
44
diff
changeset
|
71 ## Formats |
2ce88e3a4759
Plugin hangman: use new format section, #410
David Demelier <markand@malikania.fr>
parents:
44
diff
changeset
|
72 |
2ce88e3a4759
Plugin hangman: use new format section, #410
David Demelier <markand@malikania.fr>
parents:
44
diff
changeset
|
73 The **hangman** plugin supports the following formats in `[format.hangman]` section: |
2ce88e3a4759
Plugin hangman: use new format section, #410
David Demelier <markand@malikania.fr>
parents:
44
diff
changeset
|
74 |
2ce88e3a4759
Plugin hangman: use new format section, #410
David Demelier <markand@malikania.fr>
parents:
44
diff
changeset
|
75 - **asked**: (string) when a letter has been already asked but present in the word (Optional), |
2ce88e3a4759
Plugin hangman: use new format section, #410
David Demelier <markand@malikania.fr>
parents:
44
diff
changeset
|
76 - **dead**: (string) when the man was hung (Optional), |
2ce88e3a4759
Plugin hangman: use new format section, #410
David Demelier <markand@malikania.fr>
parents:
44
diff
changeset
|
77 - **found**: (string) when a correct letter has been placed (Optional), |
2ce88e3a4759
Plugin hangman: use new format section, #410
David Demelier <markand@malikania.fr>
parents:
44
diff
changeset
|
78 - **running**: (string) when a game is requested but it's already running (Optional), |
2ce88e3a4759
Plugin hangman: use new format section, #410
David Demelier <markand@malikania.fr>
parents:
44
diff
changeset
|
79 - **start**: (string) when the game starts (Optional), |
2ce88e3a4759
Plugin hangman: use new format section, #410
David Demelier <markand@malikania.fr>
parents:
44
diff
changeset
|
80 - **win**: (string) when the game succeeded (Optional), |
2ce88e3a4759
Plugin hangman: use new format section, #410
David Demelier <markand@malikania.fr>
parents:
44
diff
changeset
|
81 - **wrong-word**: (string) when a word proposal is wrong (Optional), |
2ce88e3a4759
Plugin hangman: use new format section, #410
David Demelier <markand@malikania.fr>
parents:
44
diff
changeset
|
82 - **wrong-letter**: (string) when a letter proposal is wrong (Optional). |
0 | 83 |
84 ### Keywords supported | |
85 | |
86 The following keywords are supported: | |
87 | |
44
c4fe9a8b1a62
Plugin hangman: fix usage of server keyword and document command, plugin, #392
David Demelier <markand@malikania.fr>
parents:
30
diff
changeset
|
88 | Format | Keywords | Notes | |
c4fe9a8b1a62
Plugin hangman: fix usage of server keyword and document command, plugin, #392
David Demelier <markand@malikania.fr>
parents:
30
diff
changeset
|
89 |-------------------------|----------------------------------------------------|---------------------------------| |
c4fe9a8b1a62
Plugin hangman: fix usage of server keyword and document command, plugin, #392
David Demelier <markand@malikania.fr>
parents:
30
diff
changeset
|
90 | (any) | channel, command, nickname, origin, plugin, server | all formats | |
141
2ce88e3a4759
Plugin hangman: use new format section, #410
David Demelier <markand@malikania.fr>
parents:
44
diff
changeset
|
91 | **asked** | letter | the letter proposal | |
2ce88e3a4759
Plugin hangman: use new format section, #410
David Demelier <markand@malikania.fr>
parents:
44
diff
changeset
|
92 | **dead** | word | the word to find | |
2ce88e3a4759
Plugin hangman: use new format section, #410
David Demelier <markand@malikania.fr>
parents:
44
diff
changeset
|
93 | **found** | word | the hidden word | |
2ce88e3a4759
Plugin hangman: use new format section, #410
David Demelier <markand@malikania.fr>
parents:
44
diff
changeset
|
94 | **start** | word | the hidden word | |
2ce88e3a4759
Plugin hangman: use new format section, #410
David Demelier <markand@malikania.fr>
parents:
44
diff
changeset
|
95 | **win** | word | the word to find | |
2ce88e3a4759
Plugin hangman: use new format section, #410
David Demelier <markand@malikania.fr>
parents:
44
diff
changeset
|
96 | **wrong-word** | word | the invalid word proposal | |
2ce88e3a4759
Plugin hangman: use new format section, #410
David Demelier <markand@malikania.fr>
parents:
44
diff
changeset
|
97 | **wrong-letter** | letter | the letter proposal | |
0 | 98 |
99 Example: | |
100 | |
30
1ea775153cdc
Plugin hangman: various fixes in the documentation
David Demelier <markand@malikania.fr>
parents:
20
diff
changeset
|
101 <div class="panel panel-info"> |
1ea775153cdc
Plugin hangman: various fixes in the documentation
David Demelier <markand@malikania.fr>
parents:
20
diff
changeset
|
102 <div class="panel-heading">~/.config/irccd/irccd.conf</div> |
1ea775153cdc
Plugin hangman: various fixes in the documentation
David Demelier <markand@malikania.fr>
parents:
20
diff
changeset
|
103 <div class="panel-body"> |
0 | 104 ````ini |
141
2ce88e3a4759
Plugin hangman: use new format section, #410
David Demelier <markand@malikania.fr>
parents:
44
diff
changeset
|
105 [format.hangman] |
2ce88e3a4759
Plugin hangman: use new format section, #410
David Demelier <markand@malikania.fr>
parents:
44
diff
changeset
|
106 win = "nice job, the word was #{word}!" |
2ce88e3a4759
Plugin hangman: use new format section, #410
David Demelier <markand@malikania.fr>
parents:
44
diff
changeset
|
107 wrong-letter = "please try again, there is no #{letter}" |
0 | 108 ```` |
30
1ea775153cdc
Plugin hangman: various fixes in the documentation
David Demelier <markand@malikania.fr>
parents:
20
diff
changeset
|
109 </div> |
1ea775153cdc
Plugin hangman: various fixes in the documentation
David Demelier <markand@malikania.fr>
parents:
20
diff
changeset
|
110 </div> |
0 | 111 |
112 ## Database file | |
113 | |
30
1ea775153cdc
Plugin hangman: various fixes in the documentation
David Demelier <markand@malikania.fr>
parents:
20
diff
changeset
|
114 The database file must contains one word per line, it must be saved as UTF-8. |
0 | 115 |
30
1ea775153cdc
Plugin hangman: various fixes in the documentation
David Demelier <markand@malikania.fr>
parents:
20
diff
changeset
|
116 <div class="panel panel-info"> |
1ea775153cdc
Plugin hangman: various fixes in the documentation
David Demelier <markand@malikania.fr>
parents:
20
diff
changeset
|
117 <div class="panel-heading">~/.config/irccd/plugin/hangman/words.conf</div> |
1ea775153cdc
Plugin hangman: various fixes in the documentation
David Demelier <markand@malikania.fr>
parents:
20
diff
changeset
|
118 <div class="panel-body"> |
20
8384df86e195
Docs: use nohighlight on non code, #418
David Demelier <markand@malikania.fr>
parents:
0
diff
changeset
|
119 ````nohighlight |
0 | 120 sky |
121 irccd | |
122 FreeBSD | |
123 door | |
124 cat | |
125 ```` |