BaronessAuth DocumentationBaronessAuth

advanced.yml - Расширенные настройки

Расширенные настройки BaronessAuth

Файл advanced.yml

Продвинутые настройки BaronessAuth. Сюда попадают только небольшие настройки, которые некуда направить. Большая часть настроек находится в других файлах.

В отличие от general.yml, в этом файле перечислены настройки, которые редко меняют.

📋 Содержимое файла

# ┌────────────────────────────────
# │ Продвинутые настройки BaronessAuth.
# │ 
# │ Сюда попадают только небольшие настройки, которые некуда направить.
# │ Большая часть настроек находится в других файлах.
# │ 
# │ В отличие от general.yml, в этом файле перечислены настройки, которые редко меняют.
# └────────────────────────────────


# ┌────────────────────────────────
# │ Стандартные личные настройки игроков.
# └────────────────────────────────
default-player-parameters:
  # Включена ли у игроков 2FA (двухфакторка) по умолчанию?
  # После привязки у игрока сразу же начнёт работать 2FA, без доп. настроек.
  # Как правило, это должно быть true.
  2fa: true

  # Включены ли у игроков уведомления (от привязки) по умолчанию?
  notifications: true

# ┌────────────────────────────────
# │ Продвинутые настройки базы данных. Не трогайте без причины!
# └────────────────────────────────
database:
  connection-args: []
  table: 'ba_users'
  cache:
    enabled: true
    size: 10000
    expire-after: '30 мин'

# Устанавливать ли игрокам UUID из БД. Не трогайте без причины!
force-set-player-uuid: false

# Переключает лог "Status checking for server... failed".
log-server-ping-failures: true

# Как часто проверять сервера для балансировки?
update-servers-every: '10 сек'

# Отправлять ли игрока на мертвый сервер (не удаётся подтвердить его доступность),
# если другие варианты закончились?
send-to-dead-servers-if-no-choice: true

# Игрок будет кикнут с указанной причиной, если не удастся найти auth или lobby для него.
no-applicable-server-found-kick-reason: |-
  <red>Не получилось подобрать для вас сервер.
  Если проблема не решится в ближайшее время, обратитесь к администрации.

# Игрок будет кикнут с указанной причиной, если во время обработки его входа произошла ошибка.
join-processing-error-kick-reason: |-
  <red>Произошла ошибка при попытке обработать ваш вход со стороны системы аутентификации.
  Пожалуйста, повторите попытку входа через минуту.
  Если проблема сохраняется, обратитесь к администрации.

# Если BaronessAuth не удаётся подключить игрока к какому-то серверу, плагин кикает игрока с этой причиной.
# Также, в консоли появится лог с причиной, именами игрока и сервера.
server-connect-error-kick-reason: |-
  <red>Не удалось подключить вас к серверу <server>.
  Попробуйте подключиться через минуту.
  Если проблема сохраняется, обратитесь к администрации.

unknown-temporary-command: '<red>Это кликабельное сообщение устарело.'

# Позволяет изменить формат дат, отображаемых в разных местах.
# Как правило, это не стоит менять - тут нужно понимать специфику этих значений.
date-format:
  pattern: 'd MMM uuuu, HH:mm'
  locale: 'ru-RU'
  zone: 'Europe/Moscow'

geo-lite:
  unknown-country: 'неизвестная страна'
  unknown-city: 'неизвестный город'
  locales:
  - 'ru'
  - 'en'
  cache:
    maximum-size: 5000
    expire-after-access: '10 мин'

# Включает подробные логи (нужно только разработчикам).
debug: false

# Включает ОЧЕНЬ подробные логи (нужно только разработчикам).
trace: false

🔧 Основные секции

Default Player Parameters

Стандартные личные настройки игроков:

  • 2fa - включена ли двухфакторная аутентификация по умолчанию
  • notifications - включены ли уведомления по умолчанию

Database

Продвинутые настройки базы данных:

  • connection-args - дополнительные аргументы подключения
  • table - имя таблицы пользователей
  • cache - настройки кэширования

Серверные настройки

  • force-set-player-uuid - устанавливать ли UUID из БД
  • log-server-ping-failures - логировать неудачные пинги серверов
  • update-servers-every - частота проверки серверов
  • send-to-dead-servers-if-no-choice - отправлять на мертвые сервера

Сообщения об ошибках

  • no-applicable-server-found-kick-reason - причина кика при отсутствии серверов
  • join-processing-error-kick-reason - причина кика при ошибке обработки входа
  • server-connect-error-kick-reason - причина кика при ошибке подключения к серверу

Форматирование

  • date-format - формат отображения дат
  • geo-lite - настройки геолокации

Отладка

  • debug - подробные логи (только для разработчиков)
  • trace - очень подробные логи (только для разработчиков)

⚠️ Важно

  • Большинство настроек в этом файле не рекомендуется изменять без необходимости
  • Настройки debug и trace включайте только при отладке
  • Изменения в database могут повлиять на производительность