Mercurial > irccd
annotate plugins/ask/ask.md @ 174:fcfa8ac395fd
Irccd: unbreak test-js-util
author | David Demelier <markand@malikania.fr> |
---|---|
date | Wed, 25 May 2016 22:43:59 +0200 |
parents | 19df514cb61c |
children | c143682678b9 |
rev | line source |
---|---|
0 | 1 --- |
2 title: "Ask plugin" | |
3 header: "Ask plugin" | |
4 --- | |
5 | |
28
9a907e58f978
Plugin ask: fix errors in documentation
David Demelier <markand@malikania.fr>
parents:
20
diff
changeset
|
6 The plugin **ask** is funny script that helps you in your life. It will tells you if you will be rich, famous and so on. |
0 | 7 |
8 ## Installation | |
9 | |
10 The plugin **ask** is distributed with irccd. To enable it add the following to your `plugins` section: | |
11 | |
12 ````ini | |
13 [plugins] | |
14 ask = "" | |
15 ```` | |
16 | |
17 ## Usage | |
18 | |
19 The plugin **ask** reacts to special command, you just need to do `!ask the question` and it will give you a response. | |
20 | |
28
9a907e58f978
Plugin ask: fix errors in documentation
David Demelier <markand@malikania.fr>
parents:
20
diff
changeset
|
21 ## Example |
0 | 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: !ask will I be rich? |
8384df86e195
Docs: use nohighlight on non code, #418
David Demelier <markand@malikania.fr>
parents:
0
diff
changeset
|
25 irccd: markand, No. |
8384df86e195
Docs: use nohighlight on non code, #418
David Demelier <markand@malikania.fr>
parents:
0
diff
changeset
|
26 ```` |
0 | 27 |
149
19df514cb61c
Plugin ask: add optional file parameter, #504
David Demelier <markand@malikania.fr>
parents:
28
diff
changeset
|
28 ## File |
0 | 29 |
149
19df514cb61c
Plugin ask: add optional file parameter, #504
David Demelier <markand@malikania.fr>
parents:
28
diff
changeset
|
30 By default, **ask** will only answer yes or no. It's possible to add any answers you want in the file **answers.conf** located in the ask |
19df514cb61c
Plugin ask: add optional file parameter, #504
David Demelier <markand@malikania.fr>
parents:
28
diff
changeset
|
31 configuration directory. |
0 | 32 |
33 Just add one line per answer like this: | |
34 | |
28
9a907e58f978
Plugin ask: fix errors in documentation
David Demelier <markand@malikania.fr>
parents:
20
diff
changeset
|
35 <div class="panel panel-info"> |
9a907e58f978
Plugin ask: fix errors in documentation
David Demelier <markand@malikania.fr>
parents:
20
diff
changeset
|
36 <div class="panel-heading">~/.config/irccd/plugin/ask/answers.conf</div> |
9a907e58f978
Plugin ask: fix errors in documentation
David Demelier <markand@malikania.fr>
parents:
20
diff
changeset
|
37 <div class="panel-body"> |
20
8384df86e195
Docs: use nohighlight on non code, #418
David Demelier <markand@malikania.fr>
parents:
0
diff
changeset
|
38 ````nohighlight |
8384df86e195
Docs: use nohighlight on non code, #418
David Demelier <markand@malikania.fr>
parents:
0
diff
changeset
|
39 Stop dreaming, |
8384df86e195
Docs: use nohighlight on non code, #418
David Demelier <markand@malikania.fr>
parents:
0
diff
changeset
|
40 Definitely sure! |
8384df86e195
Docs: use nohighlight on non code, #418
David Demelier <markand@malikania.fr>
parents:
0
diff
changeset
|
41 Maybe |
8384df86e195
Docs: use nohighlight on non code, #418
David Demelier <markand@malikania.fr>
parents:
0
diff
changeset
|
42 ```` |
28
9a907e58f978
Plugin ask: fix errors in documentation
David Demelier <markand@malikania.fr>
parents:
20
diff
changeset
|
43 </div> |
9a907e58f978
Plugin ask: fix errors in documentation
David Demelier <markand@malikania.fr>
parents:
20
diff
changeset
|
44 </div> |
149
19df514cb61c
Plugin ask: add optional file parameter, #504
David Demelier <markand@malikania.fr>
parents:
28
diff
changeset
|
45 |
19df514cb61c
Plugin ask: add optional file parameter, #504
David Demelier <markand@malikania.fr>
parents:
28
diff
changeset
|
46 ## Configuration |
19df514cb61c
Plugin ask: add optional file parameter, #504
David Demelier <markand@malikania.fr>
parents:
28
diff
changeset
|
47 |
19df514cb61c
Plugin ask: add optional file parameter, #504
David Demelier <markand@malikania.fr>
parents:
28
diff
changeset
|
48 The following options are available under the `[plugin.ask]` section: |
19df514cb61c
Plugin ask: add optional file parameter, #504
David Demelier <markand@malikania.fr>
parents:
28
diff
changeset
|
49 |
19df514cb61c
Plugin ask: add optional file parameter, #504
David Demelier <markand@malikania.fr>
parents:
28
diff
changeset
|
50 - **file**: (string) the path to the database file (Optional, default: **answers.conf** in configuration directory). |