Update README.md

This commit is contained in:
Nikiroy78 2021-01-28 18:54:49 +03:00 committed by GitHub
parent b64b0f0e52
commit b96df139d9
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23

View File

@ -1 +1,34 @@
# saperGame
# Version 0.9 Beta
Тестовая версия для GNU Linux и OS Windows (x64).<br/>
Для запуска программы требуется **python 3.6+**!!!<br/>
В релизных версиях есть файл для запуска с консолью (для отладки) и стандартный файл<br/>
Код писался под **OS Windows x64**, однако, в теории код работает и с GNU Linux, однако, автор **не гарантирует** 100% работу под Linux.
## Советы для работы с ядром
**Не запускайте скомпилированное ядро!! это может привести к некорректной работе игры!!!**<br/>
Ниже приведён пример конфигурационного файла ядра.
```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
}
```
Подробнее читайте в документации.