первые страницы документации к протоколу

2020-08-19 04:00:19 +03:00
parent 2b125fe1a0
commit 36e9d0f68f
18 changed files with 513 additions and 59 deletions
--- a/src/docs/packets_serverside.rst
+++ b/src/docs/packets_serverside.rst
@@ -0,0 +1,75 @@
+От Сервера к Клиенту
+====================
+
+STATUS
+------
+
+StatusServerResponse
+^^^^^^^^^^^^^^^^^^^^
+
+Информация о Сервере.
+
+-------------+--------+-------------------------------------+
+| Поле        | Тип    | Коментарий                          |
+=============+========+=====================================+
+| Server info | String | Информация о сервере в JSON формате |
+-------------+--------+-------------------------------------+
+
+В поле *Server info* находится JSON объект следующего вида:
+
+.. code-block:: json
+
+    {
+      "version": {
+        "name": "1.8.7",
+        "protocol": 47
+      },
+      "players": {
+        "max": 20,
+        "online": 5,
+        "sample": [
+          {
+            "name": "Notch",
+            "id": "00000000-0000-0000-0000-000000000000"
+          }
+        ]
+      },
+      "description": {
+        "text": "Hello world"
+      },
+      "favicon": "data:image/png;base64,<data>"
+    }
+
+Подробнее: :download:`JSON Schema <_static/server_info.schema.json>`
+
+PingPacket
+^^^^^^^^^^
+.. _serverside_pingpacket:
+
+Пакет для обмена "пингом".
+
+---------+------+-------------+
+| Поле    | Тип  | Коментарий  |
+=========+======+=============+
+| Payload | Long | Любое число |
+---------+------+-------------+
+
+.. note::
+
+   | "Ванильный" сервер в *Payload* указывает текущее время в формате unixstamp.
+   | Но по факту в данное поле можно указать любое число: клиент всё равно обязан вернуть данный пакет "как есть".
+
+
+LOGIN
+-----
+
+DisconnectPacket
+^^^^^^^^^^^^^^^^
+
+Отключение клиента сервером с указанием причины.
+
+--------+------+----------------------------------+
+| Поле   | Тип  | Коментарий                       |
+========+======+==================================+
+| Reason | Text | Причина отключения. Опционально. |
+--------+------+----------------------------------+