Mercurial > irccd
annotate plugins/tictactoe/tictactoe.md @ 632:e5d0f4289e04
Plugin tictactoe: brand new plugin, closes #393 @6h
author | David Demelier <markand@malikania.fr> |
---|---|
date | Tue, 13 Mar 2018 13:51:17 +0100 |
parents | |
children | ebe561276c33 |
rev | line source |
---|---|
632
e5d0f4289e04
Plugin tictactoe: brand new plugin, closes #393 @6h
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
1 --- |
e5d0f4289e04
Plugin tictactoe: brand new plugin, closes #393 @6h
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
2 title: "Tictactoe plugin" |
e5d0f4289e04
Plugin tictactoe: brand new plugin, closes #393 @6h
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
3 header: "Tictactoe plugin" |
e5d0f4289e04
Plugin tictactoe: brand new plugin, closes #393 @6h
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
4 guide: yes |
e5d0f4289e04
Plugin tictactoe: brand new plugin, closes #393 @6h
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
5 --- |
e5d0f4289e04
Plugin tictactoe: brand new plugin, closes #393 @6h
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
6 |
e5d0f4289e04
Plugin tictactoe: brand new plugin, closes #393 @6h
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
7 This plugin let you play tictactoe over IRC. |
e5d0f4289e04
Plugin tictactoe: brand new plugin, closes #393 @6h
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
8 |
e5d0f4289e04
Plugin tictactoe: brand new plugin, closes #393 @6h
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
9 Warning: this plugin is verbose. |
e5d0f4289e04
Plugin tictactoe: brand new plugin, closes #393 @6h
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
10 |
e5d0f4289e04
Plugin tictactoe: brand new plugin, closes #393 @6h
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
11 ## Installation |
e5d0f4289e04
Plugin tictactoe: brand new plugin, closes #393 @6h
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
12 |
e5d0f4289e04
Plugin tictactoe: brand new plugin, closes #393 @6h
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
13 The plugin **tictactoe** is distributed with irccd. To enable it add the following |
e5d0f4289e04
Plugin tictactoe: brand new plugin, closes #393 @6h
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
14 to your `plugins` section: |
e5d0f4289e04
Plugin tictactoe: brand new plugin, closes #393 @6h
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
15 |
e5d0f4289e04
Plugin tictactoe: brand new plugin, closes #393 @6h
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
16 ```ini |
e5d0f4289e04
Plugin tictactoe: brand new plugin, closes #393 @6h
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
17 [plugins] |
e5d0f4289e04
Plugin tictactoe: brand new plugin, closes #393 @6h
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
18 tictactoe = "" |
e5d0f4289e04
Plugin tictactoe: brand new plugin, closes #393 @6h
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
19 ``` |
e5d0f4289e04
Plugin tictactoe: brand new plugin, closes #393 @6h
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
20 |
e5d0f4289e04
Plugin tictactoe: brand new plugin, closes #393 @6h
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
21 ## Usage |
e5d0f4289e04
Plugin tictactoe: brand new plugin, closes #393 @6h
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
22 |
e5d0f4289e04
Plugin tictactoe: brand new plugin, closes #393 @6h
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
23 Execute **tictactoe** plugin with the target opponent nickname. Then each player |
e5d0f4289e04
Plugin tictactoe: brand new plugin, closes #393 @6h
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
24 send a message in the form **x y** where x targets the column and y the row. |
e5d0f4289e04
Plugin tictactoe: brand new plugin, closes #393 @6h
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
25 |
e5d0f4289e04
Plugin tictactoe: brand new plugin, closes #393 @6h
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
26 To verify target opponent, this plugins first requests the names on the channel |
e5d0f4289e04
Plugin tictactoe: brand new plugin, closes #393 @6h
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
27 to ensures a valid player. |
e5d0f4289e04
Plugin tictactoe: brand new plugin, closes #393 @6h
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
28 |
e5d0f4289e04
Plugin tictactoe: brand new plugin, closes #393 @6h
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
29 If one of the players leaves the channel (either by kick or part) the game is |
e5d0f4289e04
Plugin tictactoe: brand new plugin, closes #393 @6h
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
30 aborted. |
e5d0f4289e04
Plugin tictactoe: brand new plugin, closes #393 @6h
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
31 |
e5d0f4289e04
Plugin tictactoe: brand new plugin, closes #393 @6h
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
32 ```nohighlight |
e5d0f4289e04
Plugin tictactoe: brand new plugin, closes #393 @6h
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
33 markand: !tictactoe francis |
e5d0f4289e04
Plugin tictactoe: brand new plugin, closes #393 @6h
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
34 irccd: a b c |
e5d0f4289e04
Plugin tictactoe: brand new plugin, closes #393 @6h
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
35 irccd: 1 . . . |
e5d0f4289e04
Plugin tictactoe: brand new plugin, closes #393 @6h
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
36 irccd: 2 . . . |
e5d0f4289e04
Plugin tictactoe: brand new plugin, closes #393 @6h
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
37 irccd: 3 . . . |
e5d0f4289e04
Plugin tictactoe: brand new plugin, closes #393 @6h
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
38 irccd: markand, it's your turn |
e5d0f4289e04
Plugin tictactoe: brand new plugin, closes #393 @6h
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
39 ``` |
e5d0f4289e04
Plugin tictactoe: brand new plugin, closes #393 @6h
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
40 |
e5d0f4289e04
Plugin tictactoe: brand new plugin, closes #393 @6h
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
41 And then, placing tokens. |
e5d0f4289e04
Plugin tictactoe: brand new plugin, closes #393 @6h
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
42 |
e5d0f4289e04
Plugin tictactoe: brand new plugin, closes #393 @6h
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
43 ```nohighlight |
e5d0f4289e04
Plugin tictactoe: brand new plugin, closes #393 @6h
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
44 20:27 < markand> a 1 |
e5d0f4289e04
Plugin tictactoe: brand new plugin, closes #393 @6h
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
45 20:27 < irccd> a b c |
e5d0f4289e04
Plugin tictactoe: brand new plugin, closes #393 @6h
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
46 20:27 < irccd> 1 x . . |
e5d0f4289e04
Plugin tictactoe: brand new plugin, closes #393 @6h
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
47 20:27 < irccd> 2 . . . |
e5d0f4289e04
Plugin tictactoe: brand new plugin, closes #393 @6h
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
48 20:27 < irccd> 3 . . . |
e5d0f4289e04
Plugin tictactoe: brand new plugin, closes #393 @6h
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
49 20:27 < irccd> francis, it's your turn |
e5d0f4289e04
Plugin tictactoe: brand new plugin, closes #393 @6h
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
50 20:27 <@francis> c 1 |
e5d0f4289e04
Plugin tictactoe: brand new plugin, closes #393 @6h
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
51 20:27 < irccd> a b c |
e5d0f4289e04
Plugin tictactoe: brand new plugin, closes #393 @6h
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
52 20:27 < irccd> 1 x . o |
e5d0f4289e04
Plugin tictactoe: brand new plugin, closes #393 @6h
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
53 20:27 < irccd> 2 . . . |
e5d0f4289e04
Plugin tictactoe: brand new plugin, closes #393 @6h
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
54 20:27 < irccd> 3 . . . |
e5d0f4289e04
Plugin tictactoe: brand new plugin, closes #393 @6h
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
55 20:27 < irccd> markand, it's your turn |
e5d0f4289e04
Plugin tictactoe: brand new plugin, closes #393 @6h
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
56 20:27 < markand> a 2 |
e5d0f4289e04
Plugin tictactoe: brand new plugin, closes #393 @6h
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
57 20:27 < irccd> a b c |
e5d0f4289e04
Plugin tictactoe: brand new plugin, closes #393 @6h
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
58 20:27 < irccd> 1 x . o |
e5d0f4289e04
Plugin tictactoe: brand new plugin, closes #393 @6h
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
59 20:27 < irccd> 2 x . . |
e5d0f4289e04
Plugin tictactoe: brand new plugin, closes #393 @6h
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
60 20:27 < irccd> 3 . . . |
e5d0f4289e04
Plugin tictactoe: brand new plugin, closes #393 @6h
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
61 20:27 < irccd> francis, it's your turn |
e5d0f4289e04
Plugin tictactoe: brand new plugin, closes #393 @6h
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
62 20:27 <@francis> c 3 |
e5d0f4289e04
Plugin tictactoe: brand new plugin, closes #393 @6h
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
63 20:27 < irccd> a b c |
e5d0f4289e04
Plugin tictactoe: brand new plugin, closes #393 @6h
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
64 20:27 < irccd> 1 x . o |
e5d0f4289e04
Plugin tictactoe: brand new plugin, closes #393 @6h
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
65 20:27 < irccd> 2 x . . |
e5d0f4289e04
Plugin tictactoe: brand new plugin, closes #393 @6h
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
66 20:27 < irccd> 3 . . o |
e5d0f4289e04
Plugin tictactoe: brand new plugin, closes #393 @6h
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
67 20:27 < irccd> markand, it's your turn |
e5d0f4289e04
Plugin tictactoe: brand new plugin, closes #393 @6h
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
68 20:27 < markand> a 3 |
e5d0f4289e04
Plugin tictactoe: brand new plugin, closes #393 @6h
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
69 20:27 < irccd> a b c |
e5d0f4289e04
Plugin tictactoe: brand new plugin, closes #393 @6h
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
70 20:27 < irccd> 1 x . o |
e5d0f4289e04
Plugin tictactoe: brand new plugin, closes #393 @6h
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
71 20:27 < irccd> 2 x . . |
e5d0f4289e04
Plugin tictactoe: brand new plugin, closes #393 @6h
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
72 20:27 < irccd> 3 x . o |
e5d0f4289e04
Plugin tictactoe: brand new plugin, closes #393 @6h
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
73 20:27 < irccd> francis, it's your turn |
e5d0f4289e04
Plugin tictactoe: brand new plugin, closes #393 @6h
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
74 20:27 < irccd> markand, congratulations, you won! |
e5d0f4289e04
Plugin tictactoe: brand new plugin, closes #393 @6h
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
75 ``` |
e5d0f4289e04
Plugin tictactoe: brand new plugin, closes #393 @6h
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
76 |
e5d0f4289e04
Plugin tictactoe: brand new plugin, closes #393 @6h
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
77 ## Formats |
e5d0f4289e04
Plugin tictactoe: brand new plugin, closes #393 @6h
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
78 |
e5d0f4289e04
Plugin tictactoe: brand new plugin, closes #393 @6h
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
79 The **tictactoe** plugin supports the following formats in `[format.tictactoe]` |
e5d0f4289e04
Plugin tictactoe: brand new plugin, closes #393 @6h
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
80 section: |
e5d0f4289e04
Plugin tictactoe: brand new plugin, closes #393 @6h
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
81 |
e5d0f4289e04
Plugin tictactoe: brand new plugin, closes #393 @6h
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
82 - **draw**: when the game ended with no winner, |
e5d0f4289e04
Plugin tictactoe: brand new plugin, closes #393 @6h
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
83 - **invalid**: the opponent does not exist or is not valid, |
e5d0f4289e04
Plugin tictactoe: brand new plugin, closes #393 @6h
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
84 - **running**: the game is already running, |
e5d0f4289e04
Plugin tictactoe: brand new plugin, closes #393 @6h
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
85 - **turn**: message sent when current player change, |
e5d0f4289e04
Plugin tictactoe: brand new plugin, closes #393 @6h
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
86 - **used**: the cell requested is already used, |
e5d0f4289e04
Plugin tictactoe: brand new plugin, closes #393 @6h
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
87 - **win**: game ended with a winner. |
e5d0f4289e04
Plugin tictactoe: brand new plugin, closes #393 @6h
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
88 |
e5d0f4289e04
Plugin tictactoe: brand new plugin, closes #393 @6h
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
89 ### Keywords supported |
e5d0f4289e04
Plugin tictactoe: brand new plugin, closes #393 @6h
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
90 |
e5d0f4289e04
Plugin tictactoe: brand new plugin, closes #393 @6h
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
91 The following keywords are supported: |
e5d0f4289e04
Plugin tictactoe: brand new plugin, closes #393 @6h
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
92 |
e5d0f4289e04
Plugin tictactoe: brand new plugin, closes #393 @6h
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
93 | Format | Keywords | Notes | |
e5d0f4289e04
Plugin tictactoe: brand new plugin, closes #393 @6h
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
94 |---------|--------------------------------------------|-------------| |
e5d0f4289e04
Plugin tictactoe: brand new plugin, closes #393 @6h
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
95 | (any) | channel, command, nickname, plugin, server | all formats | |
e5d0f4289e04
Plugin tictactoe: brand new plugin, closes #393 @6h
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
96 | invalid | origin | | |
e5d0f4289e04
Plugin tictactoe: brand new plugin, closes #393 @6h
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
97 | running | origin | | |