1 |
<?xml version="1.0" encoding="utf-8"?> |
2 |
<html> |
3 |
<head> |
4 |
<title>KGS Protocol Description</title> |
5 |
<meta http-equiv="Content-Type" content="text/html; charset=utf-8"/> |
6 |
<!-- |
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 |
<h1>$Revision: 1.38 $</h1> |
27 |
|
28 |
<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 |
almost trivial.</p> |
34 |
|
35 |
<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 |
|
45 |
<p>If you feel you need to update the visual appearance of this |
46 |
document, feel free to look <tt>doc/doc2html.xsl</tt> and improve |
47 |
it.</p> |
48 |
|
49 |
<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 |
(update: sourceforge is weeks behind on their anonymous cvs servers so the above might be out-of-date. sorry.)</p> |
54 |
|
55 |
<h2>Structure and conventions of this document and the protocol</h2> |
56 |
|
57 |
<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 |
|
61 |
<p>Everything on the wire is in little-endian format (what a shame).</p> |
62 |
|
63 |
<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 |
|
69 |
<p>For the rest, go figure or bug me, <a href="mailto:pcg@goof.com">Marc Lehmann <pcg@goof.com></a></p> |
70 |
|
71 |
<h2>Stream and message structure.</h2> |
72 |
|
73 |
<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 |
|
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 |
<struct name="message_header"> |
92 |
<member name="_unknown" type="U16"/> |
93 |
<member name="length" type="U16"/> |
94 |
|
95 |
<p>The length is the length of the full message including the header.</p> |
96 |
|
97 |
<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 |
|
103 |
<member name="type" type="U16"/> |
104 |
<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 |
|
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 |
</struct> |
120 |
|
121 |
<h2>Primitive types used in the protocol.</h2> |
122 |
|
123 |
<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 |
|
128 |
<type name="username" type="A" length="10"/> |
129 |
|
130 |
<p>The basic user or login name, used throughout the protocol |
131 |
as a handle to the user.</p> |
132 |
|
133 |
<type name="roomname" type="S" length="25"/><!-- argh, how horribly broken --> |
134 |
|
135 |
<p>Many strings in the protocol are fixed-width for no good reason |
136 |
(maybe this is one reason for using compression in newer versions, as |
137 |
the packets itself are wasting lots of space.</p> |
138 |
|
139 |
<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 |
<type name="locale" type="A" length="5"/> |
147 |
|
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 |
<type name="flag" type="U8" multiplier="1"/> |
153 |
|
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 |
<type name="komi16" type="I16" multiplier="2"/> |
158 |
<type name="komi32" type="I32" multiplier="2"/> |
159 |
<type name="komi324" type="I32" multiplier="4"/> |
160 |
|
161 |
<p>Komi values are multiplied by 2 to make them integer in the |
162 |
protocol. Well, *most* of the time at least...</p> |
163 |
|
164 |
<type name="result" type="I32" multiplier="2"/> |
165 |
|
166 |
<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 |
|
170 |
<type name="score16" type="I16" multiplier="4"/> |
171 |
<type name="score32" type="I32" multiplier="4"/> |
172 |
<type name="score1000" type="I32" multiplier="1000"/> |
173 |
|
174 |
<p>A score value (used for displaying the score at the end of a game) |
175 |
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 |
watch out! And in some others, it's encoded by multiplying by 1000... |
178 |
yuck!</p> |
179 |
|
180 |
<type name="time" type="U32" multiplier="1000"/> |
181 |
|
182 |
<p>Time values are multiplied by 1000, giving them millisecond |
183 |
accuracy.</p> |
184 |
|
185 |
<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 |
<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 |
<h2>Enumeration and set types used in the protocol.</h2> |
197 |
|
198 |
<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 |
|
260 |
<h2>Structs used in send & receive messages</h2> |
261 |
|
262 |
<struct name="user" class="KGS::User"> |
263 |
|
264 |
<p>Everywhere a user + flags is required, even used in some places |
265 |
where only a username is required. I see no general rule on when a |
266 |
complete user and when a partial user is required.</p> |
267 |
|
268 |
<member name="name" type="username"/> |
269 |
<member name="flags" type="U32" value="1"/> |
270 |
</struct> |
271 |
|
272 |
<struct name="rules" class="KGS::Rules"> |
273 |
|
274 |
<p>This structure is used for challanges as well as in the special |
275 |
TREE "subprotocol". It tightly encodes the game parameters.</p> |
276 |
|
277 |
<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 |
<h2>Structs used in messages from the client</h2> |
290 |
|
291 |
<h2>Client-generated messages</h2> |
292 |
|
293 |
<message type="0000" name="login" src="client"> |
294 |
|
295 |
<p>Sent to login, usually the first message sent. The password needs to be set when the |
296 |
guest flag is true. |
297 |
Possible replies: <ref reply="login"/>. Followed by: <ref reply="timewarning_default"/> <ref reply="chal_defaults"/> |
298 |
</p> |
299 |
|
300 |
<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 |
The "default" is the java vm version, not exactly he client version. However, |
310 |
you should always send a text like "Jonathan's C client bersion 0.6" or somesuch, |
311 |
so the server can, if necessary, block broken clients or client versions. |
312 |
</message> |
313 |
|
314 |
<message type="0007" name="req_userinfo" src="client"> |
315 |
<p>Request info about a certain user. Possible reply: <ref reply="userinfo"/></p> |
316 |
<member name="name" type="username"/> |
317 |
</message> |
318 |
|
319 |
<message type="0007" name="req_userinfo" src="client"> |
320 |
<p>Request userinfo(?). unverified...</p> |
321 |
<member name="name" type="username"/> |
322 |
</message> |
323 |
|
324 |
<message type="0007" name="update_userinfo" src="client"> |
325 |
<p>Update user info. Message structure is very similar |
326 |
to <ref ref="userinfo"/>.</p> |
327 |
<member name="setpass" type="flag"/> |
328 |
Should the password be updated? |
329 |
<member name="password" type="password" value="0"/> |
330 |
<member name="realname" type="realname"/> |
331 |
<member name="email" type="email"/> |
332 |
<member name="info" type="userinfo"/> |
333 |
<member name="homepage" type="url"/> |
334 |
<member name="_unused" type="U64" value="0"/> |
335 |
<member name="_unused" type="U64" value="0"/> |
336 |
</message> |
337 |
|
338 |
<message type="0013" name="msg_chat" src="client"> |
339 |
<p>This message is sent to initiate or continue a private chat with |
340 |
a user. You'll always receive a copy of what you have sent back |
341 |
from the server (as usual).</p> |
342 |
|
343 |
<member name="name" type="username"/> |
344 |
Name of sender ("yourself"). |
345 |
<member name="name2" type="username"/> |
346 |
Name of recipient. |
347 |
<member name="message" type="STRING"/> |
348 |
The message. |
349 |
</message> |
350 |
|
351 |
<message type="0014" name="req_stats" src="client"> |
352 |
<p>Request server statistics. Replied with <ref reply="stats"/></p> |
353 |
</message> |
354 |
|
355 |
<message type="0016" name="idle_reset" src="client"> |
356 |
<p>Send in response to <ref reply="idle_warn"/> to keep the server from disconnecting.</p> |
357 |
</message> |
358 |
|
359 |
<message type="001d" name="ping" src="client"> |
360 |
<p>Wild guess, I send it in <ref ref="idle_warn"/>.</p> |
361 |
</message> |
362 |
|
363 |
<message type="001e" name="req_usergraph" src="client"> |
364 |
<p>Request user graph data, replied with <ref reply="usergraph"/>.</p> |
365 |
<member name="name" type="username"/> |
366 |
</message> |
367 |
|
368 |
<message type="001f" name="fetch_memos" src="client"> |
369 |
<p>Unclear. Fetch all outstanding memos? Replied with <ref reply="memo"/></p> |
370 |
</message> |
371 |
|
372 |
<message type="0021" name="req_pic" src="client"> |
373 |
<p>Request a user picture from the server. Results in a <ref reply="userpic"/> |
374 |
or a timeout.</p> |
375 |
<member name="name" type="username"/> |
376 |
</message> |
377 |
|
378 |
<message type="0021" name="upload_pic" src="client"> |
379 |
Same code as pic_req, but with an additional data section that |
380 |
must contain a JPEG image that is <=7KB. It must have 141×200 pixels. |
381 |
<member name="name" type="username"/> |
382 |
<member name="data" type="DATA"/> |
383 |
</message> |
384 |
|
385 |
<message type="0023" name="send_memo" src="client"> |
386 |
<member name="name" type="username"/> |
387 |
<member name="msg" type="STRING"/> |
388 |
</message> |
389 |
|
390 |
<message type="0100" name="gnotice" src="client"> |
391 |
<p>Send a global message. Maybe. Never tried, for obvious reasons :/. Results |
392 |
in a <ref reply="gnotice"/> sent to all users.</p> |
393 |
<member name="notice" type="STRING"/> |
394 |
</message> |
395 |
|
396 |
<message type="0200" name="notify_add" src="client"> |
397 |
|
398 |
<p>Probably setting a notifier on a username, to get informed about |
399 |
changes using <ref reply="notify_upd"/> messages. sending your own |
400 |
username gives you a disconnect, so don't do that at home, kids!</p> |
401 |
|
402 |
<member name="name" type="username"/> |
403 |
</message> |
404 |
|
405 |
<message type="0201" name="notify_del" src="client"> |
406 |
|
407 |
<p>Probably remove the notifier again.</p> |
408 |
|
409 |
<member name="name" type="username"/> |
410 |
</message> |
411 |
|
412 |
<message type="0318" name="list_rooms" src="client"> |
413 |
<p>List the rooms in a specific group/category. Results in a <ref reply="upd_rooms"/> message.</p> |
414 |
<member name="group" type="U8"/> |
415 |
</message> |
416 |
|
417 |
<message type="031a" name="new_room" src="client"> |
418 |
Create a new room. Not verified. |
419 |
<member name="name" type="username"/> |
420 |
<member name="i1" type="U32" value="0"/> |
421 |
<member name="b1" type="U8" value="0"/> |
422 |
<member name="b2" type="U8" value="255"/> |
423 |
<member name="b3" type="U8" value="255"/> |
424 |
<member name="group" type="U8" value="1"/> |
425 |
<member name="name" type="STRING"/> |
426 |
<member name="description" type="STRING"/> |
427 |
<member name="flags" type="U8"/> |
428 |
0x10 .. private room etc.. see code |
429 |
</message> |
430 |
|
431 |
<message type="0413" name="req_game_record" src="client"> |
432 |
<p>Requests part of the users game record to be sent. Results in a <ref reply="game_record"/> or maybe a timeout.</p> |
433 |
<member name="name" type="username"/> |
434 |
<member name="timestamp" type="timestamp"/> |
435 |
If zero, start at the newest games, else only send games |
436 |
before the given timestap. |
437 |
</message> |
438 |
|
439 |
<message type="4300" name="join_room" src="client"> |
440 |
<p>Joins the given room. <ref reply="join_room"/> messages for yourself |
441 |
and all users in that room, as well as the initial gamelist, are |
442 |
send if the room exists. If not, timeout...</p> |
443 |
<member name="channel" type="U16"/> |
444 |
<member name="user" type="user"/> |
445 |
</message> |
446 |
|
447 |
<message type="4301" name="msg_room" src="client"> |
448 |
Send a message to the room. |
449 |
<member name="channel" type="U16"/> |
450 |
<member name="name" type="username"/> |
451 |
Must be the login-name of the user. |
452 |
<member name="message" type="STRING"/> |
453 |
</message> |
454 |
|
455 |
<message type="4302" name="part_room" src="client"> |
456 |
Remove yourself (or maybe others as admin) from a room. |
457 |
<member name="channel" type="U16"/> |
458 |
<member name="name" type="username"/> |
459 |
</message> |
460 |
|
461 |
<message type="4305" name="new_game" src="client"> |
462 |
Unclear. Start a new game. |
463 |
<member name="channel" type="U16"/> |
464 |
<member name="id" type="U16"/> |
465 |
<member name="gametype" type="U32"/> |
466 |
<member name="rules" type="rules"/> |
467 |
<member name="notes" type="STRING"/> |
468 |
</message> |
469 |
|
470 |
<message type="430a" name="load_game" src="client"> |
471 |
Load an existing game into a room(?) |
472 |
There is no indication that a new game is there except |
473 |
for a upd_observers message with your name in it. Which means |
474 |
you have to watch upd_observers messages that are not for any |
475 |
currently open game and open one. Ugh. |
476 |
<member name="channel" type="U16"/> |
477 |
The room to load the game into. |
478 |
<member name="timestamp" type="timestamp"/> |
479 |
From the game record. |
480 |
<member name="user" type="username"/> |
481 |
<member name="flags" type="U8"/> |
482 |
0 == public, 2 == private |
483 |
</message> |
484 |
|
485 |
<message type="430b" name="req_games" src="client"> |
486 |
Request to update room game list (send this once per minute to get |
487 |
updated). Results in upd_games messages. |
488 |
<member name="channel" type="U16"/> |
489 |
</message> |
490 |
|
491 |
<message type="4319" name="req_desc" src="client"> |
492 |
Request room description. |
493 |
<member name="channel" type="U16"/> |
494 |
</message> |
495 |
|
496 |
<message type="4400" name="send_challenge" src="client"> |
497 |
Unclear. |
498 |
<member name="channel" type="U16"/> |
499 |
<member name="black" type="username"/> |
500 |
<member name="white" type="username"/> |
501 |
More following... TREE or challenge. |
502 |
</message> |
503 |
|
504 |
<message type="4403" name="join_game" src="client"> |
505 |
Join a game. See join_room. |
506 |
<member name="channel" type="U16"/> |
507 |
<member name="user" type="user"/> |
508 |
</message> |
509 |
|
510 |
<message type="4404" name="part_game" src="client"> |
511 |
Leave (or kick as admin?) a certain user from a game. |
512 |
<member name="channel" type="U16"/> |
513 |
<member name="name" type="username"/> |
514 |
</message> |
515 |
|
516 |
<message type="4405" name="set_tree" src="client"> |
517 |
Possibly upload an initial game to an empty room. Not tested. |
518 |
|
519 |
<member name="channel" type="U16"/> |
520 |
<member name="tree" type="TREE"/> |
521 |
</message> |
522 |
|
523 |
<message type="4406" name="upd_tree" src="client"> |
524 |
Upload a partial game tree to the server. This is used to send moves |
525 |
and even in-game comments to the server. For the comments, the |
526 |
server prepends the username and rank. |
527 |
|
528 |
<member name="channel" type="U16"/> |
529 |
<member name="tree" type="TREE"/> |
530 |
</message> |
531 |
|
532 |
<message type="4408" name="get_tree" src="client"> |
533 |
Request the game tree starting at a given node. This is used |
534 |
when the server only sends a partial tree (with end code "more"). |
535 |
<member name="channel" type="U16"/> |
536 |
<member name="node" type="U32"/> |
537 |
</message> |
538 |
|
539 |
<message type="440c" name="claim_win" src="client"> |
540 |
Unclear. |
541 |
<member name="channel" type="U16"/> |
542 |
<member name="_byte" type="U8 "/> |
543 |
Player colour maybe? Unclear. |
544 |
</message> |
545 |
|
546 |
<message type="440d" name="add_time" src="client"> |
547 |
Not checked. |
548 |
|
549 |
<member name="channel" type="U16"/> |
550 |
<member name="time" type="U32"/> |
551 |
<member name="player" type="U8"/> |
552 |
</message> |
553 |
|
554 |
<message type="440f" name="grant_undo" src="client"> |
555 |
Can be send after a req_undo message was received to grant the undo. |
556 |
<member name="channel" type="U16"/> |
557 |
</message> |
558 |
|
559 |
<message type="4410" name="resign_game" src="client"> |
560 |
Resign the game. |
561 |
<member name="channel" type="U16"/> |
562 |
<member name="player" type="U8"/> |
563 |
</message> |
564 |
|
565 |
<message type="441a" name="set_teacher" src="client"> |
566 |
Change the teacher to somebody else (or possibly yourself == take it). |
567 |
<member name="channel" type="U16"/> |
568 |
<member name="name" type="username"/> |
569 |
</message> |
570 |
|
571 |
<message type="4422" name="add_user" src="client"> |
572 |
Unclear. Maybe allow users to talk? No idea, really. |
573 |
|
574 |
<member name="channel" type="U16"/> |
575 |
<member name="othername" type="username"/> |
576 |
<member name="name" type="username"/>; # gives user access to the game (to what? ;) |
577 |
</message> |
578 |
|
579 |
<message type="4423" name="set_privacy" src="client"> |
580 |
Probably sets the "quiet" flag. Not checked. |
581 |
<member name="channel" type="U16"/> |
582 |
<member name="private" type="U8"/> |
583 |
</message> |
584 |
|
585 |
<message type="4429" name="reject_challenge" src="client"> |
586 |
Reject a challenge from a given user. Not checked. |
587 |
|
588 |
<member name="channel" type="U16"/> |
589 |
<member name="name" type="username"/> |
590 |
</message> |
591 |
|
592 |
<message type="4433" name="req_result" src="client"> |
593 |
I forgot. |
594 |
|
595 |
<member name="channel" type="U16"/> |
596 |
</message> |
597 |
|
598 |
<message type="4436" name="msg_game" src="client"> |
599 |
<member name="channel" type="U16"/> |
600 |
<member name="message" type="STRING"/> |
601 |
</message> |
602 |
|
603 |
<message type="ffff" name="quit" src="client"> |
604 |
<p>Sent by the client just before it logs out.</p> |
605 |
</message> |
606 |
|
607 |
<h2>Structs mainly used in messages send by the server</h2> |
608 |
|
609 |
<struct name="challenge_defaults"> |
610 |
Send soon after log-in to set the defaults for game challenges. |
611 |
<member name="gametype" type="U32"/> |
612 |
<member name="size" type="U32"/> |
613 |
<member name="timesys" type="U32"/> |
614 |
<member name="time" type="U32"/> |
615 |
<member name="byo_time" type="U32"/> |
616 |
<member name="byo_periods" type="U32"/> |
617 |
<member name="can_time" type="U32"/> |
618 |
<member name="can_stones" type="U32"/> |
619 |
</struct> |
620 |
|
621 |
<struct name="challenge" class="KGS::Challenge"> |
622 |
A challenge. |
623 |
|
624 |
<member name="user1" type="user"/> |
625 |
<member name="user2" type="user"/> |
626 |
<member name="gametype" type="U32"/> |
627 |
<member name="rules" type="rules"/> |
628 |
Maybe the rules" are in TREE format. I forgot. |
629 |
</struct> |
630 |
|
631 |
<struct name="game" class="KGS::Game"> |
632 |
Basic information about a game. Used in rooms for the gamelist and |
633 |
in games to detect when a game is saved, changed type (e.g. R => D) |
634 |
etc. |
635 |
|
636 |
<member name="channel" type="U16"/> |
637 |
<member name="type" type="U8"/> |
638 |
<member name="user1" type="user"/> |
639 |
White |
640 |
<member name="user2" type="user"/> |
641 |
Black |
642 |
<member name="user3" type="user"/> |
643 |
Owner |
644 |
<member name="size" type="U8"/> |
645 |
<member name="handicap" type="I8"/> |
646 |
< 0 not fully setup |
647 |
<member name="komi" type="komi16"/> |
648 |
<member name="moves" type="I16"/> |
649 |
This field reflects either the movenum or the score, sorry, not even guards help, as |
650 |
the flags to determine that are _after_ the field. Arg. Divide by two to get the actual |
651 |
score (NOT score16!) (arg²). |
652 |
<member name="flags" type="U16"/> |
653 |
<member name="observers" type="U32"/> |
654 |
<member name="saved" type="flag"/> |
655 |
<member name="notes" type="STRING" guard-member="handicap" guard-cond="< 0"/> |
656 |
</struct> |
657 |
|
658 |
<struct name="room_obs"> |
659 |
Obsolete. |
660 |
|
661 |
<member name="name" type="roomname"/> |
662 |
<member name="channel" type="U16"/> |
663 |
<member name="flags" type="U32"/> |
664 |
<member name="users" type="U32"/> |
665 |
</struct> |
666 |
|
667 |
<struct name="room" class="KGS::Room"> |
668 |
<member name="channel" type="U16"/> |
669 |
<member name="flags" type="U8"/> |
670 |
<member name="group" type="U8"/> |
671 |
<member name="users" type="U16"/> |
672 |
<member name="games" type="U16"/> |
673 |
<member name="name" type="STRING"/> |
674 |
</struct> |
675 |
|
676 |
<struct name="scorevalues" class="KGS::Score"> |
677 |
<member name="score" type="score32"/> |
678 |
<member name="territory" type="U32"/> |
679 |
<member name="captures" type="U32"/> |
680 |
<member name="i3" type="U32"/> |
681 |
<member name="f2" type="U32"/> |
682 |
<member name="komi" type="komi324"/> |
683 |
<member name="i4" type="U32"/> |
684 |
Apparently the i3, f2, i4 are zero. |
685 |
</struct> |
686 |
|
687 |
<struct name="game_record" class="KGS::GameRecord"> |
688 |
<p>A single game record entry, as seen in <ref ref="userinfo"/>.</p> |
689 |
|
690 |
<member name="timestamp" type="timestamp"/> |
691 |
Time this game was played. |
692 |
<member name="type" type="U8"/> |
693 |
High four bits are handicap, low four bits are gametype (encoded strangely? unclear). |
694 |
<member name="user1" type="user"/> |
695 |
White, flags contain low 8 bits of revision (bits 16-23). |
696 |
<member name="user2" type="user"/> |
697 |
Black, flags contain high 8 bits of revision (bits 16-23). |
698 |
<member name="user3" type="user"/> |
699 |
|
700 |
<p><p>Owner (or empty)</p> |
701 |
|
702 |
<p>The bits 16-24 of user1.flags and user2.flags give the high and |
703 |
low bits of a revision number in case there are multiple similar |
704 |
games.</p></p> |
705 |
|
706 |
<member name="komi" type="komi16"/> |
707 |
<member name="score" type="score16"/> |
708 |
<member name="status" type="U8"/> |
709 |
|
710 |
<p>0x80 game in progress</p> |
711 |
|
712 |
</struct> |
713 |
|
714 |
<h2>Server-generated messages</h2> |
715 |
|
716 |
<message type="0001" name="login" src="server"> |
717 |
<member name="result" type="CONSTANT" value='"login ok"'/> |
718 |
<member name="success" type="CONSTANT" value="1"/> |
719 |
</message> |
720 |
|
721 |
<message type="0002" name="login" src="server"> |
722 |
<member name="result" type="CONSTANT" value='"guest login ok"'/> |
723 |
<member name="success" type="CONSTANT" value="1"/> |
724 |
</message> |
725 |
|
726 |
<message type="0003" name="login" src="server"> |
727 |
<member name="result" type="CONSTANT" value='"login error 3"'/> |
728 |
** maybe more following? ** |
729 |
</message> |
730 |
|
731 |
<message type="0004" name="login" src="server"> |
732 |
<member name="result" type="CONSTANT" value='"wrong password"'/> |
733 |
** maybe more following? ** |
734 |
</message> |
735 |
|
736 |
<message type="0005" name="login" src="server"> |
737 |
<member name="result" type="CONSTANT" value='"user unknown"'/> |
738 |
** maybe more following? ** |
739 |
</message> |
740 |
|
741 |
<message type="0006" name="login" src="server"> |
742 |
<member name="result" type="CONSTANT" value='"user exists"'/> |
743 |
** maybe more following? ** |
744 |
</message> |
745 |
|
746 |
<message type="0008" name="userinfo" src="server"> |
747 |
User info. |
748 |
<member name="_unused0" type="flag"/> |
749 |
<member name="user" type="user"/> |
750 |
<member name="_unused1" type="U64"/> |
751 |
<member name="realname" type="realname"/> |
752 |
<member name="email" type="email"/> |
753 |
<member name="info" type="userinfo"/> |
754 |
<member name="homepage" type="url"/> |
755 |
<member name="regdate" type="timestamp"/> |
756 |
When the user registered (0 == never registered). |
757 |
<member name="lastlogin" type="timestamp"/> |
758 |
When the user logged in for the last time. |
759 |
<!-- maybe more? --> |
760 |
</message> |
761 |
|
762 |
<message type="0013" name="msg_chat" src="server"> |
763 |
<member name="name" type="username"/> |
764 |
Name of sender (either yourself (echo) or other) |
765 |
<member name="name2" type="username"/> |
766 |
Name of recipient. |
767 |
<member name="message" type="STRING"/> |
768 |
</message> |
769 |
|
770 |
<message type="0015" name="stats" src="server"> |
771 |
<member name="ver_major" type="U16"/> |
772 |
<member name="ver_minor" type="U16"/> |
773 |
<member name="ver_micro" type="U16"/> |
774 |
<member name="boot_time" type="timestamp"/> |
775 |
<member name="users_cur" type="U32"/> |
776 |
<member name="users_max" type="U32"/> |
777 |
<member name="users_lim" type="U32"/> |
778 |
<member name="accts_cur" type="U32"/> |
779 |
<member name="accts_max" type="U32"/> |
780 |
<member name="unknown1" type="U32"/> |
781 |
<member name="work_max" type="U32"/> |
782 |
<member name="rooms_cur" type="U32"/> |
783 |
<member name="rooms_max" type="U32"/> |
784 |
<member name="rooms_lim" type="U32"/> |
785 |
<member name="games_cur" type="U32"/> |
786 |
<member name="games_max" type="U32"/> |
787 |
<member name="games_lim" type="U32"/> |
788 |
<member name="results_cur" type="U32"/> |
789 |
<member name="results_max" type="U32"/> |
790 |
<member name="unknown2" type="U32"/> |
791 |
<member name="params_cur" type="U32"/> |
792 |
<member name="params_max" type="U32"/> |
793 |
<member name="bytes_in" type="U64"/> |
794 |
<member name="packets_in" type="U64"/> |
795 |
<member name="bytes_out" type="U64"/> |
796 |
<member name="packets_out" type="U64"/> |
797 |
</message> |
798 |
|
799 |
<message type="0016" name="idle_warn" src="server"> |
800 |
idle warning, autologout soon (10 minutes...) |
801 |
</message> |
802 |
|
803 |
<message type="0018" name="login" src="server"> |
804 |
<member name="result" type="CONSTANT" value='"login error 18"'/> |
805 |
** maybe more following? ** |
806 |
</message> |
807 |
|
808 |
<message type="0022" name="login" src="server"> |
809 |
I was blocked sooo many times for developing this client that it was |
810 |
easy to figure out. The KGS admins sure need no extra nazi training |
811 |
:( |
812 |
<member name="reason" type="STRING"/> |
813 |
<member name="result" type="CONSTANT" value='"user or ip blocked"'/> |
814 |
</message> |
815 |
|
816 |
<message type="001b" name="timewarning_default" src="server"> |
817 |
WILD guess |
818 |
<member name="channel" type="U16"/> |
819 |
<member name="time" type="U16"/> |
820 |
</message> |
821 |
|
822 |
<message type="001c" name="idle_err" src="server"> |
823 |
autologout |
824 |
</message> |
825 |
|
826 |
<message type="001d" name="ping" src="server"> |
827 |
Sent by the server regularly, but not answering them |
828 |
isn't valid. Strange form of keepalive? |
829 |
</message> |
830 |
|
831 |
<message type="001e" name="usergraph" src="server"> |
832 |
User graph data. |
833 |
<member name="name" type="username"/> |
834 |
<member name="data" type="I16" array="yes"/> |
835 |
If empty, no graph is available. The unit seems to |
836 |
be centi-kyu, with 1 dan == 0, 2 dan == 100, 1 kyu == -100. |
837 |
There is probably one entry per day, the newest one last. |
838 |
</message> |
839 |
|
840 |
<message type="001f" name="memo" src="server"> |
841 |
Unclear. "Leave Message"? |
842 |
6 strings following. |
843 |
<member name="s1" type="STRING"/> |
844 |
<member name="s2" type="STRING"/> |
845 |
<member name="s3" type="STRING"/> |
846 |
<member name="s4" type="STRING"/> |
847 |
<member name="s5" type="STRING"/> |
848 |
<member name="s6" type="STRING"/> |
849 |
</message> |
850 |
|
851 |
<message type="0021" name="userpic" src="server"> |
852 |
<member name="name" type="username"/> |
853 |
Reply to pic_req, contains an image in jpeg format. |
854 |
<member name="data" type="DATA"/> |
855 |
</message> |
856 |
|
857 |
<message type="0100" name="gnotice" src="server"> |
858 |
global notice, sent to everybody |
859 |
<member name="notice" type="STRING"/> |
860 |
</message> |
861 |
|
862 |
<message type="0202" name="notify_event" src="server"> |
863 |
# maybe soe notify? Totally unclear. |
864 |
# loc 0" type="userinfo, flags etc. loc 1 => gameinfo?, loc 2 => game result (more data) |
865 |
<member name="event" type="U32"/> |
866 |
<member name="user" type="user"/> |
867 |
<member name="gamerecord" type="game_record" guard-member="event" guard-cond="== 2"/> |
868 |
<p>Game result record?</p> |
869 |
|
870 |
</message> |
871 |
|
872 |
<message type="0310" name="priv_room" src="server"> |
873 |
"permission denied" when joining a room |
874 |
<member name="name" type="STRING"/> |
875 |
</message> |
876 |
|
877 |
<message type="0318" name="upd_rooms" src="server"> |
878 |
<member name="rooms" type="room" array="yes"/> |
879 |
</message> |
880 |
|
881 |
<message type="0411" name="chal_defaults" src="server"> |
882 |
<member name="channel" type="U16"/> |
883 |
<member name="defaults" type="challenge_defaults"/> |
884 |
</message> |
885 |
|
886 |
<message type="0412" name="rej_game" src="server"> |
887 |
Unable to create challenge. The channel might be optional. |
888 |
<member name="channel" type="U16"/> |
889 |
</message> |
890 |
|
891 |
<message type="0414" name="game_record" src="server"> |
892 |
The users game record. |
893 |
<member name="name" type="username"/> |
894 |
<member name="more" type="flag"/> |
895 |
Wether more games are available (must be requested manually) |
896 |
<member name="games" type="game_record" array="yes"/> |
897 |
</message> |
898 |
|
899 |
<message type="041c" name="upd_game2" src="server"> |
900 |
Unclear. |
901 |
<member name="channel_junk" type="U16"/> |
902 |
<member name="game" type="game"/> |
903 |
</message> |
904 |
|
905 |
<h3>Room messages</h3> |
906 |
|
907 |
<p>Not all room messages are for rooms only, and rooms need to parse |
908 |
not only these messages. Orthogonality, what for?</p> |
909 |
|
910 |
<message type="4300" name="join_room" src="server"> |
911 |
<member name="channel" type="U16"/> |
912 |
<member name="users" type="user" array="yes"/> |
913 |
</message> |
914 |
|
915 |
<message type="4301" name="msg_room" src="server"> |
916 |
<member name="channel" type="U16"/> |
917 |
<member name="name" type="username"/> |
918 |
<member name="message" type="STRING"/> |
919 |
</message> |
920 |
|
921 |
<message type="4302" name="part_room" src="server"> |
922 |
<member name="channel" type="U16"/> |
923 |
<member name="user" type="user"/> |
924 |
</message> |
925 |
|
926 |
<message type="4303" name="del_room" src="server"> |
927 |
<member name="channel" type="U16"/> |
928 |
</message> |
929 |
|
930 |
<message type="4304" name="upd_games" src="server"> |
931 |
<member name="channel" type="U16"/> |
932 |
<member name="games" type="game" array="yes"/> |
933 |
</message> |
934 |
|
935 |
<message type="4319" name="desc_room" src="server"> |
936 |
<member name="channel" type="U16"/> |
937 |
<member name="owner" type="username"/> |
938 |
<member name="description" type="STRING"/> |
939 |
</message> |
940 |
|
941 |
<h3>Game messages</h3> |
942 |
|
943 |
<message type="4400" name="upd_challenge" src="server"> |
944 |
Unclear. |
945 |
<member name="channel" type="U16"/> |
946 |
<member name="challenge" type="challenge"/> |
947 |
</message> |
948 |
|
949 |
<message type="4401" name="upd_game" src="server"> |
950 |
<member name="channel" type="U16"/> |
951 |
<member name="game" type="game"/> |
952 |
</message> |
953 |
|
954 |
<message type="4402" name="del_game" src="server"> |
955 |
<member name="channel" type="U16"/> |
956 |
</message> |
957 |
|
958 |
<message type="4403" name="upd_observers" src="server"> |
959 |
<member name="channel" type="U16"/> |
960 |
<member name="users" type="user" array="yes"/> |
961 |
</message> |
962 |
|
963 |
<message type="4404" name="del_observer" src="server"> |
964 |
<member name="channel" type="U16"/> |
965 |
<member name="name" type="username"/> |
966 |
</message> |
967 |
|
968 |
<message type="4405" name="set_tree" src="server"> |
969 |
<member name="channel" type="U16"/> |
970 |
<member name="tree" type="TREE"/> |
971 |
</message> |
972 |
|
973 |
<message type="4406" name="upd_tree" src="server"> |
974 |
<member name="channel" type="U16"/> |
975 |
<member name="tree" type="TREE"/> |
976 |
</message> |
977 |
|
978 |
<message type="4409" name="superko" src="server"> |
979 |
Superko-warning. |
980 |
<member name="channel" type="U16"/> |
981 |
</message> |
982 |
|
983 |
<message type="440b" name="final_result" src="server"> |
984 |
<member name="channel" type="U16"/> |
985 |
<member name="blackscore" type="scorevalues"/> |
986 |
<member name="whitescore" type="scorevalues"/> |
987 |
</message> |
988 |
|
989 |
<message type="440e" name="req_undo" src="server"> |
990 |
<member name="channel" type="U16"/> |
991 |
|
992 |
</message> |
993 |
|
994 |
<message type="4410" name="resign_game" src="server"> |
995 |
<member name="channel" type="U16"/> |
996 |
<member name="player" type="U8"/> |
997 |
</message> |
998 |
|
999 |
<message type="441a" name="set_teacher" src="server"> |
1000 |
<member name="channel" type="U16"/> |
1001 |
<member name="name" type="username"/> |
1002 |
</message> |
1003 |
|
1004 |
<message type="441d" name="owner_left" src="server"> |
1005 |
Unclear. |
1006 |
<member name="channel" type="U16"/> |
1007 |
</message> |
1008 |
|
1009 |
<message type="441e" name="teacher_left" src="server"> |
1010 |
Unclear. |
1011 |
<member name="channel" type="U16"/> |
1012 |
</message> |
1013 |
|
1014 |
<message type="4422" name="unknown4422" src="server"> |
1015 |
change teacher? something to do with editing? |
1016 |
<member name="channel" type="U16"/> |
1017 |
<member name="name1" type="username"/> |
1018 |
<member name="name2" type="username"/> |
1019 |
</message> |
1020 |
|
1021 |
<message type="4428" name="add_tree" src="server"> |
1022 |
<p>See <ref ref="set_tree"/>. In addition, flags the tree as being |
1023 |
uploaded completely.</p> |
1024 |
<member name="channel" type="U16"/> |
1025 |
<member name="tree" type="TREE"/> |
1026 |
</message> |
1027 |
|
1028 |
<message type="4433" name="req_result" src="server"> |
1029 |
Unclear. |
1030 |
<member name="channel" type="U16"/> |
1031 |
# # recv_result(?) |
1032 |
</message> |
1033 |
|
1034 |
<message type="4434" name="unknown4434" src="server"> |
1035 |
<member name="channel" type="U16"/> |
1036 |
<member name="b1" type="U8"/> |
1037 |
?? !demonstration game?? |
1038 |
</message> |
1039 |
|
1040 |
</body> |
1041 |
</html> |
1042 |
|