Skip to content

Инструкция по настройке

Ilya Andreev edited this page Dec 19, 2023 · 2 revisions

Инструкция по настройке

Требования к серверу

  • Ядро Bukkit/Spigot/Paper и любые форки для версий игры 1.8 и выше.
  • Плагин PlaceholderAPI (опционально).
  • Плагин LuckPerms для нативного получения префиксов и суффиксов (опционально).
  • Плагин Vault для получения префиксов и суффиксов из других систем прав (опционально).

Установка

Актуальная версия всегда находится по адресу последним релизом. При миграции с версий v2.* и ниже, старая папка будет переименована в "Chatty.old".

Настройка конфигурации

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

Файлы конфигурации восстанавливают комментарии и свою структуру. Если удалить какой-то раздел или комментарий (начинается с #) к нему, то эти строки автоматически восстановятся после перезапуска. Иные комментарии, наоборот, будут удаляться. Для отключения той или иной функции необходимо пользоваться параметром enable и устанавливать его в значение false.

Цветовые коды

Плагин поддерживает все популярные форматы цветовых кодов:

  1. Chatty v2: {#123ABC}, {#123ABC:#FFFFFF Сообщение с градиентом}
  2. Bukkit (обычные цветовые коды): &0, &1 и т.д.
  3. Spigot (HEX-коды): &x&1&2&3&a&b&c
  4. Paper (HEX-коды): &#123abc
  5. MiniMessage: <red>, <gradient:#123abc:#ffffff>, <rainbow> и т.п.

Пункт 5 имеет свои особенности: объявление нового цвета не отменяет старые правила форматирования. Например, сообщение "<red>&bЭтот текст <yellow>написан жирным шрифтом" будет целиком выглядеть жирным. Пункты 1-4 работают по привычной схеме: "&c&bТолько этот текст жирный, &eа этот - обычный".

Более подробно ознакомиться с правилами форматирования MiniMessage можно в его документации, а также удобно воспользоваться онлайн-инструментом для форматирования.

Интерактивные элементы

В устаревшем Chatty v2 для интерактивных элементов использовался раздел "json" с подразделом "replacements", и их использование было достаточно неудобным. В Chatty v3 механизм полностью переработан, и теперь все сообщения поддерживают любые интерактивные элементы. Для их создания нужно использовать синтаксис MiniMessage.

Что можно сделать при помощи MiniMessage?

  • всплывающую подсказку при наведении на фразу (<hover>)
  • действие на нажатие по фразе: выполнение команды, ввод текста в чат-строку игрока, переход по ссылке (<click>)

В Chatty всё это можно сочетать с обычным цветовыми кодами. Например, мы хотим сделать всплывающую подсказку о глобальном чате на букву G:

<hover:'&aЭто глобальный чат, его видит весь мир.'>&8[&a&lG&8&l]</hover>

Более подробно ознакомиться с синтаксисом можно в документации MiniMessage. Также удобно пользоваться онлайн-инструментом для форматирования.

Данный формат работает в любых разделах плагина: обычные чаты, личные сообщения, оповещения и т.д.

PlaceholderAPI

Для поддержки PlaceholderAPI не нужно ничего делать дополнительно. Любые плейсхолдеры будут работать во всех местах плагина, кроме некоторых отдельных полей и файла с переводом.

Контекст стилей

Некоторые места в конфигурации содержат строки-заменители. Например, можно найти строку, на которую заменяется никнейм, в разделе mentions (упоминания). Данная строка будет изолирована от того, что находится левее и правее её - если заменить её в обычном белом сообщении без стиля, то продолжение после неё так и останется белым. Это сделано специально для удобства: нет необходимости задумываться о том, не сломается ли внешний вид сообщения при использовании этой функции.

Дальнейшая настройка

Более подробная информация по каждому разделу находится в самих конфиг-файлах плагина. Некоторые особенности сложных функций разобраны в отдельных разделах. Спасибо за использование плагина!