Update docs

This commit is contained in:
2024-01-12 17:34:11 +03:00
parent 032f2bd06f
commit b41a4106ac

View File

@@ -4,44 +4,90 @@
## Что умеет:
### Команды
<p style="color: red">Не стесняйтесь, предлагайте свои идеи в issue, Vk, Telegram</p>
* Доступные разрешённым людям
* **.rcon <*commnd*>** - Исполняет <*commnd*> и отсылает ответ сервера
* **`.rcon <command>`** - Исполняет <*command*> и показывает ответ сервера
* Доступные всем
* **!help** - Выводит станичку с командами (Текст в файле help_message.txt)
* **!online** - Выводит rcon cmd *list*
* **`!help`** - Выводит страничку с командами (Текст в файле help_message.txt)
* **`!online`** - Запрашивает у сервера онлайн и выводит
* **`!id`** - Выводит ID пользователя, и его роль
### Возможности
## Система permissions
В файле permissions.json указаны все пользователи с "повышенным" уровнем доступа к боту
Пример
```json
{
"<role>": {
"allow": ["<command_1>", "<command_2>"],
"members": [123]
},
"helper": {
"allow": ["say", "warn"],
"members": [111, 432]
}
}
```
Если `"allow": true` - разрешены все команды
* Система [permissions](#система-permissions):
* Локально
* Интеграция с LuckPerms (В разработке)
## Как запустить?
1. Должен установлен быть Python3 (Если не установлен, не лезь, попроси друга айтишника помочь)
### Скачать скомпилированный вариант
* [Страница релизов](https://github.com/SantaSpeen/Rcon-VK-Bot/releases)
### Запуск напрямую
1. Должен быть установлен Python3.12 (**На версиях ниже не будет работать**)
2. Качаем репозиторий
3. `pip install -r requerements.txt` - Установка зависимостей
4. Лезем в `config.json` и настраиваем (ты же не глупый? Сам поймёшь что где:))
5. `python3 main.py` - Запускаем
3. `pip install -r requirements.txt` - Установка зависимостей
4. 1 Раз запускаем, что бы сгенерировалось всё что нужно
5. Лезем в `config.json`, `permissions.yml` и настраиваем
6. `python main.py` - Запускаем
_Всё очень легко и просто)_
## Система permissions
В файле permissions.yam указаны все пользователи с "повышенным" уровнем доступа к боту
Пример
```yaml
noRole: Нет роли
noRights: Нет прав # null для отключения
perms:
admins: # Имя группы
name: Админ # Имя группы, которое будет отображаться в боте
ids: # вк ИД входящих в состав группы
- 370926160
allow: # Какие команды разрешены, "*" - все
- '*'
# Пример настройки
helpers:
name: Хелпер
ids:
- 583018016
allow:
- say
- mute
- warn
# Находится в режиме тестирования
# Интеграция с базой данных LuckPerms (Нужна именно внешняя база данных)
useLuckPerms: false
LuckPerms:
# Смотрите настройку LuckPerms
server: global
# Разрешенные варианты: MySQL, MariaDB, PostgreSQL
storage-method: PostgreSQL
data:
# Указывайте host:port
address: 127.0.0.1:5432
# База данных в которой хранятся настройки LuckPerms
database: minecraftDB
# Логин и пароль для доступа к БД
username: user
password: user
# Смотрите настройку LuckPerms
table-prefix: luckperms_
```
LuckPerms
### За помощью, заказами и предложениями можно обратиться сюда:
1. _Telegramm_ [@id01234](https://t.me/id0124)
1. _Vk_ [@l.vindeta](https://vk.me/l.vindeta)
2. _Telegram_ [@id01234](https://t.me/id0124)
Мб что-нибудь ещё добавлю :)