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