From b96df139d9852cc6c4811f23ab1d186adf9a8c17 Mon Sep 17 00:00:00 2001 From: Nikiroy78 <35032449+Nikiroy78@users.noreply.github.com> Date: Thu, 28 Jan 2021 18:54:49 +0300 Subject: [PATCH] Update README.md --- README.md | 35 ++++++++++++++++++++++++++++++++++- 1 file changed, 34 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index b98246c..10a3436 100644 --- a/README.md +++ b/README.md @@ -1 +1,34 @@ -# saperGame \ No newline at end of file +# Version 0.9 Beta +Тестовая версия для GNU Linux и OS Windows (x64).
+Для запуска программы требуется **python 3.6+**!!!
+В релизных версиях есть файл для запуска с консолью (для отладки) и стандартный файл
+Код писался под **OS Windows x64**, однако, в теории код работает и с GNU Linux, однако, автор **не гарантирует** 100% работу под Linux. +## Советы для работы с ядром +**Не запускайте скомпилированное ядро!! это может привести к некорректной работе игры!!!**
+Ниже приведён пример конфигурационного файла ядра. +```json + { + "pythonRun": true, # Запуск ядра при помощи python + "pythonPath_win32": "python ", # Путь к python на OS Windows x64 + "pythonPath_unix": "python3 ", # Путь к python на GNU Linux + "max_responseTime": 15, # Время ожидания отклика ядра (сек) + "core_file": "gamecore.py", # Файл ядра + "log_enable": false # Включить логгирование + } +``` +## Методы ядра +Запросы принимаются через файл **gamestat.json** +```json +{ + "status": "method" # Метод + "request": [] # Тело запроса +} +``` +После выполнения запроса, ядро высылает ответ в файле **response.json** +```json +{ + "response": [] # Тело ответа + "response_randomID": [] # random ID +} +``` +Подробнее читайте в документации.