… | |
… | |
19 | Foundation, Inc. 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA |
19 | Foundation, Inc. 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA |
20 | --> |
20 | --> |
21 | </head> |
21 | </head> |
22 | <body> |
22 | <body> |
23 | |
23 | |
24 | <h1>$Revision: 1.32 $</h1> |
24 | <h1>$Revision: 1.33 $</h1> |
25 | |
25 | |
26 | <h1>KGS Protocol Description</h1> |
26 | <h1>KGS Protocol Description</h1> |
27 | |
27 | |
28 | <p>This XML document describes the KGS protocol. It is also used |
28 | <p>This XML document describes the KGS protocol. It is also used |
29 | to automatically generate the perl parser for all the messages and |
29 | to automatically generate the perl parser for all the messages and |
30 | structures in the protocol. Adapting it to other languages should be |
30 | structures in the protocol. Adapting it to other languages should be |
31 | trivial.</p> |
31 | almost trivial.</p> |
32 | |
32 | |
33 | <p> |
33 | <p> |
34 | <b>Please note that the author of KGS has told me that he will |
34 | <b>Please note that the author of KGS has told me that he will |
35 | change the protocol in response to my efforts. No problems with |
35 | change the protocol in response to my efforts. No problems with |
36 | changing the protocol for good, but he does this just to make it |
36 | changing the protocol for good, but he does this just to make it |
… | |
… | |
951 | </td> |
951 | </td> |
952 | </tr> |
952 | </tr> |
953 | </table> |
953 | </table> |
954 | |
954 | |
955 | <h4> |
955 | <h4> |
|
|
956 | <a name="C0200"></a>ORIGIN: CLIENT; |
|
|
957 | MESSAGE: notify_add</h4> |
|
|
958 | NUMERIC TYPE (hex): 0200<p> |
|
|
959 | |
|
|
960 | <p>Probably setting a notifier on a username, to get informed about |
|
|
961 | changes using messages. ???</p> |
|
|
962 | </p> |
|
|
963 | <table border="1" width="100%"> |
|
|
964 | <tr> |
|
|
965 | <th width="10%">NAME</th> |
|
|
966 | <th width="10%">TYPE</th> |
|
|
967 | <th width="15%">DEFAULT</th> |
|
|
968 | <th>DESCRIPTION</th> |
|
|
969 | <th width="15%">DEC-GUARD</th> |
|
|
970 | </tr> |
|
|
971 | <tr> |
|
|
972 | <td>name</td> |
|
|
973 | <td>username</td> |
|
|
974 | <td> </td> |
|
|
975 | <td> |
|
|
976 | |
|
|
977 | |
|
|
978 | </td> |
|
|
979 | <td> |
|
|
980 | <b></b> |
|
|
981 | |
|
|
982 | </td> |
|
|
983 | </tr> |
|
|
984 | </table> |
|
|
985 | |
|
|
986 | <h4> |
|
|
987 | <a name="C0201"></a>ORIGIN: CLIENT; |
|
|
988 | MESSAGE: notify_del</h4> |
|
|
989 | NUMERIC TYPE (hex): 0201<p> |
|
|
990 | |
|
|
991 | <p>Probably remove the notifier again.</p> |
|
|
992 | </p> |
|
|
993 | <table border="1" width="100%"> |
|
|
994 | <tr> |
|
|
995 | <th width="10%">NAME</th> |
|
|
996 | <th width="10%">TYPE</th> |
|
|
997 | <th width="15%">DEFAULT</th> |
|
|
998 | <th>DESCRIPTION</th> |
|
|
999 | <th width="15%">DEC-GUARD</th> |
|
|
1000 | </tr> |
|
|
1001 | <tr> |
|
|
1002 | <td>name</td> |
|
|
1003 | <td>username</td> |
|
|
1004 | <td> </td> |
|
|
1005 | <td> |
|
|
1006 | |
|
|
1007 | |
|
|
1008 | </td> |
|
|
1009 | <td> |
|
|
1010 | <b></b> |
|
|
1011 | |
|
|
1012 | </td> |
|
|
1013 | </tr> |
|
|
1014 | </table> |
|
|
1015 | |
|
|
1016 | <h4> |
956 | <a name="C0318"></a>ORIGIN: CLIENT; |
1017 | <a name="C0318"></a>ORIGIN: CLIENT; |
957 | MESSAGE: list_rooms</h4> |
1018 | MESSAGE: list_rooms</h4> |
958 | NUMERIC TYPE (hex): 0318<p> |
1019 | NUMERIC TYPE (hex): 0318<p> |
959 | <p>List the rooms in a specific group/category. Results in a <a href="#S0318">upd_rooms(0318)</a> message.</p> |
1020 | <p>List the rooms in a specific group/category. Results in a <a href="#S0318">upd_rooms(0318)</a> message.</p> |
960 | </p> |
1021 | </p> |
… | |
… | |
3066 | <th width="15%">DEFAULT</th> |
3127 | <th width="15%">DEFAULT</th> |
3067 | <th>DESCRIPTION</th> |
3128 | <th>DESCRIPTION</th> |
3068 | <th width="15%">DEC-GUARD</th> |
3129 | <th width="15%">DEC-GUARD</th> |
3069 | </tr> |
3130 | </tr> |
3070 | <tr> |
3131 | <tr> |
|
|
3132 | <td>_unused0</td> |
|
|
3133 | <td>flag</td> |
|
|
3134 | <td> </td> |
|
|
3135 | <td> |
|
|
3136 | |
|
|
3137 | |
|
|
3138 | </td> |
|
|
3139 | <td> |
|
|
3140 | <b></b> |
|
|
3141 | |
|
|
3142 | </td> |
|
|
3143 | </tr> |
|
|
3144 | <tr> |
3071 | <td>user</td> |
3145 | <td>user</td> |
3072 | <td>user</td> |
3146 | <td>user</td> |
3073 | <td> </td> |
3147 | <td> </td> |
3074 | <td> |
3148 | <td> |
3075 | |
3149 | |
… | |
… | |
3079 | <b></b> |
3153 | <b></b> |
3080 | |
3154 | |
3081 | </td> |
3155 | </td> |
3082 | </tr> |
3156 | </tr> |
3083 | <tr> |
3157 | <tr> |
3084 | <td>_unused</td> |
3158 | <td>_unused1</td> |
3085 | <td>U64</td> |
3159 | <td>U64</td> |
3086 | <td> </td> |
3160 | <td> </td> |
3087 | <td> |
3161 | <td> |
3088 | |
3162 | |
3089 | |
3163 | |
… | |
… | |
3783 | <th width="15%">DEFAULT</th> |
3857 | <th width="15%">DEFAULT</th> |
3784 | <th>DESCRIPTION</th> |
3858 | <th>DESCRIPTION</th> |
3785 | <th width="15%">DEC-GUARD</th> |
3859 | <th width="15%">DEC-GUARD</th> |
3786 | </tr> |
3860 | </tr> |
3787 | <tr> |
3861 | <tr> |
|
|
3862 | <td>name</td> |
|
|
3863 | <td>username</td> |
|
|
3864 | <td> </td> |
|
|
3865 | <td> |
|
|
3866 | |
|
|
3867 | |
|
|
3868 | </td> |
|
|
3869 | <td> |
|
|
3870 | <b></b> |
|
|
3871 | |
|
|
3872 | </td> |
|
|
3873 | </tr> |
|
|
3874 | <tr> |
3788 | <td>data</td> |
3875 | <td>data</td> |
3789 | <td>I16</td> |
3876 | <td>I16</td> |
3790 | <td> </td> |
3877 | <td> </td> |
3791 | <td> |
3878 | <td> |
3792 | If empty, no graph is available. The unit seems to |
3879 | If empty, no graph is available. The unit seems to |
… | |
… | |
3980 | </tr> |
4067 | </tr> |
3981 | </table> |
4068 | </table> |
3982 | |
4069 | |
3983 | <h4> |
4070 | <h4> |
3984 | <a name="S0202"></a>ORIGIN: SERVER; |
4071 | <a name="S0202"></a>ORIGIN: SERVER; |
3985 | MESSAGE: upd_user</h4> |
4072 | MESSAGE: notify_event</h4> |
3986 | NUMERIC TYPE (hex): 0202<p> |
4073 | NUMERIC TYPE (hex): 0202<p> |
3987 | # maybe soe notify? Totally unclear. |
4074 | # maybe soe notify? Totally unclear. |
3988 | # loc 0" type="chat(?) loc 1 => gameinfo?, loc 2 => game result (more data) |
4075 | # loc 0" type="chat(?) loc 1 => gameinfo?, loc 2 => game result (more data) |
3989 | </p> |
4076 | </p> |
3990 | <table border="1" width="100%"> |
4077 | <table border="1" width="100%"> |
… | |
… | |
3994 | <th width="15%">DEFAULT</th> |
4081 | <th width="15%">DEFAULT</th> |
3995 | <th>DESCRIPTION</th> |
4082 | <th>DESCRIPTION</th> |
3996 | <th width="15%">DEC-GUARD</th> |
4083 | <th width="15%">DEC-GUARD</th> |
3997 | </tr> |
4084 | </tr> |
3998 | <tr> |
4085 | <tr> |
3999 | <td>location</td> |
4086 | <td>event</td> |
4000 | <td>U32</td> |
4087 | <td>U32</td> |
4001 | <td> </td> |
4088 | <td> </td> |
4002 | <td> |
4089 | <td> |
4003 | |
4090 | |
4004 | |
4091 | |
… | |
… | |
4021 | |
4108 | |
4022 | </td> |
4109 | </td> |
4023 | </tr> |
4110 | </tr> |
4024 | <tr> |
4111 | <tr> |
4025 | <td>lotsofinfo</td> |
4112 | <td>lotsofinfo</td> |
|
|
4113 | <td>game_record</td> |
4026 | <td>DATA</td> |
4114 | <td> </td> |
4027 | <td> </td> |
|
|
4028 | <td> |
|
|
4029 | |
|
|
4030 | |
|
|
4031 | </td> |
4115 | <td> |
|
|
4116 | |
|
|
4117 | |
4032 | <td> |
4118 | </td> |
|
|
4119 | <td> |
4033 | <b>location</b> == 2 |
4120 | <b>event</b> == 2 |
4034 | |
4121 | |
4035 | </td> |
4122 | </td> |
4036 | </tr> |
4123 | </tr> |
4037 | </table> |
4124 | </table> |
4038 | |
4125 | |