ProtocolExtension

ProtocolExtension добавляет в игру поддержку дополнительных пакетов для расширения функционала сервера. Проект предоставляет API для отправки данных и механизмы динамического изменения HUD.

🏛️ ProtocolExtension расширяет возможности сервера путем добавления в игру новых пакетов. Проект позволяет разработчикам и администраторам реализовывать функции, которые выходят за рамки стандартного сетевого протокола Minecraft.

Для корректной работы проекта необходима специфическая установка в зависимости от среды. Проект предназначен для работы как на стороне клиента, так и на стороне сервера.

ProtocolExtension может быть установлен как клиентский мод на Fabric, так и как серверная часть на Paper (и его форках).

Для настройки сервера владельцу необходимо:

• Скачать актуальный JAR-файл ProtocolExtension.
• Скачать актуальный JAR-файл PacketEvents.
• Загрузить оба файла в папку plugins сервера.

Игрокам также необходимо установить JAR-файл ProtocolExtension на стороне клиента, чтобы кастомные пакеты корректно обрабатывались. Клиентская часть не имеет зависимостей.

Проект вводит несколько типов пакетов для обмена данными между клиентом и сервером:

• Activate (внутренний) — уведомляет сервер о поддержке ProtocolExtension.
• KeyPressedC2S — отправляется при нажатии неспециальной клавиши.
• MouseMoveC2S — отправляется при движении мыши по экрану.
• ChatOpenedC2SPayload — уведомление об открытии экрана чата.
• ChatClosedC2SPayload — уведомление о закрытии экрана чата.

• Activate (внутренний) — уведомляет клиент о поддержке проекта.
• ToggleHUDS2C — имитирует нажатие клавиши F1.
• HUDPutElementS2C — добавляет элемент с указанным ID, позицией и текстом на HUD.
• HUDDeleteElementS2C — удаляет элемент с указанным ID с HUD.
• HUDClearS2C — очищает все элементы с HUD.
• HUDSettingHotbarS2C — переключает видимость хотбара.
• MoveToggleS2C — переключает тики движения в логике клиента.
• ServerCommandS2C — устанавливает режимы приседания и спринта.
• SetWindowTitleS2C — добавляет текст к заголовку окна игры.
• SetPerspectiveS2C — устанавливает перспективу клиента.
• ToggleRenderingS2C — переключает рендеринг для клиента.
• ClearChatC2SPayload — очищает чат клиента.

Проект уделяет внимание безопасности данных пользователя и минимизирует объем передаваемой информации. Сервер не имеет возможности:

• Выполнять сырой код на клиенте пользователя.
• Логировать состояние клавиатуры или мыши вне игры.
• Просматривать любые элементы HUD, не созданные самим проектом.

Все элементы HUD, созданные сервером, автоматически удаляются после выхода игрока с сервера.

Для разработчиков предусмотрен API, позволяющий отправлять кастомные пакеты клиентам. Для интеграции необходимо включить JAR-файл ProtocolExtension в Maven или Gradle как compile-only.