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,2004,2005 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.79 $</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 (and partly has been done).</p> |
34 |
|
35 |
<p>If you feel you need to update the visual appearance of this |
36 |
document, feel free to look at <tt>doc/doc2html.xsl</tt> and improve |
37 |
it.</p> |
38 |
|
39 |
<p>The current version of this document can always be found at |
40 |
<a href="http://cvs.schmorp.de/browse/*checkout*/kgsueme/doc/protocol.xml">here</a>, while |
41 |
the HTML version of it can be found |
42 |
<a href="http://cvs.schmorp.de/browse/*checkout*/kgsueme/doc/protocol.html">here</a>.</p> |
43 |
|
44 |
<h2>Structure and conventions of this document and the protocol</h2> |
45 |
|
46 |
<p>"ORIGIN: CLIENT" means messages send from the client to the server, |
47 |
while "ORIGIN: SERVER" means messages send by the server to the |
48 |
client.</p> |
49 |
|
50 |
<p>Everything on the wire is in little-endian format (what a shame).</p> |
51 |
|
52 |
<p>Primitive types are mostly integers (signed |
53 |
"<code>I</code><bits>", unsigned "<code>U</code><bits>"), |
54 |
ascii strings ("<code>username</code>"), zero- or non-terminated |
55 |
UCS2-Strings ("<code>ZSTRING</code>" or "<code>STRING</code>"). Yes, |
56 |
I know java is supposed to do UTF-16, but no implementation seems to |
57 |
care...</p> |
58 |
|
59 |
<p>To get a feel for the protocol, get the <tt>KGS</tt> perl module |
60 |
from CPAN, install it an run <tt>kgstrace</tt>, then conenct to |
61 |
<tt>127.0.0.1</tt> with your client. <tt>kgstrace</tt> will dump all |
62 |
messages from and to the server.</p> |
63 |
|
64 |
<p>For the rest, go figure or bug me, <a |
65 |
href="mailto:pcg@goof.com">Marc Lehmann <pcg@goof.com></a></p> |
66 |
|
67 |
<h2>Stream and message structure.</h2> |
68 |
|
69 |
<p>After connecting to the server, a handshake byte is sent. It's |
70 |
the major version number of the protocol the client expects to |
71 |
receive. Version 3 and 4 are mostly the same, except that Version 4 |
72 |
clients expect server messages to be compressed, version 3 clients |
73 |
do not. (version 3 probably is no longer supported).</p> |
74 |
|
75 |
<p>The server sends back his protocol number, which is always 3 in |
76 |
the current protocol. Most of the protocol variation is determined by |
77 |
the server using the client version that is used in the initial login |
78 |
message, not the initial handshake byte.</p> |
79 |
|
80 |
<p>After the initial handshake, the client sends uncompressed |
81 |
messages, while the server sends back a zlib-compressed |
82 |
stream (<a href="http://rfc1950.x42.com/">rfc1950</a> and <a |
83 |
href="http://rfc1950.x42.com/">rfc1951</a>).</p> |
84 |
|
85 |
<p>All messages have the same header:</p> |
86 |
|
87 |
<struct name="message_header"> |
88 |
<member name="length" type="U16"/> |
89 |
|
90 |
<p>The length is the length of the full message including the header.</p> |
91 |
|
92 |
<p>Beginning with version 2.5.x, a number is xored into the low |
93 |
byte of the length in <em>sent</em> packages only, as given by the |
94 |
following recurrence: <code>rand[0] = 0; rand[i+1] = msg[i].length |
95 |
+ (rand[i] * 0x04c2af9b + 0xfffffffb); xorbyte = rand >> |
96 |
24</code>, all in 32 bit unsigned iso-c arithmetic.</p> |
97 |
|
98 |
<member name="type" type="U16"/> |
99 |
<p>If the type is >= 0x4000 this is a message for a specific channel. The channel |
100 |
number is always the next U16. All of these channel values are valid, including zero.</p> |
101 |
|
102 |
<p>Beginning with version 2.5.x, a number is <em>added</em> on <em>received</em> |
103 |
messages only. The algorithm is as follows: |
104 |
|
105 |
<pre> |
106 |
msglen < 44: type = typefield |
107 |
msglen > 44: type = (typefield + rand[i]) % 0x10000 |
108 |
rand[0] = 0 |
109 |
rand[i+1] = username[type % length username] + rand[i] * (type - 0x6cdd) |
110 |
where username is the user name of the logged-in user. coooool. |
111 |
</pre> |
112 |
</p> |
113 |
|
114 |
</struct> |
115 |
|
116 |
<h2>Primitive types used in the protocol.</h2> |
117 |
|
118 |
<p>Apart from the basic types, I need to define some extra types to |
119 |
deal with fixed-point values (based on integer types) or fixed-length |
120 |
strings (either 7-bit-ascii or more limited (<code>A</code>), or UCS-2 |
121 |
based (<code>S</code>)).</p> |
122 |
|
123 |
<type name="username" type="A" length="10"/> |
124 |
|
125 |
<p>The basic user or login name, used throughout the protocol |
126 |
as a handle to the user.</p> |
127 |
|
128 |
<type name="roomname" type="S" length="25"/><!-- argh, how horribly broken --> |
129 |
|
130 |
<p>Many strings in the protocol are fixed-width for no good reason |
131 |
(maybe this is one reason for using compression in newer versions, as |
132 |
the packets itself are wasting lots of space.</p> |
133 |
|
134 |
<type name="realname" type="S" length="50"/> |
135 |
<type name="email" type="S" length="70"/> |
136 |
<type name="userinfo" type="S" length="1000"/> |
137 |
<type name="url" type="A" length="100"/> |
138 |
|
139 |
<p>Used in user_record.</p> |
140 |
|
141 |
<type name="locale" type="A" length="5"/> |
142 |
|
143 |
<p>A kind of locale specifier. It seems the general format seems to be |
144 |
lowercase language, underscore, uppercase location, e.g. en_US. More |
145 |
fancy specifications don't fit.</p> |
146 |
|
147 |
<type name="flag" type="U8" multiplier="1"/> |
148 |
|
149 |
<p>Just a simple boolean value. 0 means false, and 1 generally true, |
150 |
but I suggest accepting != 0 as true.</p> |
151 |
|
152 |
<type name="komi16_2" type="I16" multiplier="2"/> |
153 |
<type name="komi16_4" type="I16" multiplier="4"/> |
154 |
<type name="komi32_2" type="I32" multiplier="2"/> |
155 |
<type name="komi32_4" type="I32" multiplier="4"/> |
156 |
|
157 |
<p>Komi values are multiplied by 2 or 4 to make them integer in the |
158 |
protocol.</p> |
159 |
|
160 |
<type name="result" type="I32" multiplier="2"/> |
161 |
|
162 |
<p>The game result is also multiplied by 2 to give it higher |
163 |
resolution. There are also special values for wins by time etc., either |
164 |
in result or in the score* types, or both :)</p> |
165 |
|
166 |
<type name="score16_2" type="I16" multiplier="2"/> |
167 |
<type name="score16_4" type="I16" multiplier="4"/> |
168 |
<type name="score32_4" type="I32" multiplier="4"/> |
169 |
<type name="score32_1000" type="I32" multiplier="1000"/> |
170 |
|
171 |
<p>A score value (used for displaying the score at the end of a game) |
172 |
are multiplied by 2 or 4 for a change (the 0.25 resolution is not |
173 |
used). In game structures it is encoded by dividing by two, though, so |
174 |
watch out! And in some others, it's encoded by multiplying by 1000... |
175 |
yuck!</p> |
176 |
|
177 |
<type name="time" type="U32" multiplier="1000"/> |
178 |
|
179 |
<p>Time values are multiplied by 1000, giving them millisecond |
180 |
accuracy.</p> |
181 |
|
182 |
<type name="timestamp" type="U64" multiplier="1000"/> |
183 |
|
184 |
<p>64 bit timeval, milliseconds since posix epoch, e.g. <code>my |
185 |
($year, $month, $day) = (gmtime $date * 0.001)[5,4,3];</code></p> |
186 |
|
187 |
<type name="password" type="U64"/> |
188 |
|
189 |
<p>Password is a number calculated as follows (VERY insecure, basically |
190 |
plaintext!): <code>password = 0; for char in characters do password ← |
191 |
password * 1055 + ascii_code (char)</code></p> |
192 |
|
193 |
<type name="CLIENTID16" type="U16" multiplier="1"/> |
194 |
<type name="CLIENTID8" type="U8" multiplier="1"/> |
195 |
|
196 |
<p>An id chosen by the client, usually starting at one, to identify |
197 |
some handshakes initiated by the client, such as new games or memos.</p> |
198 |
|
199 |
<h2>Enumeration and set types used in the protocol.</h2> |
200 |
|
201 |
<enum name="GAMETYPE"> |
202 |
<member name="DEMONSTRATION" value="0"/> |
203 |
<member name="EDITING" value="1"/> |
204 |
<member name="TEACHING" value="2"/> |
205 |
<member name="SIMUL" value="3"/> |
206 |
<member name="FREE" value="4"/> |
207 |
<member name="RATED" value="5"/> |
208 |
<member name="PRIVATE" value="128"/> |
209 |
<p>PRIVATE is or'ed onto DEMONSTRATION or TEACHING</p> |
210 |
</enum> |
211 |
|
212 |
<set name="GAMEFLAG"> |
213 |
<member name="SCORED" value="1"/> |
214 |
<member name="ADJOURNED" value="2"/> |
215 |
<member name="UPLOADED" value="4"/> |
216 |
</set> |
217 |
|
218 |
<set name="ROOMFLAG"> |
219 |
<member name="ADMIN" value="0x01"/> |
220 |
<p>Admins only(?)</p> |
221 |
<member name="DEFAULT" value="0x04"/> |
222 |
<p>Seems to be set on the english room. Or maybe not.</p> |
223 |
<member name="PRIVATE" value="0x10"/> |
224 |
<p>This room is private.</p> |
225 |
</set> |
226 |
|
227 |
<set name="GAMESTATUS"> |
228 |
<member name="INPLAY" value="0x80"/> |
229 |
</set> |
230 |
|
231 |
<enum name="SCORE"> |
232 |
<p>Special score values, in addition to numerical scores. Some are also used with their |
233 |
negative value. Unfortunately, these are the raw vaues, before scaling. WMS loves code duplication.</p> |
234 |
|
235 |
<member name="TIMEOUT" value="16384"/> |
236 |
Also used negatively to score for white instead of black. |
237 |
|
238 |
<member name="RESIGN" value="16385"/> |
239 |
Also used negatively to score for white instead of black. |
240 |
|
241 |
<member name="FORFEIT" value=" 0"/> |
242 |
Also used negatively to score for white instead of black. |
243 |
|
244 |
<member name="JIGO" value="16386"/> |
245 |
|
246 |
<member name="NO_RESULT" value="16386"/> |
247 |
<member name="ADJOURNED" value="16387"/> |
248 |
<member name="UNKNOWN" value="16389"/> |
249 |
</enum> |
250 |
|
251 |
<enum name="RULESET"> |
252 |
<member name="JAPANESE" value="0"/> |
253 |
<member name="CHINESE " value="1"/> |
254 |
<member name="AGA" value="2"/> |
255 |
<member name="NEW_ZEALAND" value="3"/> |
256 |
</enum> |
257 |
|
258 |
<enum name="TIMESYS"> |
259 |
<member name="NONE" value="0"/> |
260 |
<member name="ABSOLUTE" value="1"/> |
261 |
<member name="BYO_YOMI" value="2"/> |
262 |
<member name="CANADIAN" value="3"/> |
263 |
</enum> |
264 |
|
265 |
<enum name="COLOUR"> |
266 |
<p>Convinience constants used in several places.</p> |
267 |
<member name="BLACK" value="0"/> |
268 |
<member name="WHITE" value="1"/> |
269 |
<member name="NONE" value="2"/> |
270 |
<p>Sometimes used to mark absence of marks, or no player or etc...</p> |
271 |
</enum> |
272 |
|
273 |
<h2>Structs used in send & receive messages</h2> |
274 |
|
275 |
<struct name="user" class="KGS::User"> |
276 |
|
277 |
<p>Almost everywhere a user + flags is required, even used in some places |
278 |
where only a username is required. I see no general rule on when a |
279 |
complete user and when a partial user is required.</p> |
280 |
|
281 |
<member name="name" type="username"/> |
282 |
<member name="flags" type="U32" value="1"/> |
283 |
</struct> |
284 |
|
285 |
<struct name="rules" class="KGS::Rules"> |
286 |
|
287 |
<p>This structure is used for challenges as well as in the special |
288 |
TREE "subprotocol". It tightly encodes the game parameters.</p> |
289 |
|
290 |
<member name="ruleset" type="U8"/> |
291 |
<member name="size" type="U8"/> |
292 |
<member name="handicap" type="U8"/> |
293 |
<member name="komi" type="komi16_2"/> |
294 |
<member name="timesys" type="U8"/> |
295 |
<member name="time" type="U32"/> |
296 |
<member name="interval" type="U32"/> |
297 |
byo-yomi time / canadian time |
298 |
<member name="count" type="U16"/> |
299 |
periods / moves |
300 |
</struct> |
301 |
|
302 |
<h2>Structs used in messages from the client</h2> |
303 |
|
304 |
<h2>Client-generated messages</h2> |
305 |
|
306 |
<message type="0000" name="login" src="client"> |
307 |
|
308 |
<p>Sent to login, usually the first message sent. The password needs to be set when the |
309 |
guest flag is true. |
310 |
Possible replies: <ref reply="login"/>. Followed by: <ref reply="timewarning_default"/> <ref reply="chal_defaults"/> |
311 |
</p> |
312 |
|
313 |
<member name="ver_major" type="U32" value="2"/> |
314 |
<member name="ver_minor" type="U32" value="6"/> |
315 |
<member name="ver_micro" type="U32" value="12"/> |
316 |
<member name="name" type="username"/> |
317 |
<member name="password" type="password" value="0"/> |
318 |
<member name="guest" type="flag" value="1"/> |
319 |
<member name="_unknown3" type="U16" value="0"/> |
320 |
<member name="locale" type="locale" value='"en_US"'/> |
321 |
<member name="clientver" type="DATA" value='"1.4.2_03:Swing app:Sun Microsystems Inc."'/> |
322 |
The "default" is the java vm version, not exactly he client version. However, |
323 |
you should always send a text like "Jonathan's C client version 0.6" or somesuch, |
324 |
so the server can, if necessary, block broken clients or client versions. |
325 |
</message> |
326 |
|
327 |
<message type="0007" name="req_userinfo" src="client"> |
328 |
<p>Request info about a certain user. Possible reply: <ref reply="userinfo"/></p> |
329 |
<member name="name" type="username"/> |
330 |
</message> |
331 |
|
332 |
<message type="0007" name="update_userinfo" src="client"> |
333 |
<p>Update user info. Message structure is very similar |
334 |
to <ref ref="userinfo"/>.</p> |
335 |
<member name="setpass" type="flag"/> |
336 |
Should the password be updated? |
337 |
<member name="password" type="password" value="0"/> |
338 |
<member name="realname" type="realname"/> |
339 |
<member name="email" type="email"/> |
340 |
<member name="info" type="userinfo"/> |
341 |
<member name="homepage" type="url"/> |
342 |
<member name="_unused" type="U64" value="0"/> |
343 |
<member name="_unused" type="U64" value="0"/> |
344 |
</message> |
345 |
|
346 |
<message type="0013" name="msg_chat" src="client"> |
347 |
<p>This message is sent to initiate or continue a private chat with |
348 |
a user. You'll always receive a copy of what you have sent back |
349 |
from the server (as usual).</p> |
350 |
|
351 |
<member name="name" type="username"/> |
352 |
Name of sender ("yourself"). |
353 |
<member name="name2" type="username"/> |
354 |
Name of recipient. |
355 |
<member name="message" type="STRING"/> |
356 |
The message. |
357 |
</message> |
358 |
|
359 |
<message type="0014" name="req_stats" src="client"> |
360 |
<p>Request server statistics. Replied with <ref reply="stats"/></p> |
361 |
</message> |
362 |
|
363 |
<message type="0016" name="idle_reset" src="client"> |
364 |
<p>Send in response to <ref reply="idle_warn"/> to keep the server from disconnecting.</p> |
365 |
</message> |
366 |
|
367 |
<message type="001d" name="ping" src="client"> |
368 |
<p>No idea. Not used anymore?</p> |
369 |
</message> |
370 |
|
371 |
<message type="001e" name="req_usergraph" src="client"> |
372 |
<p>Request user graph data, replied with <ref reply="usergraph"/>.</p> |
373 |
<member name="name" type="username"/> |
374 |
</message> |
375 |
|
376 |
<message type="0021" name="req_pic" src="client"> |
377 |
<p>Request a user picture from the server. Results in a <ref reply="userpic"/> |
378 |
or a timeout.</p> |
379 |
<member name="name" type="username"/> |
380 |
</message> |
381 |
|
382 |
<message type="0021" name="upload_pic" src="client"> |
383 |
Same code as pic_req, but with an additional data section that |
384 |
must contain a JPEG image that is <=7KB. It must have 141×200 pixels. |
385 |
<member name="name" type="username"/> |
386 |
<member name="data" type="DATA"/> |
387 |
</message> |
388 |
|
389 |
<message type="0023" name="send_memo" src="client"> |
390 |
<member name="name" type="username"/> |
391 |
<member name="cid" type="CLIENTID16"/> |
392 |
<p>A boolean, probably. Always true for me.</p> |
393 |
<member name="msg" type="STRING"/> |
394 |
</message> |
395 |
|
396 |
<message type="0024" name="delete_memos" src="client"> |
397 |
<p>Unconditionally deletes all memos.</p> |
398 |
</message> |
399 |
|
400 |
<message type="0100" name="gnotice" src="client"> |
401 |
<p>Send a global message. Maybe. Never tried, for obvious reasons :/. Results |
402 |
in a <ref reply="gnotice"/> sent to all users.</p> |
403 |
<member name="notice" type="STRING"/> |
404 |
</message> |
405 |
|
406 |
<message type="0200" name="notify_add" src="client"> |
407 |
|
408 |
<p>Probably setting a notifier on a username, to get informed about |
409 |
changes using <ref reply="notify_upd"/> messages. sending your own |
410 |
username gives you a disconnect, so don't do that at home, kids!</p> |
411 |
|
412 |
<member name="name" type="username"/> |
413 |
</message> |
414 |
|
415 |
<message type="0201" name="notify_del" src="client"> |
416 |
|
417 |
<p>Probably remove the notifier again.</p> |
418 |
|
419 |
<member name="name" type="username"/> |
420 |
</message> |
421 |
|
422 |
<message type="0318" name="list_rooms" src="client"> |
423 |
<p>List the rooms in a specific group/category. Results in a <ref reply="upd_rooms"/> message.</p> |
424 |
<member name="group" type="U8"/> |
425 |
</message> |
426 |
|
427 |
<message type="031a" name="new_room" src="client"> |
428 |
Create a new room. Not verified. |
429 |
<member name="name" type="username"/> |
430 |
<member name="i1" type="U32" value="0"/> |
431 |
<member name="b1" type="U8" value="0"/> |
432 |
<member name="b2" type="U8" value="255"/> |
433 |
<member name="b3" type="U8" value="255"/> |
434 |
<member name="group" type="U8" value="1"/> |
435 |
<member name="name" type="ZSTRING"/> |
436 |
<member name="description" type="ZSTRING"/> |
437 |
<member name="flags" type="U8"/> |
438 |
See ROOMFLAGs |
439 |
</message> |
440 |
|
441 |
<message type="031b" name="req_upd_rooms" src="client"> |
442 |
<p>Request a rooms update message for the given room.</p> |
443 |
<member name="channel" type="U16"/> |
444 |
</message> |
445 |
|
446 |
<message type="0413" name="req_game_record" src="client"> |
447 |
<p>Requests part of the users game record to be sent. Results in a <ref reply="game_record"/> or maybe a timeout.</p> |
448 |
<member name="name" type="username"/> |
449 |
<member name="timestamp" type="timestamp"/> |
450 |
<p>If zero, start at the newest games, else this should be the timestamp |
451 |
of the first gamerecord sent in the <ref reply="game_record"/> response.</p> |
452 |
</message> |
453 |
|
454 |
<message type="4300" name="join_room" src="client"> |
455 |
<p>Joins the given room. <ref reply="join_room"/> messages for yourself |
456 |
and all users in that room, as well as the initial gamelist, are |
457 |
send if the room exists. If not, timeout...</p> |
458 |
<member name="channel" type="U16"/> |
459 |
<member name="user" type="user"/> |
460 |
</message> |
461 |
|
462 |
<message type="4301" name="msg_room" src="client"> |
463 |
Send a message to the room. |
464 |
<member name="channel" type="U16"/> |
465 |
<member name="name" type="username"/> |
466 |
Must be the login-name of the user. |
467 |
<member name="message" type="STRING"/> |
468 |
</message> |
469 |
|
470 |
<message type="4302" name="part_room" src="client"> |
471 |
Remove yourself (or maybe others as admin) from a room. |
472 |
<member name="channel" type="U16"/> |
473 |
<member name="name" type="username"/> |
474 |
</message> |
475 |
|
476 |
<message type="4305" name="new_game" src="client"> |
477 |
<p>Create a new game.</p> |
478 |
|
479 |
<member name="channel" type="U16"/> |
480 |
<p>The room where to start the new game</p> |
481 |
<member name="cid" type="CLIENTID16"/> |
482 |
<member name="gametype" type="U8"/> |
483 |
<p> |
484 |
GAMETYPE_UPLOAD probably not allowed. GAMETYPE_PRIVATE |
485 |
only allowd together with GAMETYPE_TEACHING, GAMETYPE_DEMONSTRATION. |
486 |
</p> |
487 |
<member name="flags" type="U8"/> |
488 |
<p> |
489 |
0x2 == global open game list |
490 |
</p> |
491 |
<member name="rules" type="rules"/> |
492 |
<p>When cloning a game, the rules are set up like this: |
493 |
count => 65535, ruleset => 0, time => 4294967295, timesys => 0, interval => 4294967295. |
494 |
Cloning itself seems to be implemented solely in the client (somewhat sane, for a change). |
495 |
</p> |
496 |
<member name="notes" type="STRING"/> |
497 |
</message> |
498 |
|
499 |
<message type="430a" name="load_game" src="client"> |
500 |
Load an existing game into a room(?) |
501 |
There is no indication that a new game is there except |
502 |
for a upd_observers message with your name in it. Which means |
503 |
you have to watch upd_observers messages that are not for any |
504 |
currently open game and open one. Ugh. |
505 |
<member name="channel" type="U16"/> |
506 |
The room to load the game into. |
507 |
<member name="timestamp" type="timestamp"/> |
508 |
From the game record. |
509 |
<member name="user" type="username"/> |
510 |
<member name="flags" type="U8"/> |
511 |
0 == public, 2 == private |
512 |
</message> |
513 |
|
514 |
<message type="430b" name="req_games" src="client"> |
515 |
Request to update room game list (send this once per minute to get |
516 |
updated). Results in upd_games messages. |
517 |
<member name="channel" type="U16"/> |
518 |
</message> |
519 |
|
520 |
<message type="4319" name="req_desc" src="client"> |
521 |
Request room description. |
522 |
<member name="channel" type="U16"/> |
523 |
</message> |
524 |
|
525 |
<message type="4400" name="challenge" src="client"> |
526 |
<p>Used to send challenges to existing games.</p> |
527 |
<member name="channel" type="U16"/> |
528 |
<member name="black" type="user"/> |
529 |
<member name="white" type="user"/> |
530 |
<member name="gametype" type="U8"/> |
531 |
<member name="cid" type="CLIENTID8"/> |
532 |
<p>Possibly an id. No idea. Better echo this from the challenge request.</p> |
533 |
<member name="rules" type="rules"/> |
534 |
</message> |
535 |
|
536 |
<message type="4403" name="join_game" src="client"> |
537 |
Join a game. See join_room. |
538 |
<member name="channel" type="U16"/> |
539 |
<member name="user" type="user"/> |
540 |
</message> |
541 |
|
542 |
<message type="4404" name="part_game" src="client"> |
543 |
Leave (or kick as admin?) a certain user from a game. |
544 |
<member name="channel" type="U16"/> |
545 |
<member name="name" type="username"/> |
546 |
</message> |
547 |
|
548 |
<message type="4405" name="set_tree" src="client"> |
549 |
Possibly upload an initial game to an empty room. Not tested. |
550 |
|
551 |
<member name="channel" type="U16"/> |
552 |
<member name="tree" type="TREE"/> |
553 |
</message> |
554 |
|
555 |
<message type="4406" name="upd_tree" src="client"> |
556 |
<p>Upload a partial game tree to the server. This is used to send moves |
557 |
and even in-game comments to the server. For the comments, the |
558 |
server prepends the username and rank.</p> |
559 |
<member name="channel" type="U16"/> |
560 |
<member name="tree" type="TREE"/> |
561 |
</message> |
562 |
|
563 |
<message type="4407" name="mark_dead" src="client"> |
564 |
<p>Marks stones ad dead (or alive?) by the client. Details unclear</p> |
565 |
<member name="channel" type="U16"/> |
566 |
<member name="x" type="U8"/> |
567 |
<member name="y" type="U8"/> |
568 |
<member name="dead" type="flag"/> |
569 |
<p>Possibly true means mark dead and false unmark, but that's just a wild guess.</p> |
570 |
</message> |
571 |
|
572 |
<message type="4408" name="get_tree" src="client"> |
573 |
<p>Request the game tree starting at a given node. This is used when |
574 |
the server only sends a partial tree (with end code "more").</p> |
575 |
<member name="channel" type="U16"/> |
576 |
<member name="node" type="U32"/> |
577 |
</message> |
578 |
|
579 |
<message type="440a" name="game_done" src="client"> |
580 |
<p>Sent by the client to mark the game as done.</p> |
581 |
<member name="channel" type="U16"/> |
582 |
<member name="id" type="U32"/> |
583 |
<p>An id field (start at one please) to make sure that the client responds to the correct done click.</p> |
584 |
</message> |
585 |
|
586 |
<message type="440c" name="claim_win" src="client"> |
587 |
<p>Used by the client to claim a win.</p> |
588 |
<member name="channel" type="U16"/> |
589 |
<member name="player" type="U8 "/> |
590 |
</message> |
591 |
|
592 |
<message type="440d" name="add_time" src="client"> |
593 |
<p>Adds the given amount of time to your opponent's clock.</p> |
594 |
<member name="channel" type="U16"/> |
595 |
<member name="time" type="U32"/> |
596 |
<member name="player" type="U8"/> |
597 |
</message> |
598 |
|
599 |
<message type="440e" name="req_undo" src="client"> |
600 |
<member name="channel" type="U16"/> |
601 |
</message> |
602 |
|
603 |
<message type="440f" name="grant_undo" src="client"> |
604 |
Can be send after a req_undo message was received to grant the undo. |
605 |
<member name="channel" type="U16"/> |
606 |
</message> |
607 |
|
608 |
<message type="4410" name="resign_game" src="client"> |
609 |
Resign the game. |
610 |
<member name="channel" type="U16"/> |
611 |
<member name="player" type="U8"/> |
612 |
</message> |
613 |
|
614 |
<message type="441a" name="set_teacher" src="client"> |
615 |
<p>Change the teacher to somebody else (or possibly yourself == take it). If the |
616 |
name is empty, the game will continue normally.</p> |
617 |
<member name="channel" type="U16"/> |
618 |
<member name="name" type="username"/> |
619 |
</message> |
620 |
|
621 |
<message type="4422" name="allow_user" src="client"> |
622 |
<p>Unclear. Maybe allow users to talk? No idea, really.</p> |
623 |
|
624 |
<member name="channel" type="U16"/> |
625 |
<member name="othername" type="username"/> |
626 |
<member name="name" type="username"/>; # gives user access to the game (to what? ;) |
627 |
</message> |
628 |
|
629 |
<message type="4423" name="set_privacy" src="client"> |
630 |
Probably sets the "quiet" flag. Not checked. |
631 |
<member name="channel" type="U16"/> |
632 |
<member name="private" type="flag"/> |
633 |
</message> |
634 |
|
635 |
<message type="4427" name="game_move" src="client"> |
636 |
<p>Only during playing, moves.</p> |
637 |
<member name="channel" type="U16"/> |
638 |
<member name="x" type="U8"/> |
639 |
<member name="y" type="U8"/> |
640 |
</message> |
641 |
|
642 |
<message type="4429" name="reject_challenge" src="client"> |
643 |
Reject a challenge from a given user. Not checked. |
644 |
|
645 |
<member name="channel" type="U16"/> |
646 |
<member name="name" type="username"/> |
647 |
<member name="gametype" type="U8"/> |
648 |
<member name="cid" type="CLIENTID8"/> |
649 |
<p>Possibly an id. No idea. Better echo this from the challenge request.</p> |
650 |
<member name="rules" type="rules"/> |
651 |
</message> |
652 |
|
653 |
<message type="442d" name="more_comments" src="client"> |
654 |
<p>Quite brokenly, the want this to send you more comments. |
655 |
Reply to <ref ref="more_comments"/>.</p> |
656 |
<member name="channel" type="U16"/> |
657 |
<member name="node" type="U32"/> |
658 |
</message> |
659 |
|
660 |
<message type="442e" name="save_game" src="client"> |
661 |
<p>Is send when a game is closed and should be saved on the gamerecord.</p> |
662 |
|
663 |
<member name="channel" type="U16"/> |
664 |
</message> |
665 |
|
666 |
<message type="4433" name="req_result" src="client"> |
667 |
I forgot. |
668 |
|
669 |
<member name="channel" type="U16"/> |
670 |
</message> |
671 |
|
672 |
<message type="4434" name="set_quiet" src="client"> |
673 |
<p>Sets (or clears) the quiet flag on a game.</p> |
674 |
<member name="channel" type="U16"/> |
675 |
<member name="quiet" type="flag"/> |
676 |
</message> |
677 |
|
678 |
<message type="4436" name="msg_game" src="client"> |
679 |
<member name="channel" type="U16"/> |
680 |
<member name="message" type="STRING"/> |
681 |
</message> |
682 |
|
683 |
<message type="ffff" name="quit" src="client"> |
684 |
<p>Sent by the client just before it logs out.</p> |
685 |
</message> |
686 |
|
687 |
<h2>Structs mainly used in messages send by the server</h2> |
688 |
|
689 |
<struct name="challenge_defaults"> |
690 |
Send soon after log-in to set the defaults for game challenges. |
691 |
<member name="gametype" type="U8"/> |
692 |
<member name="ruleset" type="U8"/> |
693 |
<p>The ruleset member is a pure guess, please verify. it could also be after size for example.</p> |
694 |
<member name="size" type="U32"/> |
695 |
<member name="timesys" type="U32"/> |
696 |
<member name="time" type="U32"/> |
697 |
<member name="byo_time" type="U32"/> |
698 |
<member name="byo_periods" type="U32"/> |
699 |
<member name="can_time" type="U32"/> |
700 |
<member name="can_stones" type="U32"/> |
701 |
<member name="notes" type="STRING"/> |
702 |
</struct> |
703 |
|
704 |
<struct name="game" class="KGS::Game"> |
705 |
Basic information about a game. Used in rooms for the gamelist and |
706 |
in games to detect when a game is saved, changed type (e.g. R => D) |
707 |
etc. |
708 |
|
709 |
<member name="channel" type="U16"/> |
710 |
<member name="type" type="U8"/> |
711 |
<member name="black" type="user"/> |
712 |
White |
713 |
<member name="white" type="user"/> |
714 |
Black |
715 |
<member name="owner" type="user"/> |
716 |
Owner |
717 |
<member name="size" type="U8"/> |
718 |
<member name="handicap" type="I8"/> |
719 |
< 0 not fully setup |
720 |
<member name="komi" type="komi16_2"/> |
721 |
<member name="moves" type="I16"/> |
722 |
This field reflects either the movenum or the score, sorry, not even guards help, as |
723 |
the flags to determine that are _after_ the field. Arg. Divide by two to get the actual |
724 |
score (arg²). |
725 |
<member name="flags" type="U16"/> |
726 |
<member name="observers" type="U32"/> |
727 |
<member name="saved" type="flag"/> |
728 |
<member name="notes" type="ZSTRING" guard-member="handicap" guard-cond="< 0"/> |
729 |
</struct> |
730 |
|
731 |
<struct name="room_game"> |
732 |
A game with the room id prepended. |
733 |
|
734 |
<member name="channel" type="U16"/> |
735 |
<p>The room channel.</p> |
736 |
<member name="game" type="game"/> |
737 |
</struct> |
738 |
|
739 |
<struct name="room_obs"> |
740 |
Obsolete. |
741 |
|
742 |
<member name="name" type="roomname"/> |
743 |
<member name="channel" type="U16"/> |
744 |
<member name="flags" type="U32"/> |
745 |
<member name="users" type="U32"/> |
746 |
</struct> |
747 |
|
748 |
<struct name="room" class="KGS::Room"> |
749 |
<member name="channel" type="U16"/> |
750 |
<member name="flags" type="U8"/> |
751 |
<member name="group" type="U8"/> |
752 |
<member name="users" type="U16"/> |
753 |
<member name="games" type="U16"/> |
754 |
<member name="name" type="STRING"/> |
755 |
</struct> |
756 |
|
757 |
<struct name="scorevalues" class="KGS::Score"> |
758 |
<member name="score" type="score32_4"/> |
759 |
<member name="territory" type="U32"/> |
760 |
<member name="captures" type="U32"/> |
761 |
<member name="i3" type="U32"/> |
762 |
<member name="f2" type="U32"/> |
763 |
<member name="komi" type="komi32_4"/> |
764 |
<member name="i4" type="U32"/> |
765 |
Apparently the i3, f2, i4 are zero. |
766 |
</struct> |
767 |
|
768 |
<struct name="game_record" class="KGS::GameRecord"> |
769 |
<p>A single game record entry, as seen in <ref ref="userinfo"/>.</p> |
770 |
|
771 |
<member name="timestamp" type="timestamp"/> |
772 |
Time this game was played. |
773 |
<member name="type" type="U8"/> |
774 |
<member name="handicap" type="U8"/> |
775 |
|
776 |
<member name="revision" type="U16"/> |
777 |
<p>A revision number in case there are multiple similar games.</p> |
778 |
|
779 |
<member name="black" type="user"/> |
780 |
<member name="white" type="user"/> |
781 |
<member name="owner" type="user"/> |
782 |
|
783 |
<member name="komi" type="U16"/> |
784 |
<p>0:11 == komi * 2; 12:15 == no idea, always 1-0-0-0?</p> |
785 |
<member name="score" type="score16_2"/> |
786 |
<member name="size" type="U8"/> |
787 |
<p>0:5 == size; 6 no idea; 7 == inprogress</p> |
788 |
<member name="flags" type="U8"/> |
789 |
<p>No idea. I see many values here.</p> |
790 |
|
791 |
</struct> |
792 |
|
793 |
<h2>Server-generated messages</h2> |
794 |
|
795 |
<message type="0001" name="login" src="server"> |
796 |
<member name="message" type="CONSTANT" value='login successful'/> |
797 |
<member name="success" type="CONSTANT" value="1"/> |
798 |
|
799 |
<member name="user" type="user"/> |
800 |
<member name="unknown1" type="U16"/> |
801 |
<member name="unknown2" type="U16"/> |
802 |
</message> |
803 |
|
804 |
<message type="0002" name="login" src="server"> |
805 |
<member name="message" type="CONSTANT" value='login successful: client version is outdated.'/> |
806 |
<member name="success" type="CONSTANT" value="1"/> |
807 |
|
808 |
<member name="user" type="user"/> |
809 |
<member name="unknown1" type="U16"/> |
810 |
<member name="unknown2" type="U16"/> |
811 |
</message> |
812 |
|
813 |
<message type="0003" name="login" src="server"> |
814 |
<member name="message" type="CONSTANT" value='login failed: client version out of date'/> |
815 |
|
816 |
<member name="user" type="user"/> |
817 |
<member name="unknown1" type="U16"/> |
818 |
<member name="unknown2" type="U16"/> |
819 |
</message> |
820 |
|
821 |
<message type="0004" name="login" src="server"> |
822 |
<member name="message" type="CONSTANT" value='login failed: wrong password'/> |
823 |
|
824 |
<member name="user" type="user"/> |
825 |
<member name="unknown1" type="U16"/> |
826 |
<member name="unknown2" type="U16"/> |
827 |
</message> |
828 |
|
829 |
<message type="0005" name="login" src="server"> |
830 |
<member name="message" type="CONSTANT" value='login failed: specified user does not exist'/> |
831 |
|
832 |
<member name="user" type="user"/> |
833 |
<member name="unknown1" type="U16"/> |
834 |
<member name="unknown2" type="U16"/> |
835 |
</message> |
836 |
|
837 |
<message type="0006" name="login" src="server"> |
838 |
<member name="message" type="CONSTANT" value='login failed: other user of same name already exists'/> |
839 |
|
840 |
<member name="user" type="user"/> |
841 |
<member name="unknown1" type="U16"/> |
842 |
<member name="unknown2" type="U16"/> |
843 |
</message> |
844 |
|
845 |
<message type="0008" name="userinfo" src="server"> |
846 |
User info. |
847 |
<member name="_unused0" type="flag"/> |
848 |
<member name="user" type="user"/> |
849 |
<member name="_unused1" type="U64"/> |
850 |
<member name="realname" type="realname"/> |
851 |
<member name="email" type="email"/> |
852 |
<member name="info" type="userinfo"/> |
853 |
<member name="homepage" type="url"/> |
854 |
<member name="regdate" type="timestamp"/> |
855 |
When the user registered (0 == never registered). |
856 |
<member name="lastlogin" type="timestamp"/> |
857 |
When the user logged in for the last time. |
858 |
<!-- maybe more? --> |
859 |
</message> |
860 |
|
861 |
<message type="0009" name="upd_userinfo_result" src="server"> |
862 |
<member name="name" type="username"/> |
863 |
<member name="message" type="CONSTANT" value='Thanks for registering.'/> |
864 |
</message> |
865 |
|
866 |
<message type="000a" name="upd_userinfo_result" src="server"> |
867 |
<member name="name" type="username"/> |
868 |
<member name="message" type="CONSTANT" value='The user "%s" has been successfully updated.'/> |
869 |
</message> |
870 |
|
871 |
<message type="000b" name="upd_userinfo_result" src="server"> |
872 |
<member name="name" type="username"/> |
873 |
<member name="message" type="CONSTANT" value='There is no user "%s". Update failed.'/> |
874 |
</message> |
875 |
|
876 |
<message type="0012" name="userinfo_failed" src="server"> |
877 |
<p>Sent when no userinfo for the requested user could be found(?)</p> |
878 |
<member name="name" type="username"/> |
879 |
</message> |
880 |
|
881 |
<message type="0013" name="msg_chat" src="server"> |
882 |
<member name="name" type="username"/> |
883 |
Name of sender (either yourself (echo) or other) |
884 |
<member name="name2" type="username"/> |
885 |
Name of recipient. |
886 |
<member name="message" type="STRING"/> |
887 |
</message> |
888 |
|
889 |
<message type="0015" name="stats" src="server"> |
890 |
<member name="ver_major" type="U16"/> |
891 |
<member name="ver_minor" type="U16"/> |
892 |
<member name="ver_micro" type="U16"/> |
893 |
<member name="boot_time" type="timestamp"/> |
894 |
<member name="users_cur" type="U32"/> |
895 |
<member name="users_max" type="U32"/> |
896 |
<member name="users_lim" type="U32"/> |
897 |
<member name="accts_cur" type="U32"/> |
898 |
<member name="accts_max" type="U32"/> |
899 |
<member name="unknown1" type="U32"/> |
900 |
<member name="work_max" type="U32"/> |
901 |
<member name="rooms_cur" type="U32"/> |
902 |
<member name="rooms_max" type="U32"/> |
903 |
<member name="rooms_lim" type="U32"/> |
904 |
<member name="games_cur" type="U32"/> |
905 |
<member name="games_max" type="U32"/> |
906 |
<member name="games_lim" type="U32"/> |
907 |
<member name="results_cur" type="U32"/> |
908 |
<member name="results_max" type="U32"/> |
909 |
<member name="unknown2" type="U32"/> |
910 |
<member name="params_cur" type="U32"/> |
911 |
<member name="params_max" type="U32"/> |
912 |
<member name="bytes_in" type="U64"/> |
913 |
<member name="packets_in" type="U64"/> |
914 |
<member name="bytes_out" type="U64"/> |
915 |
<member name="packets_out" type="U64"/> |
916 |
</message> |
917 |
|
918 |
<message type="0016" name="idle_warn" src="server"> |
919 |
<p>idle warning, autologout soon (10 minutes...). Responding with <ref ref="ping"/> usually helps.</p> |
920 |
</message> |
921 |
|
922 |
<message type="0018" name="login" src="server"> |
923 |
<member name="message" type="CONSTANT" value='logged out: another client logged in with your username'/> |
924 |
</message> |
925 |
|
926 |
<message type="001c" name="login" src="server"> |
927 |
<member name="message" type="CONSTANT" value='logged out: idle for too long'/> |
928 |
</message> |
929 |
|
930 |
<message type="0020" name="error" src="server"> |
931 |
<member name="message" type="CONSTANT" value='Sorry, you have too many unfinished games. You cannot turn on your rank. Please finish some of your games, then try again.'/> |
932 |
</message> |
933 |
|
934 |
<message type="0022" name="login" src="server"> |
935 |
I was blocked sooo many times for developing this client that it was |
936 |
easy to figure out. The KGS admins sure need no extra nazi training |
937 |
:( |
938 |
<member name="reason" type="STRING"/> |
939 |
<member name="result" type="CONSTANT" value='user or ip blocked'/> |
940 |
</message> |
941 |
|
942 |
<message type="001b" name="timewarning_default" src="server"> |
943 |
WILD guess |
944 |
<member name="channel" type="U16"/> |
945 |
<member name="time" type="U16"/> |
946 |
</message> |
947 |
|
948 |
<message type="001c" name="idle_err" src="server"> |
949 |
autologout |
950 |
</message> |
951 |
|
952 |
<message type="001d" name="ping" src="server"> |
953 |
Sent by the server regularly, but not answering them |
954 |
isn't valid. Strange form of keepalive? |
955 |
</message> |
956 |
|
957 |
<message type="001e" name="usergraph" src="server"> |
958 |
User graph data. |
959 |
<member name="name" type="username"/> |
960 |
<member name="data" type="I16" array="yes"/> |
961 |
If empty, no graph is available. The unit seems to |
962 |
be centi-kyu, with 1 dan == 0, 2 dan == 100, 1 kyu == -100. |
963 |
There is probably one entry per day, the newest one last. |
964 |
</message> |
965 |
|
966 |
<message type="0021" name="userpic" src="server"> |
967 |
<member name="name" type="username"/> |
968 |
Reply to pic_req, contains an image in jpeg format. |
969 |
<member name="data" type="DATA"/> |
970 |
</message> |
971 |
|
972 |
<message type="0025" name="memo_error" src="server"> |
973 |
<p>Account unknown.</p> |
974 |
<member name="name" type="username"/> |
975 |
<member name="cid" type="CLIENTID16"/> |
976 |
<member name="message" type="CONSTANT" value='memo send failed: account already exists'/> |
977 |
<member name="subtype" type="CONSTANT" value='25'/> |
978 |
</message> |
979 |
|
980 |
<message type="0026" name="memo_error" src="server"> |
981 |
<p>Just a guess.</p> |
982 |
<member name="name" type="username"/> |
983 |
<member name="cid" type="CLIENTID16"/> |
984 |
<member name="message" type="CONSTANT" value='memo send failed: error 26'/> |
985 |
<member name="subtype" type="CONSTANT" value='26'/> |
986 |
</message> |
987 |
|
988 |
<message type="0027" name="memo_error" src="server"> |
989 |
<p>User is currently online, please use chat.</p> |
990 |
<member name="name" type="username"/> |
991 |
<member name="cid" type="CLIENTID16"/> |
992 |
<member name="message" type="CONSTANT" value='memo send failed: user is online, use chat'/> |
993 |
<member name="subtype" type="CONSTANT" value='27'/> |
994 |
</message> |
995 |
|
996 |
<message type="0028" name="memo_error" src="server"> |
997 |
<p>Just a guess.</p> |
998 |
<member name="name" type="username"/> |
999 |
<member name="cid" type="CLIENTID16"/> |
1000 |
<member name="message" type="CONSTANT" value='memo send failed: error 28'/> |
1001 |
<member name="subtype" type="CONSTANT" value='28'/> |
1002 |
</message> |
1003 |
|
1004 |
<message type="0029" name="memo" src="server"> |
1005 |
<member name="name" type="username"/> |
1006 |
<member name="time" type="timestamp"/> |
1007 |
<member name="message" type="ZSTRING"/> |
1008 |
</message> |
1009 |
|
1010 |
<message type="002a" name="memo_sent" src="server"> |
1011 |
<p>The memo was sent successfully</p> |
1012 |
<member name="name" type="username"/> |
1013 |
<member name="cid" type="CLIENTID16"/> |
1014 |
</message> |
1015 |
|
1016 |
<message type="0100" name="gnotice" src="server"> |
1017 |
global notice, sent to everybody |
1018 |
<member name="notice" type="STRING"/> |
1019 |
</message> |
1020 |
|
1021 |
<message type="0202" name="notify_event" src="server"> |
1022 |
# maybe soe notify? Totally unclear. |
1023 |
# loc 0" type="userinfo, flags etc. loc 1 => gameinfo?, loc 2 => game result (more data) |
1024 |
<member name="event" type="U32"/> |
1025 |
<member name="user" type="user"/> |
1026 |
<member name="gamerecord" type="game_record" guard-member="event" guard-cond="== 2"/> |
1027 |
<p>Game result record?</p> |
1028 |
|
1029 |
</message> |
1030 |
|
1031 |
<message type="030c" name="login_done" src="server"> |
1032 |
<p>Is sent after the initial messages, probably |
1033 |
to signify the end of the login process.</p> |
1034 |
</message> |
1035 |
|
1036 |
<message type="0310" name="priv_room" src="server"> |
1037 |
"permission denied" when joining a room |
1038 |
<member name="name" type="STRING"/> |
1039 |
</message> |
1040 |
|
1041 |
<message type="0318" name="upd_rooms" src="server"> |
1042 |
<member name="rooms" type="room" array="yes"/> |
1043 |
</message> |
1044 |
|
1045 |
<message type="0411" name="chal_defaults" src="server"> |
1046 |
<member name="channel" type="U16"/> |
1047 |
<member name="defaults" type="challenge_defaults"/> |
1048 |
</message> |
1049 |
|
1050 |
<message type="0412" name="already_playing" src="server"> |
1051 |
Unable to create new game. |
1052 |
<member name="message" type="CONSTANT" value='Sorry, you are already playing in one game, so you can't start playing in another.'/> |
1053 |
<member name="cid" type="CLIENTID16"/> |
1054 |
<p>The cid of the new_game etc. request.</p> |
1055 |
</message> |
1056 |
|
1057 |
<message type="0414" name="game_record" src="server"> |
1058 |
The users game record. |
1059 |
<member name="name" type="username"/> |
1060 |
<member name="more" type="flag"/> |
1061 |
<p>Wether more games are available (must be requested manually by |
1062 |
another <ref reply="req_game_record"/> message with the timestamp set |
1063 |
to the timestamp of the <em>first</em> game of this packet.</p> |
1064 |
<member name="games" type="game_record" array="yes"/> |
1065 |
<p>Game records, from oldest to newest.</p> |
1066 |
</message> |
1067 |
|
1068 |
<message type="0417" name="error" src="server"> |
1069 |
<member name="message" type="CONSTANT" value='Sorry, your opponent is currently not logged in, so you can't resume this game.'/> |
1070 |
</message> |
1071 |
|
1072 |
<message type="0418" name="error" src="server"> |
1073 |
<member name="message" type="CONSTANT" value='Sorry, your opponent is already playing in a game, so you cannot continue this one.'/> |
1074 |
</message> |
1075 |
|
1076 |
<message type="0419" name="error" src="server"> |
1077 |
<member name="message" type="CONSTANT" value='Sorry, the server is out of boards! Please wait a few minutes and try to start a game again.'/> |
1078 |
</message> |
1079 |
|
1080 |
<message type="041c" name="upd_game2" src="server"> |
1081 |
Unclear. |
1082 |
<member name="channel_junk" type="U16"/> |
1083 |
<member name="game" type="game"/> |
1084 |
</message> |
1085 |
|
1086 |
<message type="041f" name="error" src="server"> |
1087 |
<member name="message" type="CONSTANT" value='Sorry, the game you tried to load was not correctly saved...probably caused by the server crashing. It cannot be recovered.'/> |
1088 |
</message> |
1089 |
|
1090 |
<message type="0420" name="error" src="server"> |
1091 |
<member name="message" type="CONSTANT" value='Sorry, user "%s" has left the game you are starting before you could challenge them. You will have to play against somebody else.'/> |
1092 |
</message> |
1093 |
|
1094 |
<message type="0421" name="error" src="server"> |
1095 |
<member name="message" type="CONSTANT" value='Sorry, this game is a private lesson. You will not be allowed to observe it.'/> |
1096 |
</message> |
1097 |
|
1098 |
<!-- added recently --> |
1099 |
<message type="043a" name="add_global_challenges" src="server"> |
1100 |
<p> |
1101 |
Adds or updates a global challenge (open game list). |
1102 |
</p> |
1103 |
<member name="games" type="room_game" array="yes"/> |
1104 |
<p>The game. The "moves" member contains a small number. Probably garbage.</p> |
1105 |
</message> |
1106 |
|
1107 |
<h3>Room messages</h3> |
1108 |
|
1109 |
<p>Not all room messages are for rooms only, and rooms need to parse |
1110 |
not only these messages. Orthogonality, what for?</p> |
1111 |
|
1112 |
<message type="4300" name="join_room" src="server"> |
1113 |
<member name="channel" type="U16"/> |
1114 |
<member name="users" type="user" array="yes"/> |
1115 |
</message> |
1116 |
|
1117 |
<message type="4301" name="msg_room" src="server"> |
1118 |
<member name="channel" type="U16"/> |
1119 |
<member name="name" type="username"/> |
1120 |
<member name="message" type="STRING"/> |
1121 |
</message> |
1122 |
|
1123 |
<message type="4302" name="part_room" src="server"> |
1124 |
<member name="channel" type="U16"/> |
1125 |
<member name="user" type="user"/> |
1126 |
</message> |
1127 |
|
1128 |
<message type="4303" name="del_room" src="server"> |
1129 |
<member name="channel" type="U16"/> |
1130 |
</message> |
1131 |
|
1132 |
<message type="4304" name="upd_games" src="server"> |
1133 |
<member name="channel" type="U16"/> |
1134 |
<member name="games" type="game" array="yes"/> |
1135 |
</message> |
1136 |
|
1137 |
<message type="4319" name="desc_room" src="server"> |
1138 |
<member name="channel" type="U16"/> |
1139 |
<member name="owner" type="username"/> |
1140 |
<member name="description" type="STRING"/> |
1141 |
</message> |
1142 |
|
1143 |
<h3>Game messages</h3> |
1144 |
|
1145 |
<message type="4400" name="challenge" src="server"> |
1146 |
Unclear. |
1147 |
<member name="channel" type="U16"/> |
1148 |
<member name="black" type="user"/> |
1149 |
<member name="white" type="user"/> |
1150 |
<member name="gametype" type="U8"/> |
1151 |
<member name="cid" type="CLIENTID8"/> |
1152 |
<p>Possibly an id. No idea. Better echo this from the challenge request.</p> |
1153 |
<member name="rules" type="rules"/> |
1154 |
<member name="notes" type="STRING"/> |
1155 |
<p>This field is optional</p> |
1156 |
</message> |
1157 |
|
1158 |
<message type="4401" name="upd_game" src="server"> |
1159 |
<member name="channel" type="U16"/> |
1160 |
<member name="game" type="game"/> |
1161 |
</message> |
1162 |
|
1163 |
<message type="4402" name="del_game" src="server"> |
1164 |
<member name="channel" type="U16"/> |
1165 |
</message> |
1166 |
|
1167 |
<message type="4403" name="upd_observers" src="server"> |
1168 |
<member name="channel" type="U16"/> |
1169 |
<member name="users" type="user" array="yes"/> |
1170 |
</message> |
1171 |
|
1172 |
<message type="4404" name="del_observer" src="server"> |
1173 |
<member name="channel" type="U16"/> |
1174 |
<member name="name" type="username"/> |
1175 |
</message> |
1176 |
|
1177 |
<message type="4405" name="set_tree" src="server"> |
1178 |
<member name="channel" type="U16"/> |
1179 |
<member name="tree" type="TREE"/> |
1180 |
</message> |
1181 |
|
1182 |
<message type="4406" name="upd_tree" src="server"> |
1183 |
<member name="channel" type="U16"/> |
1184 |
<member name="tree" type="TREE"/> |
1185 |
</message> |
1186 |
|
1187 |
<message type="4409" name="superko" src="server"> |
1188 |
Superko-warning. |
1189 |
<member name="channel" type="U16"/> |
1190 |
</message> |
1191 |
|
1192 |
<message type="440a" name="game_done" src="server"> |
1193 |
<p>Send by the server when one of the players sends a done.</p> |
1194 |
<member name="channel" type="U16"/> |
1195 |
<member name="id" type="U32"/> |
1196 |
<p>An id field to make sure that the client responds to the correct done click.</p> |
1197 |
<p>The high bit has the "please press done again" warning function, i.e. if set, opponent has changed board.</p> |
1198 |
<member name="black" type="flag"/> |
1199 |
<member name="white" type="flag"/> |
1200 |
</message> |
1201 |
|
1202 |
<message type="440b" name="final_result" src="server"> |
1203 |
<member name="channel" type="U16"/> |
1204 |
<member name="blackscore" type="scorevalues"/> |
1205 |
<member name="whitescore" type="scorevalues"/> |
1206 |
</message> |
1207 |
|
1208 |
<message type="440c" name="out_of_time" src="server"> |
1209 |
<p>Sent when the opponent is out of time and moves, or when the other |
1210 |
requests <ref reply="userinfo"/>.</p> |
1211 |
<member name="channel" type="U16"/> |
1212 |
<member name="player" type="U8"/> |
1213 |
<p>Colour who won the game.</p> |
1214 |
</message> |
1215 |
|
1216 |
<message type="440e" name="req_undo" src="server"> |
1217 |
<member name="channel" type="U16"/> |
1218 |
</message> |
1219 |
|
1220 |
<message type="4410" name="resign_game" src="server"> |
1221 |
<member name="channel" type="U16"/> |
1222 |
<member name="player" type="U8"/> |
1223 |
</message> |
1224 |
|
1225 |
<message type="4415" name="game_error" src="server"> |
1226 |
<member name="channel" type="U16"/> |
1227 |
<member name="message" type="CONSTANT" value='Sorry, this is a lecture game. Only authorized players are allowed to make comments.'/> |
1228 |
</message> |
1229 |
|
1230 |
<message type="441a" name="set_teacher" src="server"> |
1231 |
<member name="channel" type="U16"/> |
1232 |
<member name="name" type="username"/> |
1233 |
</message> |
1234 |
|
1235 |
<message type="441d" name="owner_left" src="server"> |
1236 |
<member name="channel" type="U16"/> |
1237 |
<member name="message" type="CONSTANT" value='Sorry, the owner of this game has left. Nobody will be allowed to edit it until the owner returns.'/> |
1238 |
</message> |
1239 |
|
1240 |
<message type="441e" name="teacher_left" src="server"> |
1241 |
Unclear. |
1242 |
<member name="channel" type="U16"/> |
1243 |
</message> |
1244 |
|
1245 |
<message type="4422" name="allow_user_result" src="server"> |
1246 |
<member name="message" type="CONSTANT" value='User "%s" will now be allowed full access to your game.'/> |
1247 |
<member name="channel" type="U16"/> |
1248 |
</message> |
1249 |
|
1250 |
<message type="4424" name="allow_user_result" src="server"> |
1251 |
<member name="message" type="CONSTANT" value='Sorry, user "%s" is a guest and cannot be allowed full access to your game.'/> |
1252 |
<member name="channel" type="U16"/> |
1253 |
</message> |
1254 |
|
1255 |
<message type="4425" name="allow_user_result" src="server"> |
1256 |
<member name="message" type="CONSTANT" value='Sorry, user "%s" does not seem to exist and cannot be allowed into your game.'/> |
1257 |
<member name="channel" type="U16"/> |
1258 |
</message> |
1259 |
|
1260 |
<message type="4428" name="add_tree" src="server"> |
1261 |
<p>See <ref ref="set_tree"/>. In addition, flags the tree as being |
1262 |
uploaded completely.</p> |
1263 |
<member name="channel" type="U16"/> |
1264 |
<member name="tree" type="TREE"/> |
1265 |
</message> |
1266 |
|
1267 |
<message type="4429" name="reject_challenge" src="server"> |
1268 |
Reject a challenge by a given user. Not checked. |
1269 |
<!-- should become a record type somehow... --> |
1270 |
|
1271 |
<member name="channel" type="U16"/> |
1272 |
<member name="name" type="username"/> |
1273 |
<member name="gametype" type="U8"/> |
1274 |
<member name="cid" type="CLIENTID8"/> |
1275 |
<p>Possibly an id. No idea. Better echo this from the challenge request.</p> |
1276 |
<member name="rules" type="rules"/> |
1277 |
</message> |
1278 |
|
1279 |
<message type="442b" name="set_comments" src="server"> |
1280 |
<p>Sent at end of games to set the comments not seen previously.</p> |
1281 |
<member name="channel" type="U16"/> |
1282 |
<member name="node" type="U32"/> |
1283 |
<member name="comments" type="STRING"/> |
1284 |
</message> |
1285 |
|
1286 |
<message type="442c" name="add_comments" src="server"> |
1287 |
<p>Sent at end of games to add all game commentary.</p> |
1288 |
<member name="channel" type="U16"/> |
1289 |
<member name="node" type="U32"/> |
1290 |
<member name="comments" type="STRING"/> |
1291 |
</message> |
1292 |
|
1293 |
<message type="442d" name="more_comments" src="server"> |
1294 |
<p>Quite brokenly, the server sends you this to make you ask for more comments. |
1295 |
Reply with <ref reply="more_comments"/>.</p> |
1296 |
<member name="channel" type="U16"/> |
1297 |
<member name="node" type="U32"/> |
1298 |
</message> |
1299 |
|
1300 |
<message type="442f" name="new_game" src="server"> |
1301 |
<p>Notifies the client that a new game has been created. This |
1302 |
message is sent long *after* upd_games and upd_observers etc. |
1303 |
have been received. *sigh*</p> |
1304 |
|
1305 |
<member name="channel" type="U16"/> |
1306 |
<p>The newly created game.</p> |
1307 |
<member name="cid" type="CLIENTID16"/> |
1308 |
<p>The ID sent to the server in new_game.</p> |
1309 |
</message> |
1310 |
|
1311 |
<message type="4433" name="req_result" src="server"> |
1312 |
Unclear. |
1313 |
<member name="channel" type="U16"/> |
1314 |
# # recv_result(?) |
1315 |
</message> |
1316 |
|
1317 |
<message type="4434" name="set_quiet" src="server"> |
1318 |
<p>Sets (or clears) the quiet flag on a game.</p> |
1319 |
<member name="channel" type="U16"/> |
1320 |
<member name="quiet" type="flag"/> |
1321 |
</message> |
1322 |
|
1323 |
<message type="4437" name="set_gametime" src="server"> |
1324 |
<p>Sent when joining a running game. Gives the remaining time + |
1325 |
periods/moves for the players, to correctly initialize the clocks.</p> |
1326 |
<member name="channel" type="U16"/> |
1327 |
<member name="black_time" type="time"/> |
1328 |
<member name="black_moves" type="U16"/> |
1329 |
<member name="white_time" type="time"/> |
1330 |
<member name="white_moves" type="U16"/> |
1331 |
</message> |
1332 |
|
1333 |
<message type="443b" name="del_global_challenge" src="server"> |
1334 |
<p> |
1335 |
Remove a game from the global challenge list (open game list). |
1336 |
</p> |
1337 |
<member name="channel" type="U16"/> |
1338 |
<p>The game id to remove.</p> |
1339 |
<member name="game" type="U16"/> |
1340 |
<p>Probably the same. I suggest to use this id for no good reason.</p> |
1341 |
</message> |
1342 |
</body> |
1343 |
</html> |
1344 |
|