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

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

⚙️ Настройка

📂 Путь config.yml

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

console: "Console"
version: "0.5.4"
language: "en_us"
language-player: true
metrics: true
bungeecord: false
velocity: false
clusters: []
log-filter:
  - "Paper Async Command Builder"
  - "Caught previously unhandled exception :"
  - "Error received from Telegram GetUpdates Request"
  - "OkHttp TaskRunner"
database:
  type: SQLITE
  name: "flectonepulse"
  host: "localhost"
  port: "3306"
  user: "root"
  password: "1234"
  parameters: "?autoReconnect=true&useSSL=false&useUnicode=true&characterEncoding=UTF-8"
module:
  enable: true

console

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

version

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

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

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

language

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

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

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

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

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

Пример

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

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

language-player

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

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

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

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

metrics

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

bungeecord

ЧТОБЫ ПЛАГИН РАБОТАЛ НА BUNGEECORD:

1. Включи его здесь
2. Для BungeeCord сервера закинь файл FlectonePulse-bungee.jar в папку plugins
3. Перезапусти BungeeCord и сервера, где стоит FlectonePulse

velocity

ЧТОБЫ ПЛАГИН РАБОТАЛ НА VELOCITY:

1. Включи его здесь
2. Для Velocity сервера закинь файл FlectonePulse-velocity.jar в папку plugins
3. Перезапусти Velocity и сервера, где стоит FlectonePulse

clusters

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

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

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

clusters: 
   - "test_cluster"

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

log-filter

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

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

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

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

database

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

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

type

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

• SQLite - локальная
• MYSQL - серверная

name

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

host (для MySQL)

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

port (для MySQL)

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

user (для MySQL)

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

password (для MySQL)

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

parameters (для MySQL)

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

module

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

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

НАПРИМЕР

house:
  door:
  chair:

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

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

НАПРИМЕР

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

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