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