ViewVC Help
View File | Revision Log | Show Annotations | Download File
/cvs/cvsroot/kgsueme/doc/protocol.xml
Revision: 1.58
Committed: Sat May 29 02:01:43 2004 UTC (22 years, 4 months ago) by pcg
Content type: text/xml
Branch: MAIN
Changes since 1.57: +67 -23 lines
Log Message:
*** empty log message ***

File Contents

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