BaronessAuth DocumentationBaronessAuth

password.yml - Настройки парольной аутентификации

Настройки парольной аутентификации в BaronessAuth

Файл password.yml

Путь: content/BaronessAuth/config/methods/password.yml

Настройки самого типичного способа аутентификации — по паролю. Здесь всё, что касается /register и /login.

Этот способ — единственный, что позволяет зарегистрироваться. Отключив его, вы запретите незарегистрированным игрокам заходить на сервер.

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

# ┌────────────────────────────────
# │ Настройки самого типичного способа аутентификации — по паролю.
# │ Здесь всё, что касается /register и /login.
# │ 
# │ Этот способ — единственный, что позволяет зарегистрироваться.
# │ Отключив его, вы запретите незарегистрированным игрокам заходить на сервер.
# └────────────────────────────────

enabled: true

# Человеческое название этого способа, чтобы в редких случаях показать игрокам.
display-name: 'пароль'

# ┌────────────────────────────────
# │ Настройки регистрации.
# └────────────────────────────────
registration:
  # ┌────────────────────────────────
  # │ Команда /register [пароль] [отключаемо: повтор пароля].
  # └────────────────────────────────
  command:
    aliases:
    - 'register'
    - 'reg'
    cooldown: '1 сек 200 мсек'
    arguments:
      password: 'пароль'
      password-repeat: 'повтор пароля'
      password-repeat-required: true

  # ┌────────────────────────────────
  # │ Настройки того, что происходит ДО успешной регистрации.
  # └────────────────────────────────
  before:
    # ┌────────────────────────────────
    # │ Максимальное время, которое игрок может провести в этом состоянии.
    # │ Если игрок не успеет зарегистрироваться, он будет кикнут.
    # └────────────────────────────────
    timeout:
      maximum-time: '2 мин'
      kick-message: '<red>Вы не успели зарегистрироваться вовремя.'
      # ┌────────────────────────────────
      # │ Отображает боссбар, пока игрок не зарегистрировался.
      # │ Полоска боссбара постепенно уменьшается в соответствии с таймаутом (см. timeout).
      # │ Плейсхолдер <remaining_time> меняется на оставшиеся секунды.
      # └────────────────────────────────
      bossbar:
        enabled: true
        content: '<gradient:#FF5722:#FF9800><bold>[!]</bold></gradient> <white>Зарегистрируйтесь:
          </white><gold>/reg пароль повтор</gold> <gray>(<remaining_time>s)'
        color: 'YELLOW'
        overlay: 'PROGRESS'
    # ┌────────────────────────────────
    # │ Отправляет сообщения по очереди, с равным интервалом, пока игрок не зарегистрировался.
    # └────────────────────────────────
    message:
      enabled: false
      rate: '4 сек'
      contents:
      - '<gradient:#F9A825:#FFEB3B><bold>[!]</bold></gradient> <white>Придумайте пароль
        и введите</white> <gold>/reg пароль повтор</gold>'
      - '<gradient:#F9A825:#FFEB3B><bold>[!]</bold></gradient> <white>Или просто напишите
        пароль и его повтор в чат</white>'
    # ┌────────────────────────────────
    # │ Отправляет тайтлы (сообщения на весь экран), пока игрок не зарегистрировался.
    # └────────────────────────────────
    title:
    - title: '<gradient:#FFA000:#FFC107><bold>Придумайте пароль</bold></gradient>'
      subtitle: '<white>Введите команду <gold>/reg пароль повтор</gold>'
      duration-fade-in: '500 мсек'
      duration-stay: '3 сек'
      duration-fade-out: '500 мсек'
    - title: '<gradient:#FFA000:#FFC107><bold>Или просто</bold></gradient>'
      subtitle: '<white>напишите пароль и повтор в чат</white>'
      duration-fade-in: '500 мсек'
      duration-stay: '3 сек'
      duration-fade-out: '500 мсек'

  # ┌────────────────────────────────
  # │ Настройки того, что происходит ПОСЛЕ успешной регистрации.
  # │ Сервер, куда игрока отправит, настраивается в general.yml.
  # └────────────────────────────────
  after:
    # ┌────────────────────────────────
    # │ Определяет, сколько времени плагин подержит игрока, прежде чем телепортировать его.
    # └────────────────────────────────
    delay: '2 сек'
    # ┌────────────────────────────────
    # │ Отправляет сообщение на весь экран об успешной регистрации.
    # └────────────────────────────────
    title:
      enabled: true
      title: '<green>Добро пожаловать!'
      subtitle: '<green>Вы успешно зарегистрировались!'
      duration-fade-in: '500 мсек'
      duration-stay: '3 сек 500 мсек'
      duration-fade-out: '1 сек'
    # ┌────────────────────────────────
    # │ Отправляет сообщение в чат об успешной регистрации.
    # └────────────────────────────────
    message:
      enabled: true
      content: '<green>Вы успешно зарегистрировались!'

# ┌────────────────────────────────
# │ Настройки входа.
# └────────────────────────────────
login:
  # ┌────────────────────────────────
  # │ Команда /login [пароль].
  # └────────────────────────────────
  command:
    aliases:
    - 'login'
    - 'l'
    cooldown: '1 сек 200 мсек'
    arguments:
      password: 'пароль'

  # ┌────────────────────────────────
  # │ Настройки того, что происходит ДО успешного входа.
  # └────────────────────────────────
  before:
    # ┌────────────────────────────────
    # │ Максимальное время, которое игрок может провести в этом состоянии.
    # │ Если игрок не успеет войти, он будет кикнут.
    # └────────────────────────────────
    timeout:
      maximum-time: '2 мин'
      kick-message: '<red>Вы не успели войти вовремя.'
      # ┌────────────────────────────────
      # │ Отображает боссбар, пока игрок не вошёл.
      # │ Полоска боссбара постепенно уменьшается в соответствии с таймаутом (см. timeout).
      # │ Плейсхолдер <remaining_time> меняется на оставшиеся секунды.
      # └────────────────────────────────
      bossbar:
        enabled: true
        content: '<gradient:#FF5722:#FF9800><bold>[!]</bold></gradient> <white>Войдите:
          </white><gold>/login пароль</gold> <gray>(<remaining_time>s)'
        color: 'YELLOW'
        overlay: 'PROGRESS'
    # ┌────────────────────────────────
    # │ Отправляет сообщения по очереди, с равным интервалом, пока игрок не вошёл.
    # └────────────────────────────────
    message:
      enabled: false
      rate: '4 сек'
      contents:
      - '<gradient:#F9A825:#FFEB3B><bold>[!]</bold></gradient> <white>Введите пароль
        командой</white> <gold>/login пароль</gold>'
      - '<gradient:#F9A825:#FFEB3B><bold>[!]</bold></gradient> <white>Или просто напишите
        пароль в чат</white>'
    # ┌────────────────────────────────
    # │ Отправляет тайтлы (сообщения на весь экран), пока игрок не вошёл.
    # └────────────────────────────────
    title:
    - title: '<gradient:#FFA000:#FFC107><bold>Введите пароль</bold></gradient>'
      subtitle: '<white>Команда <gold>/login пароль</gold></white>'
      duration-fade-in: '500 мсек'
      duration-stay: '3 сек'
      duration-fade-out: '500 мсек'
    - title: '<gradient:#FFA000:#FFC107><bold>Или просто</bold></gradient>'
      subtitle: '<white>напишите пароль в чат</white>'
      duration-fade-in: '500 мсек'
      duration-stay: '3 сек'
      duration-fade-out: '500 мсек'

  # ┌────────────────────────────────
  # │ Настройки того, что происходит ПОСЛЕ успешного входа.
  # │ Сервер, куда игрока отправит, настраивается в general.yml.
  # └────────────────────────────────
  after:
    # ┌────────────────────────────────
    # │ Определяет, сколько времени плагин подержит игрока, прежде чем телепортировать его.
    # └────────────────────────────────
    delay: '2 сек'
    # ┌────────────────────────────────
    # │ Отправляет сообщение на весь экран об успешном входе.
    # └────────────────────────────────
    title:
      enabled: true
      title: '<green>Добро пожаловать!'
      subtitle: '<green>Вы успешно вошли!'
      duration-fade-in: '500 мсек'
      duration-stay: '3 сек 500 мсек'
      duration-fade-out: '1 сек'
    # ┌────────────────────────────────
    # │ Отправляет сообщение в чат об успешном входе.
    # └────────────────────────────────
    message:
      enabled: true
      content: '<green>Вы успешно вошли!'

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

Registration

Настройки регистрации:

  • command - команды и алиасы для регистрации
  • before - что происходит до регистрации (таймауты, сообщения, тайтлы)
  • after - что происходит после регистрации

Login

Настройки входа:

  • command - команды и алиасы для входа
  • before - что происходит до входа (таймауты, сообщения, тайтлы)
  • after - что происходит после входа

🔐 Рекомендуемые настройки

Для большинства серверов безопасные настройки:

enabled: true
display-name: 'пароль'

registration:
  command:
    cooldown: '1 сек'
    password-repeat-required: true

  before:
    timeout:
      maximum-time: '2 мин'
      bossbar:
        enabled: true

login:
  command:
    cooldown: '1 сек'

  before:
    timeout:
      maximum-time: '2 мин'
      bossbar:
        enabled: true

⚠️ Важно

  • Это единственный способ, который позволяет игрокам регистрироваться
  • Отключение этого метода запретит незарегистрированным игрокам заходить на сервер
  • Таймауты должны быть достаточно большими для комфортной игры
  • Боссбары помогают игрокам понять, сколько времени у них осталось