Keybind

⌨️ Keybind

Привязывай клавиши к серверным командам. Нажимаешь клавишу — сервер выполняет команду.

Клиентский мод (Fabric) • Серверный плагин (Paper)

Примечание: Чтобы мод работал, нужно установить и серверный плагин, и клиентский мод для Fabric. На серверах без плагина ни одна привязка не зарегистрируется и не будет доступна.

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

• 🔗 Управление с сервера: Действия полностью задаются на сервере и синхронизируются с клиентом при входе.
• 📁 Хранение по серверам: Назначения клавиш сохраняются отдельно для каждого IP сервера в .minecraft/config/keybind-servers/ и никогда не перезаписываются при повторном входе.
• 🛠️ Динамическая регистрация: Новые серверные действия появляются в меню Настройки → Управление без перезапуска игры.
• 💬 Менеджер в игре: На Paper 1.21.7+ команда /kbind manage открывает диалог Minecraft для добавления, редактирования или удаления привязок без правки config.yml. Нажми Press a key…, затем нажми клавишу (нужен клиентский мод).
• 🏷️ Свои отображаемые имена: Владельцы серверов задают понятные названия (например, "Teleport to Spawn" вместо spawn).
• ⏱️ Двойные кулдауны: И общий кулдаун (между любыми действиями), и кулдаун для каждого действия защищают от спама.
• 🔐 Поддержка прав: Каждое действие поддерживает дополнительный узел прав поверх keybind.use.
• 📡 Plugin Messaging: Используются каналы plugin message keybind:main / keybind:sync. Если канал пакетов недоступен, происходит откат к `/kbind `.
• 🧹 Очистка устаревших действий: Устаревшие действия из прошлых сессий автоматически удаляются из меню «Управление» и сохранённого конфига.
• 🌍 Клиент под несколько загрузчиков: Сборки для Fabric и Forge выпущены. Forge поддерживает Minecraft 1.21, 1.21.11 и 26.1.

🚀 Как это работает

1. Синхронизация: Через 1 секунду после входа игрока плагин отправляет все настроенные действия (имя, отображаемое имя, клавишу по умолчанию) по каналу keybind:sync.
2. Регистрация: Мод регистрирует каждое действие как нативную привязку Minecraft в категории Keybind в меню Настройки → Управление.
3. Срабатывание: Когда клавиша нажата (и не открыт никакой экран), мод отправляет имя действия по каналу keybind:main.
4. Выполнение: Плагин проверяет имя действия (только буквы, цифры и подчёркивания), права и кулдауны, затем выполняет команду.

🛠️ Установка

Серверная часть

1. Помести Keybind-Plugin-1.0.3.jar в папку plugins/.
2. Перезапусти сервер — plugins/Keybind/config.yml создастся автоматически.
3. Отредактируй config.yml, задай свои действия, затем выполни /kbind reload.

Клиентская часть

1. Установи клиентский jar, подходящий под твою версию Minecraft и загрузчик, в .minecraft/mods/
2. Установи нужный загрузчик и API для выбранной платформы. Используй Java 21 для Minecraft 1.21 и 1.21.11 и Java 25 для Minecraft 26.1.
3. Не устанавливай несколько клиентских jar Keybind одновременно. Запусти игру и подключись к серверу с плагином Keybind.

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

plugins/Keybind/config.yml

# Global cooldown between any keybind actions (milliseconds)
global-cooldown: 500

actions:
  spawn:
    command: "spawn"              # Command to run (without /)
    display-name: "Spawn"        # Label shown in Controls menu
    default-key: "LEFT_BRACKET"  # Suggested key for first-time players
    permission: ""               # Optional extra permission node (leave empty for none)
    cooldown: 1000               # Per-action cooldown (ms); defaults to global-cooldown
    console: false               # true = run as console with {player} replaced by player name

  home:
    command: "home"
    display-name: "Home"
    default-key: "RIGHT_BRACKET"
    permission: ""
    cooldown: 1000
    console: false

**Примечания:**
- Имена действий должны содержать только буквы, цифры и подчёркивания (например, `my_action`).
- `console: true` выполняет команду от имени консоли. Используй `{player}` как placeholder для имени игрока (например, `command: "tp {player} spawn"`).
- `default-key` применяется только при первом подключении игрока. При последующих входах используется сохранённая привязка.

---

## ⌨️ Поддерживаемые клавиши

### Клавиатура
| Категория | Значения |
| :--- | :--- |
| Буквы | `A`–`Z` |
| Цифры | `0`–`9` |
| Функциональные | `F1`–`F25` |
| Стрелки | `UP`, `DOWN`, `LEFT`, `RIGHT` |
| Навигация | `PAGE_UP`, `PAGE_DOWN`, `HOME`, `END`, `INSERT`, `DELETE` |
| Специальные | `SPACE`, `ENTER`, `TAB`, `BACKSPACE`, `ESCAPE`, `PAUSE` |
| Клавиши-замки | `CAPS_LOCK`, `SCROLL_LOCK`, `NUM_LOCK` |
| Прочие | `PRINT_SCREEN`, `MENU` |
| Модификаторы | `LEFT_SHIFT`, `LEFT_CONTROL` (или `LEFT_CTRL`), `LEFT_ALT`, `LEFT_SUPER`, `RIGHT_SHIFT`, `RIGHT_CONTROL` (или `RIGHT_CTRL`), `RIGHT_ALT`, `RIGHT_SUPER` |
| Numpad | `KP_0`–`KP_9`, `KP_ADD`, `KP_SUBTRACT`, `KP_MULTIPLY`, `KP_DIVIDE`, `KP_DECIMAL`, `KP_ENTER`, `KP_EQUAL` |
| Символы | `LEFT_BRACKET`, `RIGHT_BRACKET`, `BACKSLASH`, `SEMICOLON`, `APOSTROPHE`, `COMMA`, `PERIOD`, `SLASH`, `GRAVE_ACCENT`, `MINUS`, `EQUAL` — или сам символ напрямую: `[`, `]`, `\`, `;`, `'`, `,`, `.`, `/`, `` ` ``, `-`, `=` |
| Мировые клавиши | `WORLD_1`, `WORLD_2` (клавиши, зависящие от раскладки на некоторых клавиатурах) |

### Мышь
| Значение | Псевдонимы | Кнопка |
| :--- | :--- | :--- |
| `MOUSE_LEFT` | `MOUSE_1` | Левый клик |
| `MOUSE_RIGHT` | `MOUSE_2` | Правый клик |
| `MOUSE_MIDDLE` | `MOUSE_3` | Средний клик |
| `MOUSE_4`–`MOUSE_8` | — | Боковые/дополнительные кнопки |

---

## 📜 Команды и права

| Команда | Описание | Право |
| :--- | :--- | :--- |
| `/kbind <action>` | Вручную запустить действие | `keybind.use` |
| `/kbind list` | Показать список всех настроенных имён действий | *(любое)* |
| `/kbind manage` | Открыть менеджер диалогов Minecraft (Paper 1.21.7+) | `keybind.admin` |
| `/kbind add <name> <command...>` | Создать привязку клавиши | `keybind.admin` |
| `/kbind set <name> <field> <value>` | Изменить `command`, `display`, `key`, `permission`, `cooldown` или `console` | `keybind.admin` |
| `/kbind remove <name>` | Удалить привязку клавиши | `keybind.admin` |
| `/kbind reload` | Перезагрузить конфиг и заново синхронизировать всех игроков онлайн | `keybind.admin` |

| Право | Описание | По умолчанию |
| :--- | :--- | :--- |
| `keybind.use` | Требуется для запуска любого действия | `true` (все) |
| `keybind.admin` | Доступ к `/kbind manage`, add/set/remove и reload | `op` |
| `keybind.bypass.cooldown` | Игнорировать все кулдауны | `op` |