From 3be544eab2592a5374fab7563cac2b047c076e7a Mon Sep 17 00:00:00 2001 From: SantaSpeen Date: Mon, 10 Jul 2023 23:48:04 +0300 Subject: [PATCH] Add Russian --- docs/en/multilanguage/example.json | 45 +++++++++++++++++++++++++++ docs/en/multilanguage/readme.md | 0 docs/{ => en}/plugins/example.py | 0 docs/{ => en}/plugins/readme.md | 3 +- docs/en/readme.md | 8 +++++ docs/{ => en}/setup/readme.md | 0 docs/readme.md | 7 ++--- docs/ru/multilanguage/example.json | 45 +++++++++++++++++++++++++++ docs/ru/multilanguage/readme.md | 0 docs/ru/plugins/example.py | 36 ++++++++++++++++++++++ docs/ru/plugins/readme.md | 35 +++++++++++++++++++++ docs/ru/readme.md | 8 +++++ docs/ru/setup/readme.md | 49 ++++++++++++++++++++++++++++++ src/modules/i18n/files/ru.json | 47 +++++++++++++++++++++++++--- 14 files changed, 272 insertions(+), 11 deletions(-) create mode 100644 docs/en/multilanguage/example.json create mode 100644 docs/en/multilanguage/readme.md rename docs/{ => en}/plugins/example.py (100%) rename docs/{ => en}/plugins/readme.md (93%) create mode 100644 docs/en/readme.md rename docs/{ => en}/setup/readme.md (100%) create mode 100644 docs/ru/multilanguage/example.json create mode 100644 docs/ru/multilanguage/readme.md create mode 100644 docs/ru/plugins/example.py create mode 100644 docs/ru/plugins/readme.md create mode 100644 docs/ru/readme.md create mode 100644 docs/ru/setup/readme.md diff --git a/docs/en/multilanguage/example.json b/docs/en/multilanguage/example.json new file mode 100644 index 0000000..7447b66 --- /dev/null +++ b/docs/en/multilanguage/example.json @@ -0,0 +1,45 @@ +{ + "": "Basic phases", + "hello": "Hello from KuiToi-Server!", + "config_path": "Use {} for config.", + "init_ok": "Initializing ready.", + "start": "Server started!", + "stop": "Goodbye!", + + "": "Server auth", + "auth_need_key": "BEAM key needed for starting the server!", + "auth_empty_key": "Key is empty!", + "auth_cannot_open_browser": "Cannot open browser: {}", + "auth_use_link": "Use this link: {}", + + "": "GUI phases", + "GUI_yes": "Yes", + "GUI_no": "No", + "GUI_ok": "Ok", + "GUI_cancel": "Cancel", + "GUI_need_key_message": "BEAM key needed for starting the server!\nDo you need to open the web link to obtain the key?", + "GUI_enter_key_message": "Please type your key:", + "GUI_cannot_open_browser": "Cannot open browser.\nUse this link: {}", + + "": "Command: man", + "man_message_man": "man - display the manual page for COMMAND.\nUsage: man COMMAND", + "help_message_man": "Display the manual page for COMMAND.", + "man_for": "Manual for command", + "man_message_not_found": "man: Manual message not found.", + "man_command_not_found": "man: command \"{}\" not found!", + + "": "Command: help", + "man_message_help": "help - display names and brief descriptions of available commands.\nUsage: help [--raw]\nThe `help` command displays a list of all available commands along with a brief description of each command.", + "help_message_help": "Display names and brief descriptions of available commands", + "help_command": "Command", + "help_message": "Help message", + "help_message_not_found": "No help message found", + + "": "Command: stop", + "man_message_stop": "stop - Just shutting down the server.\nUsage: stop", + "help_message_stop": "Server shutdown.", + + "": "Command: exit", + "man_message_exit": "exit - Just shutting down the server.\nUsage: stop", + "help_message_exit": "Server shutdown." +} \ No newline at end of file diff --git a/docs/en/multilanguage/readme.md b/docs/en/multilanguage/readme.md new file mode 100644 index 0000000..e69de29 diff --git a/docs/plugins/example.py b/docs/en/plugins/example.py similarity index 100% rename from docs/plugins/example.py rename to docs/en/plugins/example.py diff --git a/docs/plugins/readme.md b/docs/en/plugins/readme.md similarity index 93% rename from docs/plugins/readme.md rename to docs/en/plugins/readme.md index b0dc1d3..cb39d1b 100644 --- a/docs/plugins/readme.md +++ b/docs/en/plugins/readme.md @@ -1,9 +1,8 @@ # Plugins System ## Install +###### (Lib can't ready to use) -[//]: # (TODO: BEAM LIB) -Lib can't ready to use * From pip:\ `$ pip install ...` * From source:\ diff --git a/docs/en/readme.md b/docs/en/readme.md new file mode 100644 index 0000000..777bacc --- /dev/null +++ b/docs/en/readme.md @@ -0,0 +1,8 @@ +# Documentation for KuiToi Server + +#### The documentation has not been perfected yet, but one day it will definitely happen + +1. Setup and Start server - [here](setup) +2. Plugins and Events system - [here](plugins) +3. MultiLanguage - [here](./multilanguage) +4. Something new diff --git a/docs/setup/readme.md b/docs/en/setup/readme.md similarity index 100% rename from docs/setup/readme.md rename to docs/en/setup/readme.md diff --git a/docs/readme.md b/docs/readme.md index f9cb45b..a9f4cb3 100644 --- a/docs/readme.md +++ b/docs/readme.md @@ -1,5 +1,4 @@ -# Documentation for KuiToi Server +# Choose your language -1. Setup and Start server - [here](./setup) -2. Plugins and Events system - [here](./plugins) -3. Something new +### [English](./en) +### [Русский](./ru) diff --git a/docs/ru/multilanguage/example.json b/docs/ru/multilanguage/example.json new file mode 100644 index 0000000..ffdb522 --- /dev/null +++ b/docs/ru/multilanguage/example.json @@ -0,0 +1,45 @@ +{ + "": "Basic phases", + "hello": "Привет из KuiToi-Server!", + "config_path": "Используя {} для настройки.", + "init_ok": "Инициализация окончена.", + "start": "Сервер запущен!", + "stop": "Сервер остановлен!", + + "": "Server auth", + "auth_need_key": "Нужен BEAMP ключ для запуска!", + "auth_empty_key": "BEAMP ключ пустой!", + "auth_cannot_open_browser": "Не получилось открыть браузер: {}", + "auth_use_link": "Используй эту ссылку: {}", + + "": "GUI phases", + "GUI_yes": "Да", + "GUI_no": "Нет", + "GUI_ok": "Окей", + "GUI_cancel": "Отмена", + "GUI_need_key_message": "Нужен BEAMP ключ для запуска!\nХотите открыть ссылку в браузере для получения ключа?", + "GUI_enter_key_message": "Пожалуйста введите ключ:", + "GUI_cannot_open_browser": "Не получилось открыть браузер.\nИспользуй эту ссылку: {}", + + "": "Command: man", + "man_message_man": "man - Показывает страничку помощи для COMMAND.\nИспользование: man COMMAND", + "help_message_man": "Показывает страничку помощи для COMMAND.", + "man_for": "Страничка помощи для", + "man_message_not_found": "man: Страничка помощи не найдена.", + "man_command_not_found": "man: Команда \"{}\" не найдена!", + + "": "Command: help", + "man_message_help": "help - Показывает названия и краткое описание команд.\nИспользование: help [--raw]\nКоманда `help` выводит список всех доступных команд, и краткое описание для каждой команды.", + "help_message_help": "Показывает названия и краткое описание команд", + "help_command": "Команда", + "help_message": "Текст", + "help_message_not_found": "Нет текста", + + "": "Command: stop", + "man_message_stop": "stop - Выключает сервер.\nИспользование: stop", + "help_message_stop": "Выключает сервер.", + + "": "Command: exit", + "man_message_exit": "exit - Выключает сервер.\nИспользование: exit", + "help_message_exit": "Выключает сервер." +} \ No newline at end of file diff --git a/docs/ru/multilanguage/readme.md b/docs/ru/multilanguage/readme.md new file mode 100644 index 0000000..e69de29 diff --git a/docs/ru/plugins/example.py b/docs/ru/plugins/example.py new file mode 100644 index 0000000..c7d60e0 --- /dev/null +++ b/docs/ru/plugins/example.py @@ -0,0 +1,36 @@ +import BEAMP # Import server object + +beam = BEAMP("TestPlugin") # Init plugin with name "TestPlugin" +log = beam.log # Use logger from server + + +def on_load(): + # When plugin initialization Server uses plugin.load() to load plugin. + # def load(): is really needed + log.info(beam.name) + + +# Events handlers + +def on_started(): + # Simple event handler + log.info("Server starting...") + + +# Simple event register +beam.register_event("on_started", on_started) + + +def any_func(data=None): + # Custom event handler + log.info(f"Data from any_func: {data}") + + +# Create custom event +beam.register_event("my_event", any_func) + +# Call custom event +beam.call_event("my_event") +beam.call_event("my_event", "Some data") +# This will be an error since any_func accepts only one argument at the input +beam.call_event("my_event", "Some data", "Some data1") diff --git a/docs/ru/plugins/readme.md b/docs/ru/plugins/readme.md new file mode 100644 index 0000000..ec99cd9 --- /dev/null +++ b/docs/ru/plugins/readme.md @@ -0,0 +1,35 @@ +# Система плагинов + +## Установка библиотеки с "Заглушками" +###### (Это значит, что не будет работать без сервера, но IDE подскажет API) +###### (Библиотека ещё в разработке) + +* Используя pip:\ + `$ pip install ...` +* Из исходников:\ + `git clone https://github.com/kuitoi/...` + +## Пример + +```python +import BEAMP + +beam = BEAMP("TestPlugin") +logger = beam.log + +def load(): # Plugins load from here + print(beam.name) + +def on_started(): + logger.info("Server starting...") + +beam.register_event("on_started", on_started) +``` + +Так же более обширный пример можно найти в [example.py](./example.py) + +* Базовые ивенты: ['on_started', 'on_auth, 'on_stop'] +* Создание своего ивента : `beam.register_event("my_event", my_event_function)` +* Вызов ивента: `beam.call_event("my_event")` +* Вызов ивента с данными: `beam.call_event("my_event", data, data2)` +* Вызовы с указанием переменой _**не поддерживаются**_: `beam.call_event("my_event", data=data)` diff --git a/docs/ru/readme.md b/docs/ru/readme.md new file mode 100644 index 0000000..7273c67 --- /dev/null +++ b/docs/ru/readme.md @@ -0,0 +1,8 @@ +# Документация для KuiToi Server + +### Документация ещё не доведена до совершенства, но однажды обязательно это случится + +1. Настройка и Запуск сервера - [тута](./setup) +2. Плагины и Ивент система - [тута](./plugins) +3. Мультиязычность - [тута](./multilanguage) +4. Тут будет что-то ново.... diff --git a/docs/ru/setup/readme.md b/docs/ru/setup/readme.md new file mode 100644 index 0000000..654b3a3 --- /dev/null +++ b/docs/ru/setup/readme.md @@ -0,0 +1,49 @@ +# Привет из KuiToi Server + +## Что ж, начнём + +###### _(Тут команды для linux)_ + +* Для запуска необходим **Python 3.10.x**! Именно этот, на Python 3.11 не запустится... +* Проверить версию твоего питончика(здесь надо смеяться) можно вот так: +```bash +python3 --version # Python 3.10.6 +``` +* Клонируем репозиторий и переходим в него +* Устанавливаем всё необходимое +* Далее, используя мой "скриптик" удаляем всё лишнее и перемещаемся к исходникам ядра +```bash +git clone -b Stable https://github.com/kuitoi/KuiToi-Server.git && cd KuiToi-Server +pip install -r requirements.txt +mv ./src/ $HOME/ktsrc/ && rm -rf ./* && mv $HOME/ktsrc/* . && rm -rf $HOME/ktsrc +``` +* Вот так можно глянуть инфу о сервер и запустить его:) +```bash +python3 main.py --help # Покажет все доступные команды +python3 main.py # Запустит сервер +``` + +## Настройка + +* После запуска создастся `kuitoi.yaml` +* По умолчанию он выглядит вот так: +```yaml +!!python/object:modules.ConfigProvider.config_provider.Config +Auth: + key: null + private: true +Game: + map: gridmap_v2 + max_cars: 1 + players: 8 +Server: + debug: false + description: This server uses KuiToi! + name: KuiToi-Server + server_ip: 0.0.0.0 + server_port: 30814 +``` +* Если поставить `private: false` и не установить `key`, то сервер запросит BEAMP ключ, без него не запустится. +* Введя BEAMP ключ сервер появится в списке лаунчера. +* Взять ключ можно тут: [https://beammp.com/k/keys](https://beammp.com/k/keys) + diff --git a/src/modules/i18n/files/ru.json b/src/modules/i18n/files/ru.json index 052224f..ffdb522 100644 --- a/src/modules/i18n/files/ru.json +++ b/src/modules/i18n/files/ru.json @@ -1,8 +1,45 @@ { + "": "Basic phases", "hello": "Привет из KuiToi-Server!", - "config_file": "Используй %s для настройки.", - "debug": "Начата новая сессия логирования с уровнем DEBUG!", - "config_info": "Конфиг сервера: %s", - "init": "Инициализация окончена.", - "ready": "Сервер запущен!" + "config_path": "Используя {} для настройки.", + "init_ok": "Инициализация окончена.", + "start": "Сервер запущен!", + "stop": "Сервер остановлен!", + + "": "Server auth", + "auth_need_key": "Нужен BEAMP ключ для запуска!", + "auth_empty_key": "BEAMP ключ пустой!", + "auth_cannot_open_browser": "Не получилось открыть браузер: {}", + "auth_use_link": "Используй эту ссылку: {}", + + "": "GUI phases", + "GUI_yes": "Да", + "GUI_no": "Нет", + "GUI_ok": "Окей", + "GUI_cancel": "Отмена", + "GUI_need_key_message": "Нужен BEAMP ключ для запуска!\nХотите открыть ссылку в браузере для получения ключа?", + "GUI_enter_key_message": "Пожалуйста введите ключ:", + "GUI_cannot_open_browser": "Не получилось открыть браузер.\nИспользуй эту ссылку: {}", + + "": "Command: man", + "man_message_man": "man - Показывает страничку помощи для COMMAND.\nИспользование: man COMMAND", + "help_message_man": "Показывает страничку помощи для COMMAND.", + "man_for": "Страничка помощи для", + "man_message_not_found": "man: Страничка помощи не найдена.", + "man_command_not_found": "man: Команда \"{}\" не найдена!", + + "": "Command: help", + "man_message_help": "help - Показывает названия и краткое описание команд.\nИспользование: help [--raw]\nКоманда `help` выводит список всех доступных команд, и краткое описание для каждой команды.", + "help_message_help": "Показывает названия и краткое описание команд", + "help_command": "Команда", + "help_message": "Текст", + "help_message_not_found": "Нет текста", + + "": "Command: stop", + "man_message_stop": "stop - Выключает сервер.\nИспользование: stop", + "help_message_stop": "Выключает сервер.", + + "": "Command: exit", + "man_message_exit": "exit - Выключает сервер.\nИспользование: exit", + "help_message_exit": "Выключает сервер." } \ No newline at end of file