Add Russian

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": "Выключает сервер."
+}

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")

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)`

docs/ru/readme.md

@@ -0,0 +1,8 @@
+# Документация для KuiToi Server
+
+### Документация ещё не доведена до совершенства, но однажды обязательно это случится
+
+1. Настройка и Запуск сервера - [тута](./setup)
+2. Плагины и Ивент система - [тута](./plugins)
+3. Мультиязычность - [тута](./multilanguage)
+4. Тут будет что-то ново....

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)
+