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