Конфигурация

Основная конфигурация FlectonePulse, без которой невозможна работа

⚙️ Настройка

📂 Путь config.yml

⚖️ По умолчанию

console: "Console"
version: "1.5.1"
language: "en_us"
language-player: true
unregister-own-commands: false
metrics: true
bungeecord: false
velocity: false
clusters: []
fabric-disabled-commands:
  - "msg"
  - "kick"
  - "banlist"
  - "tell"
  - "w"
  - "me"
  - "pardon"
  - "ban"
log-filter:
  - "Paper Async Command Builder"
  - "Caught previously unhandled exception :"
  - "Error received from Telegram GetUpdates Request"
  - "OkHttp TaskRunner"
  - "Exception in thread \"ForkJoinPool"
  - "FlectonePulseDatabase - "
database:
  type: "SQLITE"
  name: "flectonepulse"
  host: "127.0.0.1"
  port: "3306"
  user: "root"
  password: "1234"
  parameters: "?autoReconnect=true&useSSL=false&useUnicode=true&characterEncoding=UTF-8"
module:
  enable: true
redis:
  enable: false
  host: "127.0.0.1"
  port: 6379
  ssl: false
  user: ""
  password: ""
editor:
  host: ""
  https: false
  port: 25566

console

Используется для отображения имени, когда сообщения создано консолью

version

Текущая версия плагина, используемая для корректного перехода между версиями плагина

ПРЕДУПРЕЖДЕНИЕ

Не изменяй версию плагина, если не знаешь, что делаешь!

language

Локализация, используемая для всех сообщений плагина

ПРЕДУПРЕЖДЕНИЕ

Выбираемая локализация должна быть из папки localizations

Можно создавать и использовать свои локализации, для этого:

1. Скопируй один файл локализации, например ru_ru.yml
2. Переименуй его, желательно так, как в игре
3. Теперь можно изменять любые сообщения внутри этого файла

ПРИМЕР

Я хочу перевести плагин на Беларуский

1. Копирую файл ru_ru.yml
2. Переименовываю его в be_by.yml
3. Готово!

language-player

Если включено, то у каждого игрока будет проверяться его локализация майнкрафта и взависимости от этого будет показываться сообщение

Если такой локализации нет, то будет использована из конфигурации

ОЧЕНЬ ВАЖНО ПОНИМАТЬ

Если ты изменяешь списки сообщений с включенным language-player, то это нужно делать во всех локализациях, иначе возможны визуальные ошибки

unregister-own-commands

Если включено, то FlectonePulse будет удалять и снова добавлять собственные команды при /flectonepulse reload. Это может вызывать просадки по tps и mspt из-за большого количество пакетов, поэтому лучше выключить эту настройку если вы сталкиваетесь с подобной проблемой.

Если выключено, то для корректного отключения комманды из FlectonePulse (в commands.yml) нужно будет перезагружать сервер.

ПРЕДУПРЕЖДЕНИЕ

Не рекомендуется включать на старых версиях майнкрафта, иначе могут быть ошибки/предупреждения в консоли от сервера, но они никак не влияют на работу плагина

metrics

Позволяет плагину собирать статистику сервера и параметров плагина

bungeecord

Включает связь с BungeeCord

ПРИМЕЧАНИЕ

Чтобы плагин работал на BungeeCord

1. Файл FlectonePulse.jar должен быть на КАЖДОМ сервере, включая BungeeCord, папка plugins
2. Выбранная датабаза должна быть MYSQL (т.е. серверная)

velocity

Включает связь с Velocity

ПРИМЕЧАНИЕ

Чтобы плагин работал на Velocity

1. Файл FlectonePulse.jar должен быть на КАЖДОМ сервере, включая Velocity, папка plugins
2. Выбранная датабаза должна быть MYSQL (т.е. серверная)

fabric-disabled-commands

Список команд не из FlectonePulse, которые должны быть отключены при старте Fabric сервера. Это даёт возможность заменять уже занятые команды на Fabric, например /me или /ban

clusters

Список кластеров, к которым должен быть подключён сервер. Используется только тогда, когда включен режим прокси. Если список пустой, то сервер получает все сообщения с других серверов

КАК ИСПОЛЬЗОВАТЬ?

Нужно вписать название кластера на серверах, где сообщение будет получено и отправлено

clusters: 
   - "test_cluster"

Так сервера связываются между собой и сообщения будут только между этими кластерами

log-filter

Идея взята отсюда, спасибо @Whitescan

Списком указываются сообщения, которые нужно не показывать, используя ключевые слова, встречающиеся в сообщении

НАПРИМЕР Я ХОЧУ ОТФИЛЬТРОВАТЬ

Значит нужно вписать: Unknown or incomplete command или command или Unknown

database

Можно использовать environment variables, например ${VALUE}

Настройка датабазы

type

В данный момент поддерживаются:

Вид	Объяснение
SQLite	Локальная, в виде файла
MySQL	Серверная, требуется подключение
H2	Локальная, в виде файла
PostgreSQL	Серверная, требуется подключение

name

Название базы данных

host

Адрес сервера, на котором расположена база данных

port

Порт подключения к базе данных на сервере

user

Название пользователя, который будет использован для подключения к базе данных

password

Пароль для подключения к базе данных

parameters

Параметры подключения к базе данных

module

Включает или выключает работу всех модулей

• Каждый модуль имеет родителя (тот, кто выше находится)

НАПРИМЕР

house:
  door:
  chair:

house является родителем для door и chair

• Каждый модуль зависит от enable родителя

НАПРИМЕР

house:
  enable: false
  door:
    enable: true
  chair:
    enable: true

house выключен, значит внезависимости от того, включены ли door и chair - они тоже будут выключены

redis

Используется в качестве коммуникаций между разными серверами. Для user и password можно использовать environment variables, например ${VALUE}

НАСТРОЙКА

enable

Включает работу Redis

host

Хост (айпи) сервера, на котором запущен Redis

port

Порт сервера, на котором запущен Redis

ssl

Включает использование SSL

user

Имя пользователя в Redis, если его нет, то можно оставить пустым

password

Пароль пользователя в Redis, если его нет, то можно оставить пустым

editor

Веб-редактирование для FlectonePulse. Backend сервер запускается тамже, где установлен FlectonePulse

НАСТРОЙКА

host

Хост (айпи) текущего сервера, можно указывать и домен

https

Включает работу https, вместо http

port

Незанятый порт текущего сервера