FroggyMonitorReward/README.md

76 lines
3.7 KiB
Markdown
Raw Blame History

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

# FroggyMonitorReward
Плагин для награды игроков за голоса и отзывы на FroggyMonitor\
Он сам изменяет URL'ы для поощрения на мониторинге, самим не надо ничего делать\
Поддерживает PlaceholderAPI и Vault
[Скачать](https://github.com/MeexReay/FroggyMonitorReward/releases/latest)
## Конфиг
Конфигурационный файл плагина по умолчанию выглядит так
```yml
bind_host: 0.0.0.0 # Локальный IP адрес сервера (обычно такой же как и в server.properties)
bind_port: 8080 # Свободный порт для сайта (потребуется открыть его на хостинге)
external_host: example.com # Внешний IP адрес или домен сервера
secret_token: аш_секретный_токен" # Секретный токен с FroggyMonitor
vote: # Награда за голос
vault: 10 # Выдать валюту
item: "diamond 10" # Выдать предмет (забрать предмет нельзя)
message: "Спасибо за голос!" # Отправить сообщение
commands: # Исполнить команды
- "/title {player_name} subtitle на FroggyMonitor"
- "/title {player_name} title Спасибо за отзыв!"
as_player: # Исполнить команды или написать сообщение в чат от лица игрока
- "Я проголосовал за сервер и получил награду"
- "/me купит себе ламборгини на 10$ с награды"
# Каждый параметр наград не обязателен, но не должен использоваться больше 1 раза
# Указывать предмет вот так: "{название_предмета} {кол_во}"
add_comment: # Награда за добавление отзыва
vault: 10
message: "Спасибо за отзыв!"
# Тут могут использоваться все параметры из наград за голоса
del_comment: # Награда за удаление отзыва
vault: -10
# Тут могут использоваться все параметры из наград за голоса
enable_logs: true # Включить логи плагина (true/false); true - вкл; false - выкл
message_formatting: "ampersand" # Изменить тип форматирования сообщений
# Типы форматирования:
# ampersand: &cСообщение
# section: §cСообщение
# minimessage: <red>Сообщение</red>
# json: {"text": "Сообщение", "color": "red"}
```
## Права
```
froggy_monitor_reward.command.reload - Право на команду /reload
```
## Как это работает
```mermaid
sequenceDiagram
participant FroggyMonitor
participant Сервер
participant Сайт
participant Плагин
participant Vault
Сервер-->>Плагин: Запуск плагина
Плагин-->>Сайт: Запуск сайта
FroggyMonitor->>Сайт: Игрок проголосовал за сервер
Сайт->>Плагин: Голос игрока
Плагин->>Vault: Выдать валюту
Плагин->>Сервер: Выдать предмет
Плагин->>Сервер: Отправить сообщение
Плагин->>Сервер: Выполнить команды
```