Mercurial > irccd
annotate plugins/tictactoe/tictactoe.7 @ 913:5e25439fe98d
misc: update years
author | David Demelier <markand@malikania.fr> |
---|---|
date | Mon, 03 Feb 2020 20:20:00 +0100 |
parents | 00a4720c4874 |
children | 474a46e240ff |
rev | line source |
---|---|
845
00a4720c4874
doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
1 .\" |
913 | 2 .\" Copyright (c) 2013-2020 David Demelier <markand@malikania.fr> |
845
00a4720c4874
doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
3 .\" |
00a4720c4874
doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
4 .\" Permission to use, copy, modify, and/or distribute this software for any |
00a4720c4874
doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
5 .\" purpose with or without fee is hereby granted, provided that the above |
00a4720c4874
doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
6 .\" copyright notice and this permission notice appear in all copies. |
00a4720c4874
doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
7 .\" |
00a4720c4874
doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
8 .\" THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES |
00a4720c4874
doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
9 .\" WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF |
00a4720c4874
doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
10 .\" MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR |
00a4720c4874
doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
11 .\" ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES |
00a4720c4874
doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
12 .\" WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN |
00a4720c4874
doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
13 .\" ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF |
00a4720c4874
doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
14 .\" OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. |
00a4720c4874
doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
15 .\" |
00a4720c4874
doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
16 .Dd @IRCCD_MAN_DATE@ |
00a4720c4874
doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
17 .Dt IRCCD-PLUGIN-TICTACTOE 7 |
00a4720c4874
doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
18 .Os |
00a4720c4874
doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
19 .\" NAME |
00a4720c4874
doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
20 .Sh NAME |
00a4720c4874
doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
21 .Nm tictactoe |
00a4720c4874
doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
22 .Nd irccd tictactoe plugin |
00a4720c4874
doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
23 .\" DESCRIPTION |
00a4720c4874
doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
24 .Sh DESCRIPTION |
00a4720c4874
doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
25 The |
00a4720c4874
doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
26 .Nm |
00a4720c4874
doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
27 plugin let you play tictactoe over IRC. |
00a4720c4874
doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
28 .Pp |
00a4720c4874
doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
29 Warning: this plugin is extremely verbose, don't enable it blindly. |
00a4720c4874
doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
30 .\" INSTALLATION |
00a4720c4874
doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
31 .Sh INSTALLATION |
00a4720c4874
doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
32 The plugin |
00a4720c4874
doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
33 .Nm |
00a4720c4874
doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
34 is distributed with irccd. To enable it add the following to your plugins |
00a4720c4874
doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
35 section: |
00a4720c4874
doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
36 .Pp |
00a4720c4874
doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
37 .Bd -literal |
00a4720c4874
doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
38 [plugins] |
00a4720c4874
doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
39 tictactoe = "" |
00a4720c4874
doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
40 .Ed |
00a4720c4874
doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
41 .\" USAGE |
00a4720c4874
doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
42 .Sh USAGE |
00a4720c4874
doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
43 Use the special command with the target opponent nickname. Then each player send |
00a4720c4874
doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
44 a message in the form |
00a4720c4874
doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
45 .Ar "x y" |
00a4720c4874
doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
46 where x targets the column and y the row. |
00a4720c4874
doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
47 .Pp |
00a4720c4874
doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
48 To verify target opponent, this plugins first requests the names on the channel |
00a4720c4874
doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
49 to ensures a valid player. |
00a4720c4874
doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
50 .Pp |
00a4720c4874
doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
51 If one of the players leaves the channel (either by kick or part) the game is |
00a4720c4874
doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
52 aborted silently. |
00a4720c4874
doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
53 .Pp |
00a4720c4874
doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
54 Example when starting a game: |
00a4720c4874
doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
55 .Bd -literal -offset Ds |
00a4720c4874
doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
56 markand: !tictactoe francis |
00a4720c4874
doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
57 irccd: a b c |
00a4720c4874
doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
58 irccd: 1 . . . |
00a4720c4874
doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
59 irccd: 2 . . . |
00a4720c4874
doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
60 irccd: 3 . . . |
00a4720c4874
doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
61 irccd: markand, it's your turn |
00a4720c4874
doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
62 .Ed |
00a4720c4874
doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
63 .Pp |
00a4720c4874
doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
64 And then, placing tokens: |
00a4720c4874
doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
65 .Bd -literal -offset Ds |
00a4720c4874
doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
66 20:27 < markand> a 1 |
00a4720c4874
doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
67 20:27 < irccd> a b c |
00a4720c4874
doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
68 20:27 < irccd> 1 x . . |
00a4720c4874
doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
69 20:27 < irccd> 2 . . . |
00a4720c4874
doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
70 20:27 < irccd> 3 . . . |
00a4720c4874
doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
71 20:27 < irccd> francis, it's your turn |
00a4720c4874
doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
72 20:27 <@francis> c 1 |
00a4720c4874
doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
73 20:27 < irccd> a b c |
00a4720c4874
doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
74 20:27 < irccd> 1 x . o |
00a4720c4874
doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
75 20:27 < irccd> 2 . . . |
00a4720c4874
doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
76 20:27 < irccd> 3 . . . |
00a4720c4874
doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
77 20:27 < irccd> markand, it's your turn |
00a4720c4874
doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
78 20:27 < markand> a 2 |
00a4720c4874
doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
79 20:27 < irccd> a b c |
00a4720c4874
doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
80 20:27 < irccd> 1 x . o |
00a4720c4874
doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
81 20:27 < irccd> 2 x . . |
00a4720c4874
doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
82 20:27 < irccd> 3 . . . |
00a4720c4874
doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
83 20:27 < irccd> francis, it's your turn |
00a4720c4874
doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
84 20:27 <@francis> c 3 |
00a4720c4874
doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
85 20:27 < irccd> a b c |
00a4720c4874
doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
86 20:27 < irccd> 1 x . o |
00a4720c4874
doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
87 20:27 < irccd> 2 x . . |
00a4720c4874
doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
88 20:27 < irccd> 3 . . o |
00a4720c4874
doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
89 20:27 < irccd> markand, it's your turn |
00a4720c4874
doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
90 20:27 < markand> a 3 |
00a4720c4874
doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
91 20:27 < irccd> a b c |
00a4720c4874
doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
92 20:27 < irccd> 1 x . o |
00a4720c4874
doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
93 20:27 < irccd> 2 x . . |
00a4720c4874
doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
94 20:27 < irccd> 3 x . o |
00a4720c4874
doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
95 20:27 < irccd> francis, it's your turn |
00a4720c4874
doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
96 20:27 < irccd> markand, congratulations, you won! |
00a4720c4874
doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
97 .Ed |
00a4720c4874
doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
98 .\" TEMPLATES |
00a4720c4874
doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
99 .Sh TEMPLATES |
00a4720c4874
doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
100 The |
00a4720c4874
doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
101 .Nm |
00a4720c4874
doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
102 plugin supports the following templates in |
00a4720c4874
doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
103 .Va [templates.tictactoe] |
00a4720c4874
doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
104 section: |
00a4720c4874
doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
105 .Bl -tag -width 8n -offset Ds |
00a4720c4874
doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
106 .It Va draw |
00a4720c4874
doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
107 When the game ended with no winner. |
00a4720c4874
doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
108 .It Va invalid |
00a4720c4874
doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
109 The opponent does not exist or is not valid. Keywords: |
00a4720c4874
doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
110 .Em origin . |
00a4720c4874
doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
111 .It Va running |
00a4720c4874
doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
112 The game is already running. Keywords: |
00a4720c4874
doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
113 .Em origin . |
00a4720c4874
doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
114 .It Va turn |
00a4720c4874
doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
115 Message sent when current player change. |
00a4720c4874
doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
116 .It Va used |
00a4720c4874
doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
117 The cell requested is already used. |
00a4720c4874
doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
118 .It Va win |
00a4720c4874
doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
119 Game ended with a winner. |
00a4720c4874
doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
120 .El |
00a4720c4874
doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
121 .Pp |
00a4720c4874
doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
122 All templates support the following standard keywords: |
00a4720c4874
doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
123 .Em channel , command , nickname , plugin , server . |
00a4720c4874
doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
124 .\" SEE ALSO |
00a4720c4874
doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
125 .Sh SEE ALSO |
00a4720c4874
doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
126 .Xr irccd 1 , |
00a4720c4874
doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
127 .Xr irccd-templates 7 |