| … | |
… | |
| 20 | Foundation, Inc. 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA |
20 | Foundation, Inc. 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA |
| 21 | --> |
21 | --> |
| 22 | </head> |
22 | </head> |
| 23 | <body> |
23 | <body> |
| 24 | |
24 | |
| 25 | <h1>$Revision: 1.62 $</h1> |
25 | <h1>$Revision: 1.63 $</h1> |
| 26 | |
26 | |
| 27 | <h1>KGS Protocol Description</h1> |
27 | <h1>KGS Protocol Description</h1> |
| 28 | |
28 | |
| 29 | <p>This XML document describes the KGS protocol. It is also used |
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 |
30 | to automatically generate the perl parser for all the messages and |
| … | |
… | |
| 754 | <tr> |
754 | <tr> |
| 755 | <td>WHITE</td> |
755 | <td>WHITE</td> |
| 756 | <td></td> |
756 | <td></td> |
| 757 | <td>1 </td> |
757 | <td>1 </td> |
| 758 | <td> |
758 | <td> |
| 759 | |
759 | |
|
|
760 | |
|
|
761 | </td> |
|
|
762 | <td> |
|
|
763 | <b></b> |
|
|
764 | |
|
|
765 | </td> |
|
|
766 | </tr> |
|
|
767 | <tr> |
|
|
768 | <td>NONE</td> |
|
|
769 | <td></td> |
|
|
770 | <td>2 </td> |
|
|
771 | <td> |
|
|
772 | |
| 760 | |
773 | |
| 761 | </td> |
774 | </td> |
| 762 | <td> |
775 | <td> |
| 763 | <b></b> |
776 | <b></b> |
| 764 | |
777 | |
| … | |
… | |
| 2550 | </td> |
2563 | </td> |
| 2551 | </tr> |
2564 | </tr> |
| 2552 | </table> |
2565 | </table> |
| 2553 | |
2566 | |
| 2554 | <h4> |
2567 | <h4> |
| 2555 | <a name="C4408"></a>ORIGIN: CLIENT; |
2568 | <a name="C440a"></a>ORIGIN: CLIENT; |
| 2556 | MESSAGE: get_tree</h4> |
2569 | MESSAGE: game_done</h4> |
| 2557 | NUMERIC TYPE (hex): 4408<p> |
2570 | NUMERIC TYPE (hex): 440a<p> |
| 2558 | Request the game tree starting at a given node. This is used |
2571 | <p>Sent by the client to mark the game as done.</p> |
| 2559 | when the server only sends a partial tree (with end code "more"). |
|
|
| 2560 | </p> |
2572 | </p> |
| 2561 | <table border="1" width="100%"> |
2573 | <table border="1" width="100%"> |
| 2562 | <tr> |
2574 | <tr> |
| 2563 | <th width="10%">NAME</th> |
2575 | <th width="10%">NAME</th> |
| 2564 | <th width="8%">TYPE</th> |
2576 | <th width="8%">TYPE</th> |
| 2565 | <th width="4%">VALUE</th> |
2577 | <th width="4%">VALUE</th> |
| … | |
… | |
| 2578 | <b></b> |
2590 | <b></b> |
| 2579 | |
2591 | |
| 2580 | </td> |
2592 | </td> |
| 2581 | </tr> |
2593 | </tr> |
| 2582 | <tr> |
2594 | <tr> |
| 2583 | <td>node</td> |
2595 | <td>id</td> |
| 2584 | <td>U32</td> |
2596 | <td>U32</td> |
| 2585 | <td> </td> |
2597 | <td> </td> |
| 2586 | <td> |
2598 | <td> |
| 2587 | |
2599 | |
| 2588 | |
2600 | |
| 2589 | </td> |
2601 | </td> |
| 2590 | <td> |
2602 | <td> |
| 2591 | <b></b> |
2603 | <b></b> |
| 2592 | |
2604 | |
| … | |
… | |
| 6789 | </td> |
6801 | </td> |
| 6790 | </tr> |
6802 | </tr> |
| 6791 | </table> |
6803 | </table> |
| 6792 | |
6804 | |
| 6793 | <h4> |
6805 | <h4> |
|
|
6806 | <a name="S440a"></a>ORIGIN: SERVER; |
|
|
6807 | MESSAGE: game_done</h4> |
|
|
6808 | NUMERIC TYPE (hex): 440a<p> |
|
|
6809 | <p>Send by the server when one of the players sends a done.</p> |
|
|
6810 | </p> |
|
|
6811 | <table border="1" width="100%"> |
|
|
6812 | <tr> |
|
|
6813 | <th width="10%">NAME</th> |
|
|
6814 | <th width="8%">TYPE</th> |
|
|
6815 | <th width="4%">VALUE</th> |
|
|
6816 | <th>DESCRIPTION</th> |
|
|
6817 | <th width="10%">GUARD</th> |
|
|
6818 | </tr> |
|
|
6819 | <tr> |
|
|
6820 | <td>channel</td> |
|
|
6821 | <td>U16</td> |
|
|
6822 | <td> </td> |
|
|
6823 | <td> |
|
|
6824 | |
|
|
6825 | |
|
|
6826 | </td> |
|
|
6827 | <td> |
|
|
6828 | <b></b> |
|
|
6829 | |
|
|
6830 | </td> |
|
|
6831 | </tr> |
|
|
6832 | <tr> |
|
|
6833 | <td>id</td> |
|
|
6834 | <td>U32</td> |
|
|
6835 | <td> </td> |
|
|
6836 | <td> |
|
|
6837 | |
|
|
6838 | |
|
|
6839 | </td> |
|
|
6840 | <td> |
|
|
6841 | <b></b> |
|
|
6842 | |
|
|
6843 | </td> |
|
|
6844 | </tr> |
|
|
6845 | <tr> |
|
|
6846 | <td>black</td> |
|
|
6847 | <td>flag</td> |
|
|
6848 | <td> </td> |
|
|
6849 | <td> |
|
|
6850 | |
|
|
6851 | |
|
|
6852 | </td> |
|
|
6853 | <td> |
|
|
6854 | <b></b> |
|
|
6855 | |
|
|
6856 | </td> |
|
|
6857 | </tr> |
|
|
6858 | <tr> |
|
|
6859 | <td>white</td> |
|
|
6860 | <td>flag</td> |
|
|
6861 | <td> </td> |
|
|
6862 | <td> |
|
|
6863 | |
|
|
6864 | |
|
|
6865 | </td> |
|
|
6866 | <td> |
|
|
6867 | <b></b> |
|
|
6868 | |
|
|
6869 | </td> |
|
|
6870 | </tr> |
|
|
6871 | </table> |
|
|
6872 | |
|
|
6873 | <h4> |
| 6794 | <a name="S440b"></a>ORIGIN: SERVER; |
6874 | <a name="S440b"></a>ORIGIN: SERVER; |
| 6795 | MESSAGE: final_result</h4> |
6875 | MESSAGE: final_result</h4> |
| 6796 | NUMERIC TYPE (hex): 440b<p> |
6876 | NUMERIC TYPE (hex): 440b<p> |
| 6797 | </p> |
6877 | </p> |
| 6798 | <table border="1" width="100%"> |
6878 | <table border="1" width="100%"> |
| … | |
… | |
| 7341 | </td> |
7421 | </td> |
| 7342 | </tr> |
7422 | </tr> |
| 7343 | <tr> |
7423 | <tr> |
| 7344 | <td>rules</td> |
7424 | <td>rules</td> |
| 7345 | <td>rules</td> |
7425 | <td>rules</td> |
|
|
7426 | <td> </td> |
|
|
7427 | <td> |
|
|
7428 | |
|
|
7429 | |
|
|
7430 | </td> |
|
|
7431 | <td> |
|
|
7432 | <b></b> |
|
|
7433 | |
|
|
7434 | </td> |
|
|
7435 | </tr> |
|
|
7436 | </table> |
|
|
7437 | |
|
|
7438 | <h4> |
|
|
7439 | <a name="S442b"></a>ORIGIN: SERVER; |
|
|
7440 | MESSAGE: set_comments</h4> |
|
|
7441 | NUMERIC TYPE (hex): 442b<p> |
|
|
7442 | <p>Sent at end of games to set the comments not seen previously.</p> |
|
|
7443 | </p> |
|
|
7444 | <table border="1" width="100%"> |
|
|
7445 | <tr> |
|
|
7446 | <th width="10%">NAME</th> |
|
|
7447 | <th width="8%">TYPE</th> |
|
|
7448 | <th width="4%">VALUE</th> |
|
|
7449 | <th>DESCRIPTION</th> |
|
|
7450 | <th width="10%">GUARD</th> |
|
|
7451 | </tr> |
|
|
7452 | <tr> |
|
|
7453 | <td>channel</td> |
|
|
7454 | <td>U16</td> |
|
|
7455 | <td> </td> |
|
|
7456 | <td> |
|
|
7457 | |
|
|
7458 | |
|
|
7459 | </td> |
|
|
7460 | <td> |
|
|
7461 | <b></b> |
|
|
7462 | |
|
|
7463 | </td> |
|
|
7464 | </tr> |
|
|
7465 | <tr> |
|
|
7466 | <td>node</td> |
|
|
7467 | <td>U32</td> |
|
|
7468 | <td> </td> |
|
|
7469 | <td> |
|
|
7470 | |
|
|
7471 | |
|
|
7472 | </td> |
|
|
7473 | <td> |
|
|
7474 | <b></b> |
|
|
7475 | |
|
|
7476 | </td> |
|
|
7477 | </tr> |
|
|
7478 | <tr> |
|
|
7479 | <td>comments</td> |
|
|
7480 | <td>STRING</td> |
|
|
7481 | <td> </td> |
|
|
7482 | <td> |
|
|
7483 | |
|
|
7484 | |
|
|
7485 | </td> |
|
|
7486 | <td> |
|
|
7487 | <b></b> |
|
|
7488 | |
|
|
7489 | </td> |
|
|
7490 | </tr> |
|
|
7491 | </table> |
|
|
7492 | |
|
|
7493 | <h4> |
|
|
7494 | <a name="S442c"></a>ORIGIN: SERVER; |
|
|
7495 | MESSAGE: add_comments</h4> |
|
|
7496 | NUMERIC TYPE (hex): 442c<p> |
|
|
7497 | <p>Sent at end of games to add all game commentary.</p> |
|
|
7498 | </p> |
|
|
7499 | <table border="1" width="100%"> |
|
|
7500 | <tr> |
|
|
7501 | <th width="10%">NAME</th> |
|
|
7502 | <th width="8%">TYPE</th> |
|
|
7503 | <th width="4%">VALUE</th> |
|
|
7504 | <th>DESCRIPTION</th> |
|
|
7505 | <th width="10%">GUARD</th> |
|
|
7506 | </tr> |
|
|
7507 | <tr> |
|
|
7508 | <td>channel</td> |
|
|
7509 | <td>U16</td> |
|
|
7510 | <td> </td> |
|
|
7511 | <td> |
|
|
7512 | |
|
|
7513 | |
|
|
7514 | </td> |
|
|
7515 | <td> |
|
|
7516 | <b></b> |
|
|
7517 | |
|
|
7518 | </td> |
|
|
7519 | </tr> |
|
|
7520 | <tr> |
|
|
7521 | <td>node</td> |
|
|
7522 | <td>U32</td> |
|
|
7523 | <td> </td> |
|
|
7524 | <td> |
|
|
7525 | |
|
|
7526 | |
|
|
7527 | </td> |
|
|
7528 | <td> |
|
|
7529 | <b></b> |
|
|
7530 | |
|
|
7531 | </td> |
|
|
7532 | </tr> |
|
|
7533 | <tr> |
|
|
7534 | <td>comments</td> |
|
|
7535 | <td>STRING</td> |
| 7346 | <td> </td> |
7536 | <td> </td> |
| 7347 | <td> |
7537 | <td> |
| 7348 | |
7538 | |
| 7349 | |
7539 | |
| 7350 | </td> |
7540 | </td> |
