1 |
pcg |
1.1 |
<?xml version="1.0" encoding="utf-8"?> |
2 |
|
|
<html> |
3 |
|
|
<head> |
4 |
|
|
<title>KGS Protocol Description</title> |
5 |
pcg |
1.37 |
<meta http-equiv="Content-Type" content="text/html; charset=utf-8"/> |
6 |
pcg |
1.1 |
<!-- |
7 |
|
|
Copyright (C) 2003 Marc Lehmannn <pcg@goof.com> |
8 |
|
|
|
9 |
|
|
You can redistribute and/or modify this document under the terms of |
10 |
|
|
the GNU General Public License as published by the Free Software |
11 |
|
|
Foundation; either version 2 of the License, or (at your option) any |
12 |
|
|
later version. |
13 |
|
|
|
14 |
|
|
This document is distributed in the hope that it will be useful, |
15 |
|
|
but WITHOUT ANY WARRANTY; without even the implied warranty of |
16 |
|
|
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU |
17 |
|
|
General Public License for more details. |
18 |
|
|
|
19 |
|
|
You should have received a copy of the GNU General Public License |
20 |
|
|
along with this program; if not, write to the Free Software |
21 |
|
|
Foundation, Inc. 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA |
22 |
|
|
--> |
23 |
|
|
</head> |
24 |
|
|
<body> |
25 |
|
|
|
26 |
pcg |
1.37 |
<h1>$Revision: 1.36 $</h1> |
27 |
pcg |
1.10 |
|
28 |
pcg |
1.1 |
<h1>KGS Protocol Description</h1> |
29 |
|
|
|
30 |
|
|
<p>This XML document describes the KGS protocol. It is also used |
31 |
|
|
to automatically generate the perl parser for all the messages and |
32 |
|
|
structures in the protocol. Adapting it to other languages should be |
33 |
pcg |
1.33 |
almost trivial.</p> |
34 |
pcg |
1.10 |
|
35 |
pcg |
1.37 |
<p><b>Please note that wms has told me that he will change the |
36 |
|
|
protocol in response to my efforts. No problems with changing the |
37 |
|
|
protocol for good, but he does this just to make it more difficult |
38 |
|
|
to reverse-engineer it, since his changes are neither required, nor |
39 |
|
|
useful (they just make the protocol less robust, without adding added |
40 |
|
|
value). He doesn't even care that this locks out some users who cannot |
41 |
|
|
upgrade (cgoban2 isn't available for their platform anymore). It hurts |
42 |
|
|
to see such a waste of time and efforts that could have been used to |
43 |
|
|
fix bugs or improve the client...</b></p> |
44 |
pcg |
1.1 |
|
45 |
pcg |
1.4 |
<p>If you feel you need to update the visual appearance of this |
46 |
pcg |
1.11 |
document, feel free to look <tt>doc/doc2html.xsl</tt> and improve |
47 |
pcg |
1.4 |
it.</p> |
48 |
|
|
|
49 |
pcg |
1.8 |
<p>The current version of this document can always be found at |
50 |
|
|
<a href="http://cvs.sourceforge.net/cgi-bin/viewcvs.cgi/*checkout*/kgsueme/kgsueme/doc/protocol.xml?rev=HEAD&content-type=text/xml">here</a>, while |
51 |
|
|
the HTML version of it can be found |
52 |
|
|
<a href="http://cvs.sourceforge.net/cgi-bin/viewcvs.cgi/*checkout*/kgsueme/kgsueme/doc/protocol.html?rev=HEAD&content-type=text/html">here</a>. |
53 |
pcg |
1.32 |
(update: sourceforge is weeks behind on their anonymous cvs servers so the above might be out-of-date. sorry.)</p> |
54 |
pcg |
1.23 |
|
55 |
pcg |
1.1 |
<h2>Structure and conventions of this document and the protocol</h2> |
56 |
|
|
|
57 |
pcg |
1.32 |
<p>"ORIGIN: CLIENT" means messages send from the client to the server, |
58 |
|
|
while "ORIGIN: SERVER" means messages send by the server to the |
59 |
|
|
client.</p> |
60 |
pcg |
1.1 |
|
61 |
pcg |
1.4 |
<p>Everything on the wire is in little-endian format (what a shame).</p> |
62 |
pcg |
1.1 |
|
63 |
pcg |
1.4 |
<p>Primitive types are mostly integers (signed |
64 |
|
|
"<code>I</code><bits>", unsigned "<code>U</code><bits>"), |
65 |
|
|
ascii strings ("<code>username</code>"), or zero-terminated |
66 |
|
|
UCS2-Strings ("<code>STRING</code>"). Yes, I know java is supposed to |
67 |
|
|
do UTF-16, but no implementation seems to care...</p> |
68 |
pcg |
1.1 |
|
69 |
pcg |
1.17 |
<p>For the rest, go figure or bug me, <a href="mailto:pcg@goof.com">Marc Lehmann <pcg@goof.com></a></p> |
70 |
pcg |
1.1 |
|
71 |
|
|
<h2>Stream and message structure.</h2> |
72 |
|
|
|
73 |
pcg |
1.4 |
<p>After connecting to the server, a handshake byte is sent. It's |
74 |
|
|
the major version number of the protocol the client expects to |
75 |
|
|
receive. Version 3 and 4 are mostly the same, except that Version 4 |
76 |
|
|
clients expect server messages to be compressed, version 3 clients |
77 |
|
|
not.</p> |
78 |
|
|
|
79 |
|
|
<p>The server sends back his protocol number, which is always 3 in |
80 |
|
|
the current protocol. Most of the protocol variation is determined by |
81 |
|
|
the server using the client version that is used in the initial login |
82 |
|
|
message, not the initial handshake byte.</p> |
83 |
pcg |
1.1 |
|
84 |
|
|
<p>After the initial handshake, the client sends uncompressed |
85 |
|
|
messages, while the server sends back a zlib-compressed |
86 |
|
|
stream (<a href="http://rfc1950.x42.com/">rfc1950</a> and <a |
87 |
|
|
href="http://rfc1950.x42.com/">rfc1951</a>).</p> |
88 |
|
|
|
89 |
|
|
<p>All messages have the same header:</p> |
90 |
|
|
|
91 |
pcg |
1.28 |
<struct name="message_header"> |
92 |
pcg |
1.3 |
<member name="_unknown" type="U16"/> |
93 |
|
|
<member name="length" type="U16"/> |
94 |
pcg |
1.23 |
|
95 |
pcg |
1.18 |
<p>The length is the length of the full message including the header.</p> |
96 |
pcg |
1.23 |
|
97 |
pcg |
1.24 |
<p>Beginning with version 2.5.x, a number is xored into the low |
98 |
|
|
byte of the length in <em>sent</em> packages only, as given by the |
99 |
|
|
following recurrence: <code>rand[0] = 0; rand[i+1] = msg[i].length |
100 |
|
|
+ (rand[i] * 0x04c2af9b + 0xfffffffb); xorbyte = rand >> |
101 |
|
|
24</code>, all in 32 bit unsigned iso-c arithmetic.</p> |
102 |
pcg |
1.23 |
|
103 |
pcg |
1.3 |
<member name="type" type="U16"/> |
104 |
pcg |
1.18 |
<p>If the type is >= 0x4000 this is a message for a specific channel. The channel |
105 |
|
|
number is always the next U16.</p> |
106 |
pcg |
1.24 |
|
107 |
|
|
<p>Beginning with version 2.5.x, a number is <em>added</em> on <em>received</em> |
108 |
|
|
messages only. The algorithm is as follows: |
109 |
|
|
|
110 |
|
|
<pre> |
111 |
|
|
msglen < 44: type = typefield |
112 |
|
|
msglen > 44: type = (typefield + rand[i]) % 0x10000 |
113 |
|
|
rand[0] = 0 |
114 |
|
|
rand[i+1] = username[type % length username] + rand[i] * (type - 0x6cdd) |
115 |
|
|
where username is the user name of the logged-in user. coooool. |
116 |
|
|
</pre> |
117 |
|
|
</p> |
118 |
|
|
|
119 |
pcg |
1.3 |
</struct> |
120 |
|
|
|
121 |
|
|
<h2>Primitive types used in the protocol.</h2> |
122 |
|
|
|
123 |
pcg |
1.9 |
<p>Apart from the basic types, I need to define some extra types to |
124 |
|
|
deal with fixed-point values (based on integer types) or fixed-length |
125 |
|
|
strings (either 7-bit-ascii or more limited (<code>A</code>), or UCS-2 |
126 |
|
|
based (<code>S</code>)).</p> |
127 |
pcg |
1.3 |
|
128 |
pcg |
1.23 |
<type name="username" type="A" length="10"/> |
129 |
pcg |
1.9 |
|
130 |
|
|
<p>The basic user or login name, used throughout the protocol |
131 |
|
|
as a handle to the user.</p> |
132 |
|
|
|
133 |
pcg |
1.3 |
<type name="roomname" type="S" length="25"/><!-- argh, how horribly broken --> |
134 |
pcg |
1.9 |
|
135 |
|
|
<p>Many strings in the protocol are fixed-width for no good reason |
136 |
pcg |
1.18 |
(maybe this is one reason for using compression in newer versions, as |
137 |
pcg |
1.9 |
the packets itself are wasting lots of space.</p> |
138 |
|
|
|
139 |
pcg |
1.16 |
<type name="realname" type="S" length="50"/> |
140 |
|
|
<type name="email" type="S" length="70"/> |
141 |
|
|
<type name="userinfo" type="S" length="1000"/> |
142 |
|
|
<type name="url" type="A" length="100"/> |
143 |
|
|
|
144 |
|
|
<p>Used in user_record.</p> |
145 |
|
|
|
146 |
pcg |
1.3 |
<type name="locale" type="A" length="5"/> |
147 |
pcg |
1.9 |
|
148 |
|
|
<p>A kind of locale specifier. It seems the general format seems to be |
149 |
|
|
lowercase language, underscore, uppercase location, e.g. en_US. More |
150 |
|
|
fancy specifications don't fit.</p> |
151 |
|
|
|
152 |
pcg |
1.3 |
<type name="flag" type="U8" multiplier="1"/> |
153 |
pcg |
1.9 |
|
154 |
|
|
<p>Just a simple boolean value. 0 means false, and 1 generally true, |
155 |
|
|
but I suggest ccepting != 0 as true.</p> |
156 |
|
|
|
157 |
pcg |
1.6 |
<type name="komi16" type="I16" multiplier="2"/> |
158 |
|
|
<type name="komi32" type="I32" multiplier="2"/> |
159 |
pcg |
1.20 |
<type name="komi324" type="I32" multiplier="4"/> |
160 |
pcg |
1.9 |
|
161 |
|
|
<p>Komi values are multiplied by 2 to make them integer in the |
162 |
pcg |
1.20 |
protocol. Well, *most* of the time at least...</p> |
163 |
pcg |
1.9 |
|
164 |
pcg |
1.3 |
<type name="result" type="I32" multiplier="2"/> |
165 |
pcg |
1.9 |
|
166 |
pcg |
1.15 |
<p>The game result is also multiplied by two to give it higher |
167 |
|
|
resolution. There are also special values for wins by time etc., either |
168 |
|
|
in result or in the score* types, or both :)</p> |
169 |
pcg |
1.9 |
|
170 |
pcg |
1.13 |
<type name="score16" type="I16" multiplier="4"/> |
171 |
|
|
<type name="score32" type="I32" multiplier="4"/> |
172 |
pcg |
1.27 |
<type name="score1000" type="I32" multiplier="1000"/> |
173 |
pcg |
1.9 |
|
174 |
|
|
<p>A score value (used for displaying the score at the end of a game) |
175 |
pcg |
1.15 |
are multiplied by four for a change (the 0.25 resolution is not |
176 |
|
|
used). In game structures it is encoded by dividing by two, though, so |
177 |
pcg |
1.27 |
watch out! And in some others, it's encoded by multiplying by 1000... |
178 |
|
|
yuck!</p> |
179 |
pcg |
1.9 |
|
180 |
pcg |
1.7 |
<type name="time" type="U32" multiplier="1000"/> |
181 |
pcg |
1.1 |
|
182 |
pcg |
1.9 |
<p>Time values are multiplied by 1000, giving them millisecond |
183 |
|
|
accuracy.</p> |
184 |
|
|
|
185 |
pcg |
1.16 |
<type name="timestamp" type="U64" multiplier="1000"/> |
186 |
|
|
|
187 |
|
|
<p>64 bit timeval, milliseconds since posix epoch, e.g. <code>my |
188 |
|
|
($year, $month, $day) = (gmtime $date * 0.001)[5,4,3];</code></p> |
189 |
|
|
|
190 |
pcg |
1.17 |
<type name="password" type="U64"/> |
191 |
|
|
|
192 |
|
|
<p>Password is a number calculated as follows (VERY insecure, basically |
193 |
|
|
plaintext!): <code>password = 0; for char in characters do password ← |
194 |
|
|
password * 1055 + ascii_code (char)</code></p> |
195 |
|
|
|
196 |
pcg |
1.37 |
<h2>Enumeration and set types used in the protocol.</h2> |
197 |
pcg |
1.1 |
|
198 |
pcg |
1.37 |
<enum name="GAMETYPE"> |
199 |
|
|
<member name="DEMONSTRATION" value="0"/> |
200 |
|
|
<member name="TEACHING" value="1"/> |
201 |
|
|
<member name="FREE" value="2"/> |
202 |
|
|
<member name="RATED" value="3"/> |
203 |
|
|
<member name="TYPE4" value="4"/> |
204 |
|
|
Probably not used, but the protocol has space for it it seems. |
205 |
|
|
</enum> |
206 |
|
|
|
207 |
|
|
<enum name="GAMEOPT"> |
208 |
|
|
<member name="NONE" value="0"/> |
209 |
|
|
<member name="LECTURE" value="1"/> |
210 |
|
|
<member name="PRIVATE" value="2"/> |
211 |
|
|
<member name="SIMUL" value="3"/> |
212 |
|
|
</enum> |
213 |
|
|
|
214 |
|
|
<set name="GAMEFLAG"> |
215 |
|
|
<member name="SCORED" value="1"/> |
216 |
|
|
<member name="ADJOURNED" value="2"/> |
217 |
|
|
<member name="UPLOADED" value="4"/> |
218 |
|
|
</set> |
219 |
|
|
|
220 |
|
|
<enum name="SCORE"> |
221 |
|
|
<p>Special score values, in addition to numerical scores. Some are also used with their |
222 |
|
|
negative value.</p> |
223 |
|
|
|
224 |
|
|
<member name="TIMEOUT" value="16384 / 4"/> |
225 |
|
|
Also used negatively to score for white instead of black. |
226 |
|
|
|
227 |
|
|
<member name="RESIGN" value="16385 / 4"/> |
228 |
|
|
Also used negatively to score for white instead of black. |
229 |
|
|
|
230 |
|
|
<member name="FORFEIT" value=" 0 / 4"/> |
231 |
|
|
Also used negatively to score for white instead of black. |
232 |
|
|
|
233 |
|
|
<member name="JIGO" value="16386 / 4"/> |
234 |
|
|
|
235 |
|
|
<member name="NO_RESULT" value="16386 / 4"/> |
236 |
|
|
<member name="ADJOURNED" value="16387 / 4"/> |
237 |
|
|
<member name="UNKNOWN" value="16389 / 4"/> |
238 |
|
|
</enum> |
239 |
|
|
|
240 |
|
|
<enum name="RULESET"> |
241 |
|
|
<member name="JAPANESE" value="0"/> |
242 |
|
|
<member name="CHINESE " value="1"/> |
243 |
|
|
<member name="AGA" value="2"/> |
244 |
|
|
<member name="NEW_ZEALAND" value="3"/> |
245 |
|
|
</enum> |
246 |
|
|
|
247 |
|
|
<enum name="TIMESYS"> |
248 |
|
|
<member name="NONE" value="0"/> |
249 |
|
|
<member name="ABSOLUTE" value="1"/> |
250 |
|
|
<member name="BYO_YOMI" value="2"/> |
251 |
|
|
<member name="CANADIAN" value="3"/> |
252 |
|
|
</enum> |
253 |
|
|
|
254 |
|
|
<enum name="COLOUR"> |
255 |
|
|
<p>Convinience constants used in several places.</p> |
256 |
|
|
<member name="BLACK" value="0"/> |
257 |
|
|
<member name="WHITE" value="1"/> |
258 |
|
|
</enum> |
259 |
pcg |
1.1 |
|
260 |
pcg |
1.3 |
<h2>Structs used in send & receive messages</h2> |
261 |
pcg |
1.1 |
|
262 |
pcg |
1.3 |
<struct name="user" class="KGS::User"> |
263 |
pcg |
1.9 |
|
264 |
pcg |
1.18 |
<p>Everywhere a user + flags is required, even used in some places |
265 |
pcg |
1.9 |
where only a username is required. I see no general rule on when a |
266 |
pcg |
1.18 |
complete user and when a partial user is required.</p> |
267 |
pcg |
1.9 |
|
268 |
pcg |
1.3 |
<member name="name" type="username"/> |
269 |
pcg |
1.37 |
<member name="flags" type="U32" value="1"/> |
270 |
pcg |
1.3 |
</struct> |
271 |
pcg |
1.1 |
|
272 |
pcg |
1.6 |
<struct name="rules" class="KGS::Rules"> |
273 |
pcg |
1.9 |
|
274 |
pcg |
1.18 |
<p>This structure is used for challanges as well as in the special |
275 |
|
|
TREE "subprotocol". It tightly encodes the game parameters.</p> |
276 |
pcg |
1.9 |
|
277 |
pcg |
1.6 |
<member name="ruleset" type="U8"/> |
278 |
|
|
<member name="size" type="U8"/> |
279 |
|
|
<member name="handicap" type="U8"/> |
280 |
|
|
<member name="komi" type="komi16"/> |
281 |
|
|
<member name="timesys" type="U8"/> |
282 |
|
|
<member name="time" type="U32"/> |
283 |
|
|
<member name="interval" type="U32"/> |
284 |
|
|
byo-yomi time / canadian time |
285 |
|
|
<member name="count" type="U16"/> |
286 |
|
|
periods / moves |
287 |
|
|
</struct> |
288 |
|
|
|
289 |
pcg |
1.32 |
<h2>Structs used in messages from the client</h2> |
290 |
pcg |
1.1 |
|
291 |
pcg |
1.32 |
<h2>Client-generated messages</h2> |
292 |
pcg |
1.18 |
|
293 |
pcg |
1.31 |
<message type="0000" name="login" src="client"> |
294 |
pcg |
1.9 |
|
295 |
pcg |
1.18 |
<p>Sent to login, usually the first message sent. The password needs to be set when the |
296 |
pcg |
1.9 |
guest flag is true. |
297 |
pcg |
1.18 |
Possible replies: <ref reply="login"/>. Followed by: <ref reply="timewarning_default"/> <ref reply="chal_defaults"/> |
298 |
|
|
</p> |
299 |
pcg |
1.9 |
|
300 |
pcg |
1.37 |
<member name="ver_major" type="U32" value="2"/> |
301 |
|
|
<member name="ver_minor" type="U32" value="5"/> |
302 |
|
|
<member name="ver_micro" type="U32" value="1"/> |
303 |
|
|
<member name="name" type="username"/> |
304 |
|
|
<member name="password" type="password" value="0"/> |
305 |
|
|
<member name="guest" type="flag" value="1"/> |
306 |
|
|
<member name="_unknown3" type="U16" value="0"/> |
307 |
|
|
<member name="locale" type="locale" value='"en_US"'/> |
308 |
|
|
<member name="clientver" type="DATA" value='"1.4.1_01:Swing app:Sun Microsystems Inc."'/> |
309 |
pcg |
1.4 |
The "default" is the java vm version, not exactly he client version. However, |
310 |
pcg |
1.18 |
you should always send a text like "Jonathan's C client bersion 0.6" or somesuch, |
311 |
pcg |
1.4 |
so the server can, if necessary, block broken clients or client versions. |
312 |
pcg |
1.1 |
</message> |
313 |
|
|
|
314 |
pcg |
1.31 |
<message type="0007" name="req_userinfo" src="client"> |
315 |
pcg |
1.18 |
<p>Request info about a certain user. Possible reply: <ref reply="userinfo"/></p> |
316 |
pcg |
1.17 |
<member name="name" type="username"/> |
317 |
|
|
</message> |
318 |
|
|
|
319 |
pcg |
1.31 |
<message type="0007" name="update_userinfo" src="client"> |
320 |
pcg |
1.18 |
<p>Update user info. Message structure is very similar |
321 |
|
|
to <ref ref="userinfo"/>.</p> |
322 |
pcg |
1.17 |
<member name="setpass" type="flag"/> |
323 |
|
|
Should the password be updated? |
324 |
pcg |
1.37 |
<member name="password" type="password" value="0"/> |
325 |
pcg |
1.17 |
<member name="realname" type="realname"/> |
326 |
|
|
<member name="email" type="email"/> |
327 |
|
|
<member name="info" type="userinfo"/> |
328 |
|
|
<member name="homepage" type="url"/> |
329 |
pcg |
1.37 |
<member name="_unused" type="U64" value="0"/> |
330 |
|
|
<member name="_unused" type="U64" value="0"/> |
331 |
pcg |
1.17 |
</message> |
332 |
|
|
|
333 |
pcg |
1.36 |
<message type="0013" name="msg_chat" src="client"> |
334 |
|
|
<p>This message is sent to initiate or continue a private chat with |
335 |
|
|
a user. You'll always receive a copy of what you have sent back |
336 |
|
|
from the server (as usual).</p> |
337 |
|
|
|
338 |
|
|
<member name="name" type="username"/> |
339 |
|
|
Name of sender ("yourself"). |
340 |
|
|
<member name="name2" type="username"/> |
341 |
|
|
Name of recipient. |
342 |
|
|
<member name="message" type="STRING"/> |
343 |
|
|
The message. |
344 |
|
|
</message> |
345 |
|
|
|
346 |
pcg |
1.31 |
<message type="0014" name="req_stats" src="client"> |
347 |
pcg |
1.18 |
<p>Request server statistics. Replied with <ref reply="stats"/></p> |
348 |
pcg |
1.19 |
</message> |
349 |
|
|
|
350 |
pcg |
1.31 |
<message type="0016" name="idle_reset" src="client"> |
351 |
pcg |
1.29 |
<p>Send in response to <ref reply="idle_warn"/> to keep the server from disconnecting.</p> |
352 |
|
|
</message> |
353 |
|
|
|
354 |
pcg |
1.31 |
<message type="001d" name="ping" src="client"> |
355 |
pcg |
1.19 |
<p>Wild guess, I send it in <ref ref="idle_warn"/>.</p> |
356 |
pcg |
1.1 |
</message> |
357 |
|
|
|
358 |
pcg |
1.31 |
<message type="001e" name="req_usergraph" src="client"> |
359 |
pcg |
1.18 |
<p>Request user graph data, replied with <ref reply="usergraph"/>.</p> |
360 |
pcg |
1.17 |
<member name="name" type="username"/> |
361 |
|
|
</message> |
362 |
|
|
|
363 |
pcg |
1.31 |
<message type="001f" name="fetch_memos" src="client"> |
364 |
pcg |
1.18 |
<p>Unclear. Fetch all outstanding memos? Replied with <ref reply="memo"/></p> |
365 |
pcg |
1.17 |
</message> |
366 |
|
|
|
367 |
pcg |
1.31 |
<message type="0021" name="req_pic" src="client"> |
368 |
pcg |
1.18 |
<p>Request a user picture from the server. Results in a <ref reply="userpic"/> |
369 |
|
|
or a timeout.</p> |
370 |
pcg |
1.3 |
<member name="name" type="username"/> |
371 |
pcg |
1.1 |
</message> |
372 |
|
|
|
373 |
pcg |
1.31 |
<message type="0021" name="upload_pic" src="client"> |
374 |
pcg |
1.1 |
Same code as pic_req, but with an additional data section that |
375 |
pcg |
1.4 |
must contain a JPEG image that is <=7KB. It must have 141×200 pixels. |
376 |
pcg |
1.3 |
<member name="name" type="username"/> |
377 |
pcg |
1.1 |
<member name="data" type="DATA"/> |
378 |
pcg |
1.29 |
</message> |
379 |
|
|
|
380 |
pcg |
1.31 |
<message type="0023" name="send_memo" src="client"> |
381 |
pcg |
1.29 |
<member name="name" type="username"/> |
382 |
|
|
<member name="msg" type="STRING"/> |
383 |
pcg |
1.1 |
</message> |
384 |
|
|
|
385 |
pcg |
1.31 |
<message type="0100" name="gnotice" src="client"> |
386 |
pcg |
1.18 |
<p>Send a global message. Maybe. Never tried, for obvious reasons :/. Results |
387 |
|
|
in a <ref reply="gnotice"/> sent to all users.</p> |
388 |
pcg |
1.1 |
<member name="notice" type="STRING"/> |
389 |
|
|
</message> |
390 |
|
|
|
391 |
pcg |
1.33 |
<message type="0200" name="notify_add" src="client"> |
392 |
|
|
|
393 |
|
|
<p>Probably setting a notifier on a username, to get informed about |
394 |
pcg |
1.36 |
changes using <ref reply="notify_upd"/> messages. sending your own |
395 |
|
|
username gives you a disconnect, so don't do that at home, kids!</p> |
396 |
pcg |
1.33 |
|
397 |
|
|
<member name="name" type="username"/> |
398 |
|
|
</message> |
399 |
|
|
|
400 |
|
|
<message type="0201" name="notify_del" src="client"> |
401 |
|
|
|
402 |
|
|
<p>Probably remove the notifier again.</p> |
403 |
|
|
|
404 |
|
|
<member name="name" type="username"/> |
405 |
|
|
</message> |
406 |
|
|
|
407 |
pcg |
1.31 |
<message type="0318" name="list_rooms" src="client"> |
408 |
pcg |
1.18 |
<p>List the rooms in a specific group/category. Results in a <ref reply="upd_rooms"/> message.</p> |
409 |
pcg |
1.3 |
<member name="group" type="U8"/> |
410 |
pcg |
1.1 |
</message> |
411 |
|
|
|
412 |
pcg |
1.31 |
<message type="031a" name="new_room" src="client"> |
413 |
pcg |
1.1 |
Create a new room. Not verified. |
414 |
pcg |
1.3 |
<member name="name" type="username"/> |
415 |
pcg |
1.37 |
<member name="i1" type="U32" value="0"/> |
416 |
|
|
<member name="b1" type="U8" value="0"/> |
417 |
|
|
<member name="b2" type="U8" value="255"/> |
418 |
|
|
<member name="b3" type="U8" value="255"/> |
419 |
|
|
<member name="group" type="U8" value="1"/> |
420 |
pcg |
1.1 |
<member name="name" type="STRING"/> |
421 |
|
|
<member name="description" type="STRING"/> |
422 |
pcg |
1.3 |
<member name="flags" type="U8"/> |
423 |
pcg |
1.1 |
0x10 .. private room etc.. see code |
424 |
|
|
</message> |
425 |
|
|
|
426 |
pcg |
1.31 |
<message type="0413" name="req_game_record" src="client"> |
427 |
pcg |
1.18 |
<p>Requests part of the users game record to be sent. Results in a <ref reply="game_record"/> or maybe a timeout.</p> |
428 |
pcg |
1.16 |
<member name="name" type="username"/> |
429 |
|
|
<member name="timestamp" type="timestamp"/> |
430 |
|
|
If zero, start at the newest games, else only send games |
431 |
|
|
before the given timestap. |
432 |
|
|
</message> |
433 |
|
|
|
434 |
pcg |
1.31 |
<message type="4300" name="join_room" src="client"> |
435 |
pcg |
1.18 |
<p>Joins the given room. <ref reply="join_room"/> messages for yourself |
436 |
pcg |
1.9 |
and all users in that room, as well as the initial gamelist, are |
437 |
pcg |
1.18 |
send if the room exists. If not, timeout...</p> |
438 |
pcg |
1.3 |
<member name="channel" type="U16"/> |
439 |
pcg |
1.1 |
<member name="user" type="user"/> |
440 |
|
|
</message> |
441 |
|
|
|
442 |
pcg |
1.31 |
<message type="4301" name="msg_room" src="client"> |
443 |
pcg |
1.9 |
Send a message to the room. |
444 |
pcg |
1.3 |
<member name="channel" type="U16"/> |
445 |
|
|
<member name="name" type="username"/> |
446 |
pcg |
1.9 |
Must be the login-name of the user. |
447 |
pcg |
1.1 |
<member name="message" type="STRING"/> |
448 |
|
|
</message> |
449 |
|
|
|
450 |
pcg |
1.31 |
<message type="4302" name="part_room" src="client"> |
451 |
pcg |
1.9 |
Remove yourself (or maybe others as admin) from a room. |
452 |
pcg |
1.3 |
<member name="channel" type="U16"/> |
453 |
|
|
<member name="name" type="username"/> |
454 |
pcg |
1.1 |
</message> |
455 |
|
|
|
456 |
pcg |
1.31 |
<message type="4305" name="new_game" src="client"> |
457 |
pcg |
1.17 |
Unclear. Start a new game. |
458 |
pcg |
1.3 |
<member name="channel" type="U16"/> |
459 |
|
|
<member name="id" type="U16"/> |
460 |
|
|
<member name="gametype" type="U32"/> |
461 |
pcg |
1.1 |
<member name="rules" type="rules"/> |
462 |
|
|
<member name="notes" type="STRING"/> |
463 |
|
|
</message> |
464 |
|
|
|
465 |
pcg |
1.31 |
<message type="430b" name="req_games" src="client"> |
466 |
pcg |
1.9 |
Request to update room game list (send this once per minute to get |
467 |
|
|
updated). Results in upd_games messages. |
468 |
pcg |
1.3 |
<member name="channel" type="U16"/> |
469 |
pcg |
1.1 |
</message> |
470 |
|
|
|
471 |
pcg |
1.31 |
<message type="4319" name="req_desc" src="client"> |
472 |
pcg |
1.1 |
Request room description. |
473 |
pcg |
1.3 |
<member name="channel" type="U16"/> |
474 |
pcg |
1.1 |
</message> |
475 |
|
|
|
476 |
pcg |
1.31 |
<message type="4400" name="send_challenge" src="client"> |
477 |
pcg |
1.9 |
Unclear. |
478 |
pcg |
1.3 |
<member name="channel" type="U16"/> |
479 |
|
|
<member name="black" type="username"/> |
480 |
|
|
<member name="white" type="username"/> |
481 |
pcg |
1.1 |
More following... TREE or challenge. |
482 |
|
|
</message> |
483 |
|
|
|
484 |
pcg |
1.31 |
<message type="4403" name="join_game" src="client"> |
485 |
pcg |
1.9 |
Join a game. See join_room. |
486 |
pcg |
1.5 |
<member name="channel" type="U16"/> |
487 |
pcg |
1.1 |
<member name="user" type="user"/> |
488 |
|
|
</message> |
489 |
|
|
|
490 |
pcg |
1.31 |
<message type="4404" name="part_game" src="client"> |
491 |
pcg |
1.9 |
Leave (or kick as admin?) a certain user from a game. |
492 |
pcg |
1.3 |
<member name="channel" type="U16"/> |
493 |
|
|
<member name="name" type="username"/> |
494 |
pcg |
1.1 |
</message> |
495 |
|
|
|
496 |
pcg |
1.35 |
<message type="4405" name="set_tree" src="client"> |
497 |
|
|
Possibly upload an initial game to an empty room. Not tested. |
498 |
|
|
|
499 |
|
|
<member name="channel" type="U16"/> |
500 |
|
|
<member name="tree" type="TREE"/> |
501 |
|
|
</message> |
502 |
|
|
|
503 |
pcg |
1.31 |
<message type="4406" name="upd_tree" src="client"> |
504 |
pcg |
1.28 |
Upload a partial game tree to the server. This is used to send moves |
505 |
|
|
and even in-game comments to the server. For the comments, the |
506 |
|
|
server prepends the username and rank. |
507 |
|
|
|
508 |
pcg |
1.3 |
<member name="channel" type="U16"/> |
509 |
pcg |
1.1 |
<member name="tree" type="TREE"/> |
510 |
|
|
</message> |
511 |
|
|
|
512 |
pcg |
1.31 |
<message type="4408" name="get_tree" src="client"> |
513 |
pcg |
1.9 |
Request the game tree starting at a given node. This is used |
514 |
|
|
when the server only sends a partial tree (with end code "more"). |
515 |
pcg |
1.3 |
<member name="channel" type="U16"/> |
516 |
|
|
<member name="node" type="U32"/> |
517 |
pcg |
1.1 |
</message> |
518 |
|
|
|
519 |
pcg |
1.31 |
<message type="440c" name="claim_win" src="client"> |
520 |
pcg |
1.9 |
Unclear. |
521 |
pcg |
1.3 |
<member name="channel" type="U16"/> |
522 |
|
|
<member name="_byte" type="U8 "/> |
523 |
pcg |
1.1 |
Player colour maybe? Unclear. |
524 |
|
|
</message> |
525 |
|
|
|
526 |
pcg |
1.31 |
<message type="440d" name="add_time" src="client"> |
527 |
pcg |
1.9 |
Not checked. |
528 |
|
|
|
529 |
pcg |
1.3 |
<member name="channel" type="U16"/> |
530 |
|
|
<member name="time" type="U32"/> |
531 |
|
|
<member name="player" type="U8"/> |
532 |
pcg |
1.1 |
</message> |
533 |
|
|
|
534 |
pcg |
1.31 |
<message type="440f" name="grant_undo" src="client"> |
535 |
pcg |
1.9 |
Can be send after a req_undo message was received to grant the undo. |
536 |
pcg |
1.3 |
<member name="channel" type="U16"/> |
537 |
pcg |
1.1 |
</message> |
538 |
|
|
|
539 |
pcg |
1.31 |
<message type="4410" name="resign_game" src="client"> |
540 |
pcg |
1.9 |
Resign the game. |
541 |
pcg |
1.3 |
<member name="channel" type="U16"/> |
542 |
|
|
<member name="player" type="U8"/> |
543 |
pcg |
1.1 |
</message> |
544 |
|
|
|
545 |
pcg |
1.31 |
<message type="441a" name="set_teacher" src="client"> |
546 |
pcg |
1.9 |
Change the teacher to somebody else (or possibly yourself == take it). |
547 |
pcg |
1.3 |
<member name="channel" type="U16"/> |
548 |
|
|
<member name="name" type="username"/> |
549 |
pcg |
1.1 |
</message> |
550 |
|
|
|
551 |
pcg |
1.31 |
<message type="4422" name="add_user" src="client"> |
552 |
pcg |
1.9 |
Unclear. Maybe allow users to talk? No idea, really. |
553 |
|
|
|
554 |
pcg |
1.3 |
<member name="channel" type="U16"/> |
555 |
|
|
<member name="othername" type="username"/> |
556 |
|
|
<member name="name" type="username"/>; # gives user access to the game (to what? ;) |
557 |
pcg |
1.1 |
</message> |
558 |
|
|
|
559 |
pcg |
1.31 |
<message type="4423" name="set_privacy" src="client"> |
560 |
pcg |
1.9 |
Probably sets the "quiet" flag. Not checked. |
561 |
pcg |
1.3 |
<member name="channel" type="U16"/> |
562 |
|
|
<member name="private" type="U8"/> |
563 |
pcg |
1.1 |
</message> |
564 |
|
|
|
565 |
pcg |
1.31 |
<message type="4429" name="reject_challenge" src="client"> |
566 |
pcg |
1.9 |
Reject a challenge from a given user. Not checked. |
567 |
|
|
|
568 |
pcg |
1.3 |
<member name="channel" type="U16"/> |
569 |
|
|
<member name="name" type="username"/> |
570 |
pcg |
1.1 |
</message> |
571 |
|
|
|
572 |
pcg |
1.31 |
<message type="4433" name="req_result" src="client"> |
573 |
pcg |
1.9 |
I forgot. |
574 |
|
|
|
575 |
pcg |
1.3 |
<member name="channel" type="U16"/> |
576 |
pcg |
1.35 |
</message> |
577 |
|
|
|
578 |
|
|
<message type="4436" name="msg_game" src="client"> |
579 |
|
|
<member name="channel" type="U16"/> |
580 |
|
|
<member name="message" type="STRING"/> |
581 |
pcg |
1.1 |
</message> |
582 |
|
|
|
583 |
pcg |
1.37 |
<message type="ffff" name="quit" src="client"> |
584 |
|
|
<p>Sent by the client just before it logs out.</p> |
585 |
|
|
</message> |
586 |
|
|
|
587 |
pcg |
1.32 |
<h2>Structs mainly used in messages send by the server</h2> |
588 |
pcg |
1.1 |
|
589 |
pcg |
1.3 |
<struct name="challenge_defaults"> |
590 |
pcg |
1.9 |
Send soon after log-in to set the defaults for game challenges. |
591 |
pcg |
1.3 |
<member name="gametype" type="U32"/> |
592 |
|
|
<member name="size" type="U32"/> |
593 |
|
|
<member name="timesys" type="U32"/> |
594 |
|
|
<member name="time" type="U32"/> |
595 |
|
|
<member name="byo_time" type="U32"/> |
596 |
|
|
<member name="byo_periods" type="U32"/> |
597 |
|
|
<member name="can_time" type="U32"/> |
598 |
|
|
<member name="can_stones" type="U32"/> |
599 |
|
|
</struct> |
600 |
|
|
|
601 |
|
|
<struct name="challenge" class="KGS::Challenge"> |
602 |
pcg |
1.9 |
A challenge. |
603 |
|
|
|
604 |
pcg |
1.1 |
<member name="user1" type="user"/> |
605 |
|
|
<member name="user2" type="user"/> |
606 |
pcg |
1.3 |
<member name="gametype" type="U32"/> |
607 |
pcg |
1.1 |
<member name="rules" type="rules"/> |
608 |
|
|
Maybe the rules" are in TREE format. I forgot. |
609 |
pcg |
1.3 |
</struct> |
610 |
pcg |
1.1 |
|
611 |
pcg |
1.3 |
<struct name="game" class="KGS::Game"> |
612 |
pcg |
1.9 |
Basic information about a game. Used in rooms for the gamelist and |
613 |
|
|
in games to detect when a game is saved, changed type (e.g. R => D) |
614 |
|
|
etc. |
615 |
|
|
|
616 |
pcg |
1.3 |
<member name="channel" type="U16"/> |
617 |
pcg |
1.26 |
<member name="type" type="U8"/> |
618 |
pcg |
1.1 |
<member name="user1" type="user"/> |
619 |
|
|
White |
620 |
|
|
<member name="user2" type="user"/> |
621 |
|
|
Black |
622 |
|
|
<member name="user3" type="user"/> |
623 |
|
|
Owner |
624 |
pcg |
1.26 |
<member name="size" type="U8"/> |
625 |
|
|
<member name="handicap" type="I8"/> |
626 |
pcg |
1.1 |
< 0 not fully setup |
627 |
pcg |
1.26 |
<member name="komi" type="komi16"/> |
628 |
pcg |
1.15 |
<member name="moves" type="I16"/> |
629 |
pcg |
1.14 |
This field reflects either the movenum or the score, sorry, not even guards help, as |
630 |
pcg |
1.15 |
the flags to determine that are _after_ the field. Arg. Divide by two to get the actual |
631 |
pcg |
1.27 |
score (NOT score16!) (arg²). |
632 |
pcg |
1.3 |
<member name="flags" type="U16"/> |
633 |
|
|
<member name="observers" type="U32"/> |
634 |
|
|
<member name="saved" type="flag"/> |
635 |
|
|
<member name="notes" type="STRING" guard-member="handicap" guard-cond="< 0"/> |
636 |
|
|
</struct> |
637 |
|
|
|
638 |
|
|
<struct name="room_obs"> |
639 |
pcg |
1.9 |
Obsolete. |
640 |
|
|
|
641 |
pcg |
1.3 |
<member name="name" type="roomname"/> |
642 |
|
|
<member name="channel" type="U16"/> |
643 |
|
|
<member name="flags" type="U32"/> |
644 |
pcg |
1.4 |
<member name="users" type="U32"/> |
645 |
pcg |
1.3 |
</struct> |
646 |
|
|
|
647 |
|
|
<struct name="room" class="KGS::Room"> |
648 |
|
|
<member name="channel" type="U16"/> |
649 |
|
|
<member name="flags" type="U8"/> |
650 |
|
|
<member name="group" type="U8"/> |
651 |
|
|
<member name="users" type="U16"/> |
652 |
|
|
<member name="games" type="U16"/> |
653 |
pcg |
1.4 |
<member name="name" type="STRING"/> |
654 |
pcg |
1.3 |
</struct> |
655 |
pcg |
1.1 |
|
656 |
pcg |
1.12 |
<struct name="scorevalues" class="KGS::Score"> |
657 |
pcg |
1.13 |
<member name="score" type="score32"/> |
658 |
pcg |
1.3 |
<member name="territory" type="U32"/> |
659 |
|
|
<member name="captures" type="U32"/> |
660 |
|
|
<member name="i3" type="U32"/> |
661 |
|
|
<member name="f2" type="U32"/> |
662 |
pcg |
1.20 |
<member name="komi" type="komi324"/> |
663 |
pcg |
1.4 |
<member name="i4" type="U32"/> |
664 |
pcg |
1.3 |
Apparently the i3, f2, i4 are zero. |
665 |
|
|
</struct> |
666 |
pcg |
1.1 |
|
667 |
pcg |
1.16 |
<struct name="game_record" class="KGS::GameRecord"> |
668 |
pcg |
1.18 |
<p>A single game record entry, as seen in <ref ref="userinfo"/>.</p> |
669 |
pcg |
1.16 |
|
670 |
|
|
<member name="timestamp" type="timestamp"/> |
671 |
|
|
Time this game was played. |
672 |
pcg |
1.34 |
<member name="type" type="U8"/> |
673 |
pcg |
1.16 |
High four bits are handicap, low four bits are gametype (encoded strangely? unclear). |
674 |
|
|
<member name="user1" type="user"/> |
675 |
|
|
White, flags contain low 8 bits of revision (bits 16-23). |
676 |
|
|
<member name="user2" type="user"/> |
677 |
|
|
Black, flags contain high 8 bits of revision (bits 16-23). |
678 |
|
|
<member name="user3" type="user"/> |
679 |
pcg |
1.34 |
|
680 |
|
|
<p><p>Owner (or empty)</p> |
681 |
|
|
|
682 |
|
|
<p>The bits 16-24 of user1.flags and user2.flags give the high and |
683 |
|
|
low bits of a revision number in case there are multiple similar |
684 |
|
|
games.</p></p> |
685 |
|
|
|
686 |
pcg |
1.16 |
<member name="komi" type="komi16"/> |
687 |
|
|
<member name="score" type="score16"/> |
688 |
|
|
<member name="status" type="U8"/> |
689 |
pcg |
1.34 |
|
690 |
|
|
<p>0x80 game in progress</p> |
691 |
|
|
|
692 |
pcg |
1.16 |
</struct> |
693 |
|
|
|
694 |
pcg |
1.32 |
<h2>Server-generated messages</h2> |
695 |
pcg |
1.1 |
|
696 |
pcg |
1.31 |
<message type="0001" name="login" src="server"> |
697 |
pcg |
1.37 |
<member name="result" type="CONSTANT" value='"login ok"'/> |
698 |
|
|
<member name="success" type="CONSTANT" value="1"/> |
699 |
pcg |
1.1 |
</message> |
700 |
|
|
|
701 |
pcg |
1.31 |
<message type="0002" name="login" src="server"> |
702 |
pcg |
1.37 |
<member name="result" type="CONSTANT" value='"guest login ok"'/> |
703 |
|
|
<member name="success" type="CONSTANT" value="1"/> |
704 |
pcg |
1.1 |
</message> |
705 |
|
|
|
706 |
pcg |
1.31 |
<message type="0003" name="login" src="server"> |
707 |
pcg |
1.37 |
<member name="result" type="CONSTANT" value='"login error 3"'/> |
708 |
pcg |
1.1 |
** maybe more following? ** |
709 |
|
|
</message> |
710 |
|
|
|
711 |
pcg |
1.31 |
<message type="0004" name="login" src="server"> |
712 |
pcg |
1.37 |
<member name="result" type="CONSTANT" value='"wrong password"'/> |
713 |
pcg |
1.1 |
** maybe more following? ** |
714 |
|
|
</message> |
715 |
|
|
|
716 |
pcg |
1.31 |
<message type="0005" name="login" src="server"> |
717 |
pcg |
1.37 |
<member name="result" type="CONSTANT" value='"user unknown"'/> |
718 |
pcg |
1.1 |
** maybe more following? ** |
719 |
|
|
</message> |
720 |
|
|
|
721 |
pcg |
1.31 |
<message type="0006" name="login" src="server"> |
722 |
pcg |
1.37 |
<member name="result" type="CONSTANT" value='"user exists"'/> |
723 |
pcg |
1.1 |
** maybe more following? ** |
724 |
|
|
</message> |
725 |
|
|
|
726 |
pcg |
1.31 |
<message type="0008" name="userinfo" src="server"> |
727 |
pcg |
1.17 |
User info. |
728 |
pcg |
1.33 |
<member name="_unused0" type="flag"/> |
729 |
pcg |
1.16 |
<member name="user" type="user"/> |
730 |
pcg |
1.33 |
<member name="_unused1" type="U64"/> |
731 |
pcg |
1.16 |
<member name="realname" type="realname"/> |
732 |
|
|
<member name="email" type="email"/> |
733 |
|
|
<member name="info" type="userinfo"/> |
734 |
|
|
<member name="homepage" type="url"/> |
735 |
|
|
<member name="regdate" type="timestamp"/> |
736 |
|
|
When the user registered (0 == never registered). |
737 |
|
|
<member name="lastlogin" type="timestamp"/> |
738 |
|
|
When the user logged in for the last time. |
739 |
|
|
<!-- maybe more? --> |
740 |
|
|
</message> |
741 |
|
|
|
742 |
pcg |
1.31 |
<message type="0013" name="msg_chat" src="server"> |
743 |
pcg |
1.34 |
<member name="name" type="username"/> |
744 |
pcg |
1.36 |
Name of sender (either yourself (echo) or other) |
745 |
pcg |
1.34 |
<member name="name2" type="username"/> |
746 |
pcg |
1.36 |
Name of recipient. |
747 |
pcg |
1.1 |
<member name="message" type="STRING"/> |
748 |
|
|
</message> |
749 |
|
|
|
750 |
pcg |
1.31 |
<message type="0015" name="stats" src="server"> |
751 |
pcg |
1.3 |
<member name="ver_major" type="U16"/> |
752 |
|
|
<member name="ver_minor" type="U16"/> |
753 |
|
|
<member name="ver_micro" type="U16"/> |
754 |
pcg |
1.16 |
<member name="boot_time" type="timestamp"/> |
755 |
pcg |
1.3 |
<member name="users_cur" type="U32"/> |
756 |
|
|
<member name="users_max" type="U32"/> |
757 |
|
|
<member name="users_lim" type="U32"/> |
758 |
|
|
<member name="accts_cur" type="U32"/> |
759 |
|
|
<member name="accts_max" type="U32"/> |
760 |
|
|
<member name="unknown1" type="U32"/> |
761 |
|
|
<member name="work_max" type="U32"/> |
762 |
|
|
<member name="rooms_cur" type="U32"/> |
763 |
|
|
<member name="rooms_max" type="U32"/> |
764 |
|
|
<member name="rooms_lim" type="U32"/> |
765 |
|
|
<member name="games_cur" type="U32"/> |
766 |
|
|
<member name="games_max" type="U32"/> |
767 |
|
|
<member name="games_lim" type="U32"/> |
768 |
|
|
<member name="results_cur" type="U32"/> |
769 |
|
|
<member name="results_max" type="U32"/> |
770 |
|
|
<member name="unknown2" type="U32"/> |
771 |
|
|
<member name="params_cur" type="U32"/> |
772 |
|
|
<member name="params_max" type="U32"/> |
773 |
|
|
<member name="bytes_in" type="U64"/> |
774 |
|
|
<member name="packets_in" type="U64"/> |
775 |
|
|
<member name="bytes_out" type="U64"/> |
776 |
pcg |
1.4 |
<member name="packets_out" type="U64"/> |
777 |
pcg |
1.1 |
</message> |
778 |
|
|
|
779 |
pcg |
1.31 |
<message type="0016" name="idle_warn" src="server"> |
780 |
pcg |
1.1 |
idle warning, autologout soon (10 minutes...) |
781 |
|
|
</message> |
782 |
|
|
|
783 |
pcg |
1.34 |
<message type="0018" name="login" src="server"> |
784 |
pcg |
1.37 |
<member name="result" type="CONSTANT" value='"login error 18"'/> |
785 |
pcg |
1.34 |
** maybe more following? ** |
786 |
|
|
</message> |
787 |
|
|
|
788 |
|
|
<message type="0022" name="login" src="server"> |
789 |
|
|
I was blocked sooo many times for developing this client that it was |
790 |
|
|
easy to figure out. The KGS admins sure need no extra nazi training |
791 |
|
|
:( |
792 |
|
|
<member name="reason" type="STRING"/> |
793 |
pcg |
1.37 |
<member name="result" type="CONSTANT" value='"user or ip blocked"'/> |
794 |
pcg |
1.34 |
</message> |
795 |
|
|
|
796 |
pcg |
1.31 |
<message type="001b" name="timewarning_default" src="server"> |
797 |
pcg |
1.1 |
WILD guess |
798 |
pcg |
1.3 |
<member name="channel" type="U16"/> |
799 |
|
|
<member name="time" type="U16"/> |
800 |
pcg |
1.1 |
</message> |
801 |
|
|
|
802 |
pcg |
1.31 |
<message type="001c" name="idle_err" src="server"> |
803 |
pcg |
1.1 |
autologout |
804 |
|
|
</message> |
805 |
|
|
|
806 |
pcg |
1.31 |
<message type="001d" name="ping" src="server"> |
807 |
pcg |
1.16 |
Sent by the server regularly, but not answering them |
808 |
|
|
isn't valid. Strange form of keepalive? |
809 |
pcg |
1.1 |
</message> |
810 |
|
|
|
811 |
pcg |
1.31 |
<message type="001e" name="usergraph" src="server"> |
812 |
pcg |
1.17 |
User graph data. |
813 |
pcg |
1.33 |
<member name="name" type="username"/> |
814 |
pcg |
1.17 |
<member name="data" type="I16" array="yes"/> |
815 |
|
|
If empty, no graph is available. The unit seems to |
816 |
|
|
be centi-kyu, with 1 dan == 0, 2 dan == 100, 1 kyu == -100. |
817 |
|
|
There is probably one entry per day, the newest one last. |
818 |
|
|
</message> |
819 |
|
|
|
820 |
pcg |
1.31 |
<message type="001f" name="memo" src="server"> |
821 |
pcg |
1.17 |
Unclear. "Leave Message"? |
822 |
|
|
6 strings following. |
823 |
|
|
<member name="s1" type="STRING"/> |
824 |
|
|
<member name="s2" type="STRING"/> |
825 |
|
|
<member name="s3" type="STRING"/> |
826 |
|
|
<member name="s4" type="STRING"/> |
827 |
|
|
<member name="s5" type="STRING"/> |
828 |
|
|
<member name="s6" type="STRING"/> |
829 |
|
|
</message> |
830 |
|
|
|
831 |
pcg |
1.31 |
<message type="0021" name="userpic" src="server"> |
832 |
pcg |
1.3 |
<member name="name" type="username"/> |
833 |
pcg |
1.1 |
Reply to pic_req, contains an image in jpeg format. |
834 |
|
|
<member name="data" type="DATA"/> |
835 |
|
|
</message> |
836 |
|
|
|
837 |
pcg |
1.31 |
<message type="0100" name="gnotice" src="server"> |
838 |
pcg |
1.1 |
global notice, sent to everybody |
839 |
|
|
<member name="notice" type="STRING"/> |
840 |
|
|
</message> |
841 |
|
|
|
842 |
pcg |
1.33 |
<message type="0202" name="notify_event" src="server"> |
843 |
pcg |
1.17 |
# maybe soe notify? Totally unclear. |
844 |
pcg |
1.37 |
# loc 0" type="userinfo, flags etc. loc 1 => gameinfo?, loc 2 => game result (more data) |
845 |
pcg |
1.33 |
<member name="event" type="U32"/> |
846 |
pcg |
1.16 |
<member name="user" type="user"/> |
847 |
pcg |
1.34 |
<member name="gamerecord" type="game_record" guard-member="event" guard-cond="== 2"/> |
848 |
pcg |
1.33 |
<p>Game result record?</p> |
849 |
|
|
|
850 |
pcg |
1.16 |
</message> |
851 |
pcg |
1.1 |
|
852 |
pcg |
1.31 |
<message type="0310" name="priv_room" src="server"> |
853 |
pcg |
1.1 |
"permission denied" when joining a room |
854 |
|
|
<member name="name" type="STRING"/> |
855 |
|
|
</message> |
856 |
|
|
|
857 |
pcg |
1.31 |
<message type="0318" name="upd_rooms" src="server"> |
858 |
pcg |
1.1 |
<member name="rooms" type="room" array="yes"/> |
859 |
|
|
</message> |
860 |
|
|
|
861 |
pcg |
1.31 |
<message type="0411" name="chal_defaults" src="server"> |
862 |
pcg |
1.16 |
<member name="channel" type="U16"/> |
863 |
|
|
<member name="defaults" type="challenge_defaults"/> |
864 |
|
|
</message> |
865 |
|
|
|
866 |
pcg |
1.31 |
<message type="0412" name="rej_game" src="server"> |
867 |
pcg |
1.17 |
Unable to create challenge. The channel might be optional. |
868 |
|
|
<member name="channel" type="U16"/> |
869 |
|
|
</message> |
870 |
|
|
|
871 |
pcg |
1.31 |
<message type="0414" name="game_record" src="server"> |
872 |
pcg |
1.16 |
The users game record. |
873 |
|
|
<member name="name" type="username"/> |
874 |
|
|
<member name="more" type="flag"/> |
875 |
|
|
Wether more games are available (must be requested manually) |
876 |
|
|
<member name="games" type="game_record" array="yes"/> |
877 |
|
|
</message> |
878 |
|
|
|
879 |
pcg |
1.31 |
<message type="041c" name="upd_game2" src="server"> |
880 |
pcg |
1.17 |
Unclear. |
881 |
pcg |
1.3 |
<member name="channel_junk" type="U16"/> |
882 |
pcg |
1.1 |
<member name="game" type="game"/> |
883 |
|
|
</message> |
884 |
|
|
|
885 |
|
|
<h3>Room messages</h3> |
886 |
|
|
|
887 |
|
|
<p>Not all room messages are for rooms only, and rooms need to parse |
888 |
|
|
not only these messages. Orthogonality, what for?</p> |
889 |
|
|
|
890 |
pcg |
1.31 |
<message type="4300" name="join_room" src="server"> |
891 |
pcg |
1.3 |
<member name="channel" type="U16"/> |
892 |
pcg |
1.1 |
<member name="users" type="user" array="yes"/> |
893 |
|
|
</message> |
894 |
|
|
|
895 |
pcg |
1.31 |
<message type="4301" name="msg_room" src="server"> |
896 |
pcg |
1.3 |
<member name="channel" type="U16"/> |
897 |
|
|
<member name="name" type="username"/> |
898 |
pcg |
1.1 |
<member name="message" type="STRING"/> |
899 |
|
|
</message> |
900 |
|
|
|
901 |
pcg |
1.31 |
<message type="4302" name="part_room" src="server"> |
902 |
pcg |
1.3 |
<member name="channel" type="U16"/> |
903 |
pcg |
1.1 |
<member name="user" type="user"/> |
904 |
|
|
</message> |
905 |
|
|
|
906 |
pcg |
1.31 |
<message type="4303" name="del_room" src="server"> |
907 |
pcg |
1.3 |
<member name="channel" type="U16"/> |
908 |
pcg |
1.1 |
</message> |
909 |
|
|
|
910 |
pcg |
1.31 |
<message type="4304" name="upd_games" src="server"> |
911 |
pcg |
1.3 |
<member name="channel" type="U16"/> |
912 |
pcg |
1.1 |
<member name="games" type="game" array="yes"/> |
913 |
|
|
</message> |
914 |
|
|
|
915 |
pcg |
1.31 |
<message type="4319" name="desc_room" src="server"> |
916 |
pcg |
1.3 |
<member name="channel" type="U16"/> |
917 |
|
|
<member name="owner" type="username"/> |
918 |
pcg |
1.1 |
<member name="description" type="STRING"/> |
919 |
|
|
</message> |
920 |
pcg |
1.28 |
|
921 |
pcg |
1.1 |
<h3>Game messages</h3> |
922 |
|
|
|
923 |
pcg |
1.31 |
<message type="4400" name="upd_challenge" src="server"> |
924 |
pcg |
1.1 |
Unclear. |
925 |
pcg |
1.3 |
<member name="channel" type="U16"/> |
926 |
pcg |
1.1 |
<member name="challenge" type="challenge"/> |
927 |
|
|
</message> |
928 |
|
|
|
929 |
pcg |
1.31 |
<message type="4401" name="upd_game" src="server"> |
930 |
pcg |
1.3 |
<member name="channel" type="U16"/> |
931 |
pcg |
1.1 |
<member name="game" type="game"/> |
932 |
|
|
</message> |
933 |
|
|
|
934 |
pcg |
1.31 |
<message type="4402" name="del_game" src="server"> |
935 |
pcg |
1.3 |
<member name="channel" type="U16"/> |
936 |
pcg |
1.1 |
</message> |
937 |
|
|
|
938 |
pcg |
1.31 |
<message type="4403" name="upd_observers" src="server"> |
939 |
pcg |
1.3 |
<member name="channel" type="U16"/> |
940 |
pcg |
1.1 |
<member name="users" type="user" array="yes"/> |
941 |
|
|
</message> |
942 |
|
|
|
943 |
pcg |
1.31 |
<message type="4404" name="del_observer" src="server"> |
944 |
pcg |
1.3 |
<member name="channel" type="U16"/> |
945 |
|
|
<member name="name" type="username"/> |
946 |
pcg |
1.1 |
</message> |
947 |
|
|
|
948 |
pcg |
1.31 |
<message type="4405" name="set_tree" src="server"> |
949 |
pcg |
1.3 |
<member name="channel" type="U16"/> |
950 |
pcg |
1.1 |
<member name="tree" type="TREE"/> |
951 |
|
|
</message> |
952 |
|
|
|
953 |
pcg |
1.31 |
<message type="4406" name="upd_tree" src="server"> |
954 |
pcg |
1.3 |
<member name="channel" type="U16"/> |
955 |
pcg |
1.1 |
<member name="tree" type="TREE"/> |
956 |
|
|
</message> |
957 |
|
|
|
958 |
pcg |
1.31 |
<message type="4409" name="superko" src="server"> |
959 |
pcg |
1.1 |
Superko-warning. |
960 |
pcg |
1.3 |
<member name="channel" type="U16"/> |
961 |
pcg |
1.1 |
</message> |
962 |
|
|
|
963 |
pcg |
1.31 |
<message type="440b" name="final_result" src="server"> |
964 |
pcg |
1.3 |
<member name="channel" type="U16"/> |
965 |
pcg |
1.12 |
<member name="blackscore" type="scorevalues"/> |
966 |
|
|
<member name="whitescore" type="scorevalues"/> |
967 |
pcg |
1.1 |
</message> |
968 |
|
|
|
969 |
pcg |
1.31 |
<message type="440e" name="req_undo" src="server"> |
970 |
pcg |
1.3 |
<member name="channel" type="U16"/> |
971 |
pcg |
1.1 |
|
972 |
|
|
</message> |
973 |
|
|
|
974 |
pcg |
1.31 |
<message type="4410" name="resign_game" src="server"> |
975 |
pcg |
1.3 |
<member name="channel" type="U16"/> |
976 |
|
|
<member name="player" type="U8"/> |
977 |
pcg |
1.1 |
</message> |
978 |
|
|
|
979 |
pcg |
1.31 |
<message type="441a" name="set_teacher" src="server"> |
980 |
pcg |
1.3 |
<member name="channel" type="U16"/> |
981 |
|
|
<member name="name" type="username"/> |
982 |
pcg |
1.1 |
</message> |
983 |
|
|
|
984 |
pcg |
1.31 |
<message type="441d" name="owner_left" src="server"> |
985 |
pcg |
1.1 |
Unclear. |
986 |
pcg |
1.3 |
<member name="channel" type="U16"/> |
987 |
pcg |
1.1 |
</message> |
988 |
|
|
|
989 |
pcg |
1.31 |
<message type="441e" name="teacher_left" src="server"> |
990 |
pcg |
1.1 |
Unclear. |
991 |
pcg |
1.3 |
<member name="channel" type="U16"/> |
992 |
pcg |
1.1 |
</message> |
993 |
|
|
|
994 |
pcg |
1.31 |
<message type="4422" name="unknown4422" src="server"> |
995 |
pcg |
1.1 |
change teacher? something to do with editing? |
996 |
pcg |
1.3 |
<member name="channel" type="U16"/> |
997 |
|
|
<member name="name1" type="username"/> |
998 |
|
|
<member name="name2" type="username"/> |
999 |
pcg |
1.27 |
</message> |
1000 |
|
|
|
1001 |
pcg |
1.31 |
<message type="4428" name="add_tree" src="server"> |
1002 |
pcg |
1.27 |
<p>See <ref ref="set_tree"/>. In addition, flags the tree as being |
1003 |
|
|
uploaded completely.</p> |
1004 |
|
|
<member name="channel" type="U16"/> |
1005 |
|
|
<member name="tree" type="TREE"/> |
1006 |
pcg |
1.1 |
</message> |
1007 |
|
|
|
1008 |
pcg |
1.31 |
<message type="4433" name="req_result" src="server"> |
1009 |
pcg |
1.1 |
Unclear. |
1010 |
pcg |
1.3 |
<member name="channel" type="U16"/> |
1011 |
pcg |
1.1 |
# # recv_result(?) |
1012 |
|
|
</message> |
1013 |
|
|
|
1014 |
pcg |
1.31 |
<message type="4434" name="unknown4434" src="server"> |
1015 |
pcg |
1.3 |
<member name="channel" type="U16"/> |
1016 |
|
|
<member name="b1" type="U8"/> |
1017 |
pcg |
1.1 |
?? !demonstration game?? |
1018 |
|
|
</message> |
1019 |
|
|
|
1020 |
|
|
</body> |
1021 |
|
|
</html> |
1022 |
|
|
|