InputEngine

InputEngine

Бесшовный кроссплатформенный мост, передающий кастомные нажатия клавиш с клиента Minecraft на сервер!

📖 Обзор

InputEngine — это мощный мод/плагин-утилита, созданный для перехвата кастомных нажатий клавиш с клиента Minecraft и мгновенной передачи их на сервер. Он позволяет серверным плагинам мгновенно реагировать на кастомные клиентские бинды (например, Навык 1, Уклонение, Открыть кастомное меню).

Этот проект представляет собой мост из двух частей: Клиентский мод (Fabric/NeoForge) и Серверный плагин (Spigot/Paper).

✨ Возможности

• 🎮 Клиентские бинды: Регистрирует кастомные бинды на клиенте. Полностью поддерживает как Fabric, так и NeoForge.
• ⚡ Сетевой мост: Отправляет эффективные, лёгкие пакеты на сервер при каждом нажатии или отпускании привязанной клавиши.
• 🌍 Совместимость с ванильными серверами: Сетевой канал на клиенте опционален. Вы можете спокойно держать мод установленным и заходить на ванильные серверы без риска быть кикнутым!
• 🛠️ Серверный API: Предоставляет кастомное событие Spigot (PlayerKeyPressEvent) для разработчиков, чтобы ваши серверные плагины могли легко отслеживать и реагировать на действия игроков.

📥 Установка

Для корректной работы InputEngine требуются как серверный плагин, так и клиентский мод.

Для игроков (Клиент)

1. Скачайте подходящую версию для вашего загрузчика модов (Fabric или NeoForge).
2. Поместите скачанный .jar файл в папку mods/ вашего клиента Minecraft.
3. Пользователям Fabric: Убедитесь, что у вас установлен Fabric API.

Для владельцев серверов (Плагин)

1. Скачайте релизный файл для Spigot.
2. Поместите его в папку plugins/ вашего сервера Spigot/Paper.
3. Перезапустите сервер.

💻 Для разработчиков (Использование API)

Если вы разрабатываете плагин для Bukkit/Spigot и хотите реагировать на нажатия клавиш игроком, вы легко можете использовать API!

Слушайте событие PlayerKeyPressEvent:

import dev.darkblade.mod.input_engine.server.api.PlayerKeyPressEvent;
import org.bukkit.event.EventHandler;
import org.bukkit.event.Listener;

public class MyPluginListener implements Listener {

    @EventHandler
    public void onPlayerKeyPress(PlayerKeyPressEvent event) {
        if (event.isPressed()) {
            event.getPlayer().sendMessage("You pressed: " + event.getAction().name());
        } else {
            event.getPlayer().sendMessage("You released: " + event.getAction().name());
        }
    }
}

Полный пример есть в Example plugin и API Documentation

📜 Лицензия

Этот проект с открытым исходным кодом и доступен под MIT License.