Embellish Chat

Embellish Chat улучшает чат Minecraft, добавляя показ предметов и инвентаря, встроенные иконки, упоминания и богатое форматирование. Игроки могут похвастаться снаряжением, открывать показанные инвентари и использовать более выразительные функции чата, при этом мод не требуется на клиенте других игроков.

✨ Ключевые возможности

• Показ предметов и инвентаря Показывайте предмет в руке, инвентарь или эндер-сундук прямо в чате с помощью [i], [inv] и [end], позволяя другим игрокам взаимодействовать с ними и рассматривать их.

• Встроенные иконки для чата Используй синтаксис :name:, чтобы вставлять в сообщения встроенные иконки из Minecraft.

• Богатое форматирование чата Оформляй сообщения жирным, курсивом, подчёркиванием, зачёркиванием, своими шрифтами, hex-цветами, градиентами, пресетами и радужными эффектами.

• Умная система упоминаний Упоминай игроков, @here, @team(name), @world(name) или @everyone с понятными уведомлениями. Упоминания групп LuckPerms тоже поддерживаются.

• Полезные утилиты для чата Наведи курсор на сообщение, чтобы увидеть точное время, и кликни по нему, чтобы скопировать его содержимое вместе со временем.

• Серверный мод с необязательными клиентскими функциями Embellish Chat полностью работает на стороне сервера для всех основных функций чата. Игрокам не нужно устанавливать мод на клиент. Он помечен как Server & Client только потому, что при установке мода на клиент доступна необязательная функция автодополнения упоминаний.

🛠️ Система стилей

Используй следующие шаблоны прямо в окне чата, чтобы применять стили:

Функция	Синтаксис	Пример	Демонстрация
Жирный	**Text**	**You really need to read this!**
Курсив	_Text_	_This is top secret..._
Подчёркивание	__Text__	__Check this out__
Зачёркивание	~~Text~~	~~We don’t talk about this anymore~~
Обфускация	||Text||	||Unreadable text||
Цвет (Hex)	[Text]<#RRGGBB>	[Blue]<#0000FF> like the deep ocean
Цвет (градиент)	[Text]<#RRGGBB #R...>	[Grraaaaaaadieeeeent]<#ffaaaa #aaaaff #aaffaa>
Цвет (пресет)	`[Text]`	`[pink] pig`
Цвет (радуга)	`[Text]`	`look at this [rainbow]`
Ссылка	[Text](URL)	Download it [here](https://modrinth.com/mod/embellish-chat)
Шрифт	[Text]{path}	[Blorp Zorp]{minecraft:alt}
Предмет	[i]	Look at my [i]
Инвентарь	[inv]	Look at my [inv]
Ender Chest	[end]	Look at my [end]
Иконка	:name:	I :love: you
Упоминание	@PlayerName	Hello, @User

Примечания

• Ссылки: Встроенные правила ссылок по умолчанию совпадают только с https:// URL.
• Цвета: Пресеты (например, pink) задаются в presets.json/color.
• Шрифты: path требует ID с пространством имён (например, minecraft:alt).
• Иконки и спрайты предметов: Пресеты иконок и отрисовка спрайтов предметов используют компоненты на основе атласа, поэтому они не поддерживаются на старых версиях Minecraft.
• Подробнее: О продвинутом синтаксисе, комбинациях стилей и детальных правилах читайте в /embellish-chat help style или в StyleWiki.

🗣️ Система упоминаний

Примечания

• Поведение: Успешные упоминания отправляют целевому игроку звук уведомления и автоматически окрашивают текст (например, в цвет команды).
• Зависимости: @group требует LuckPerms. Без него упоминание будет проигнорировано.
• Цвета: Упоминания @team и @Player начинаются со значения team_color из config.json, затем используют стиль команды/отображения цели, когда он доступен. Если team_color равен null, текст упоминания остаётся неокрашенным.
• Звук: Звук уведомления использует категорию UI (на Minecraft 1.21.5 и более ранних версиях откатывается к категории PLAYER).
• Подробнее: Полный список типов упоминаний и продвинутое использование смотрите в MentionWiki.

⌨️ Команды

Админ-команды

Требуют OP Level 2 (или GAMEMASTERS_CHECK на 1.21.11+).

• /embellish-chat reload Немедленно перезагружает все файлы конфигурации в /config/embellish-chat/.
• **`/embellish-chat ban/pardon `** Блокирует или восстанавливает доступ игрока ко всем функциям мода.
• **`/embellish-chat stress_test ** Многократно симулирует сообщений в течение` для стресс-теста производительности обработки сообщений на сервере.
• **`/embellish-chat regex_test ** Проверяет указанное на` и подсвечивает группы захвата для анализа результата совпадения.

Пользовательские команды

Доступны всем игрокам (разрешения не требуются).

• **`/embellish-chat open `** Открывает последний расшаренный инвентарь/эндэр/предмет указанного игрока.
• /embellish-chat help mention Показывает доступные вам правила упоминаний на основе ваших разрешений.
• /embellish-chat help style Показывает доступные вам правила стилей на основе ваших разрешений.
• /embellish-chat help icon Показывает доступные пресеты иконок из presets.json/icon в формате name - icon.
• /embellish-chat notification Переключает ваши личные настройки уведомлений об упоминаниях. (Включается/отключается глобально через notify_command_enabled в конфиге).

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

Embellish Chat предоставляет мощный функционал через регулярные выражения. Поскольку регулярные выражения по своей природе сложны, рекомендуется использовать различные AI-инструменты для создания и оптимизации правил.

Конфиг

Файл конфигурации находится по пути config/embellish-chat/config.json.

{
  //version
  "version": "current mod version",
  
  //setting
  "delimiter": ",",
  "timestamp": "yyyy-MM-dd HH:mm:ss",
  "command_alias": "ec",
  "url_color": "#0000EE",
  "team_color": "#FF55FF",
  "notify_command_enabled": true,
  "notify_mention_enabled": true,
  "require_same_channel": true,
  "disable_vanilla_chat_format": false,
  
  //player list
  "banned_players": [],
  "notify_off_players": []
}

• Поле version нельзя изменять вручную.
• ConfigManager записывает config.json, styles.json, mentions.json и presets.json по отдельности, а затем объединяет их в один runtime-Config при загрузке.
• Отсутствующие секции восстанавливаются из встроенных значений по умолчанию на этапе объединения.
• Если сохранённый version не совпадает с версией запущенного мода, мод сохраняет текущую конфигурацию в памяти и игнорирует несовпадающую загрузку.
• Основная логика конфигурации определяется в style_rules и mention_rules.
• Правила обрабатываются сверху вниз, поэтому размещение универсального правила выше может перекрыть более специфичные правила, определённые ниже.
• Значение delimiter внутри обрабатывается как регулярное выражение; специальные символы, такие как |, должны быть правильно экранированы.
• command_alias регистрирует дополнительную корневую команду, которая перенаправляет на /embellish-chat, когда конфиг загружен с непустым значением.
• team_color — это базовый цвет, используемый при стилизации упоминаний @team и @Player.
• Если team_color отсутствует или установлен в null, эти упоминания остаются без автоматического цвета.
• require_same_channel ограничивает упоминания ADVANCED_CHAT_CHANNEL текущим каналом Advanced Chat отправителя, когда включено.
• Перезагрузка конфига обновляет runtime-обработчики стилей и упоминаний, поэтому обновлённые значения style_rules, mention_rules, timestamp, url_color, whitelist, color, icon и item вступают в силу немедленно.
• Чтобы избежать синтаксических ошибок JSON и обеспечить корректные конфигурации, настоятельно рекомендуется использовать Web Config Generator.

Стилизация

Файл конфигурации находится по пути config/embellish-chat/styles.json.

{
  "style_rules": {
    "embellish-chat.chat": [
      {
        "pattern": " ... ",
        "comment": "...",
        "styles": [
          {
            "styleType": " ... ",
            "preset": " ... "
          }
        ]
      }
      ...
    ]
  }
}

• pattern: Это регулярное выражение для сканирования текста. Оно должно иметь две группы захвата.

  • group 1: Это текст, к которому применяется стиль.
  • group 2: Это текст, передаваемый как опция.
• comment: Этот комментарий используется в /embellish-chat help style.

• styles: Определяет стили, применяемые к захваченной группе 1.

  • styleType: Это тип стиля. Можно использовать все типы, перечисленные в StyleWiki.
  • preset: Это значение пресета. Если значение указано, оно всегда используется; если пусто, вместо него используется содержимое захваченной группы 2 пользователя.
• Каждый ключ верхнего уровня, такой как embellish-chat.chat, также рассматривается как узел разрешений.
• Каждое имя styleType должно соответствовать обработчику, зарегистрированному в runtime-StyleRegistry.

Упоминания

Файл конфигурации находится по пути config/embellish-chat/mentions.json.

{
  "mention_rules": {
    "embellish-chat.mention": [
      {
        "pattern": " ... ",
        "comment": "...",
        
        "title": " ... ",
        "sound": { ... },
        
        "cooldown": 0,
        "onlyTarget": false,
        
        "mentions": [
          {
            "mentionType": " ... ",
            "preset": " ... "
          }
        ],
        "styles": [ ... ]
      }
      ...
    ]
  }
}

* **`pattern`**: Это регулярное выражение для сканирования текста. В нём должна быть одна группа захвата.
  * Это опция упоминания (например, название команды, группа LuckPerms).
* **`comment`**: Этот комментарий используется в `/embellish-chat help mention`.
* **`title`**: Это заголовок, отображаемый на экране упомянутого игрока.
  * `%player:displayname%` — отображаемое имя игрока, отправившего упоминание.
* **`sound`**: Определяет настройки звука уведомления.
  * `id`: Идентификатор звука.
  * `category`: Категория звука.
  * `volume`: Громкость звука.
  * `pitch`: Высота тона звука.
* **`cooldown`**: Это время перезарядки упоминания в секундах.
  * Установите `0`, чтобы отключить перезарядку.
* **`onlyTarget`**:
  * Если установлено `true`, сообщение не транслируется всем, а отправляется только цели.
* **`mentions`**: Определяет действия упоминания, которые нужно выполнить.
  * `mentionType`: Это тип упоминания. Можно использовать все типы, перечисленные в [MentionWiki](https://hanhy06.github.io/embellish-chat/mention/MentionType/).
  * `preset`: Это необязательное значение пресета.
* **`styles`**: Определяет стили, применяемые при срабатывании упоминания.
  * Работает так же, как в разделе правил стилизации.

### Пресеты

Файл конфигурации находится по адресу `config/embellish-chat/presets.json`.

{ "message_header": { " ... ": " ... " }, "whitelist": [ " ... " ], "icon": { " ... ": { "atlas": " ... ", "sprite": " ... " } }, "item": { " ... ": { "atlas": " ... ", "sprite": " ... " } }, "color": { " ... ": " ... " } }

* **`message_header`**: В качестве ключей использует узлы прав, а каждое значение — это заголовок сообщения, разбираемый как текстовый компонент с тегами-заполнителями.
* **`whitelist`**: Используется в типе стиля `URL`. Если оставить пустым, разрешены все URL.
* **`icon`**: Используется в `ICON_PRESET` и `/embellish-chat help icon`.
* **`item`**: Переопределяет атласные спрайты, используемые `SHOW_ITEM` для конкретных ID предметов.
* **`color`**: Используется в цветовых пресетах для стилизации.

---

## 📜 Совместимость

### ✅ Полностью поддерживается

* **Fabric Permissions API (встроенный)**
  * Ключи, определённые в `style_rules` и `mention_rules`, напрямую работают как узлы прав.
  * Правила оцениваются сверху вниз на основе прав игрока.
* **Text Placeholder API (встроенный)**
  * Поддерживает динамические заполнители в заголовках упоминаний и пресетах стилей.
  * **Эксклюзив:** Используйте `%embellish-chat:content%` для доступа к исходному, неразобранному сообщению чата.
* **Стилизованные никнеймы**
  * Поддерживает упоминание игроков по никнейму.
* **LuckPerms**
  * **Требуется** для типа упоминания `@group`. Без него упоминания групп будут игнорироваться.
* **Advanced Chat**
  * **Требуется** для типа упоминания `@channel`. Без него упоминания каналов будут игнорироваться.
* **Geyser (Bedrock Edition)**
  * Упоминания между Java и Bedrock изданиями работают без проблем.
  * *Примечание:* Продвинутая стилизация (всплывающий текст, события клика) может отображаться на клиентах Bedrock не полностью.
* **Игра по локальной сети в Minecraft**
  * Протестировано в стандартных мирах по локальной сети.

### ❗ Известные конфликты

* **Styled Chat**
  * **Styled Chat имеет приоритет.** Если он установлен, функции *стилизации* Embellish Chat будут переопределены.
  * **Упоминания всё ещё работают:** Система упоминаний и уведомлений остаётся работоспособной.
  * **Совет по производительности:** Если вам нужно использовать оба, удалите все записи в `style_rules` Embellish Chat, чтобы избежать лишней фоновой обработки.

---

## 📜 Лицензия и ссылки

Этот проект лицензирован под **Apache License 2.0**.

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

* **Официальная загрузка (Modrinth):** [https://modrinth.com/mod/embellish-chat](https://modrinth.com/mod/embellish-chat)
* **Исходный код (GitHub):** [https://github.com/hanhy06/embellish-chat](https://github.com/hanhy06/embellish-chat)

---

## ✨ Обратная связь и поддержка

Нашли баг или есть предложение по функционалу? Откройте issue или напишите на Discord-сервере проекта.

Если хотите получать обновления раньше, поставьте сердечко ❤️ на нашей странице Modrinth! Ваша поддержка очень важна!