Key Bind Manager - Плагин для бинда клавиш на команды

[DENZEL519]

Описание:​

Плагин Key Bind Manager позволяет биндить любые клавиши игрока на выполнение команд через файл конфигурации. При нажатии назначенной клавиши автоматически выполняется указанная команда.

Спойлер: Как всё работает?

Key Bind Manager - Плагин для бинда клавиш на команды​

Основные возможности​

• Бинд любых клавиш на команды через файл конфигурации
• Поддержка всех основных клавиш Source Engine (E, R, ЛКМ, ПКМ, Пробел, Ctrl и т.д.)
• Автоматическое создание файла конфигурации при первом запуске
• Поддержка различных типов команд (SourceMod, чат, консольные)
• Возможность включения/отключения биндов без перезагрузки плагина
• Перезагрузка конфигурации без перезапуска сервера
• Отслеживание только новых нажатий клавиш (не срабатывает при удержании)

Как работает плагин​

1. Инициализация
При запуске плагина:

• Регистрируются команды для перезагрузки конфигурации:
  sm_keybind_reload
  и
  sm_kb_reload
• Создается путь к файлу конфигурации:
  cfg/sourcemod/key_bind.cfg
• Инициализируется массив для хранения биндов
• Загружается конфигурация из файла

2. Загрузка конфигурации
Плагин читает файл

cfg/sourcemod/key_bind.cfg

в формате KeyValues:

• Если файл не существует - создается файл с примерами биндов
• Если директория
  cfg/sourcemod
  не существует - она создается автоматически
• Парсится секция
  "Binds"
  со всеми биндами
• Каждый бинд проверяется на корректность (наличие клавиши и команды)
• Некорректные бинды пропускаются с записью в лог
• Все загруженные бинды сохраняются в памяти

3. Отслеживание нажатий клавиш
Плагин использует хук

OnPlayerRunCmd

для отслеживания нажатий:

• Каждый тик проверяются все зарегистрированные клавиши
• Сравнивается текущее состояние кнопок с предыдущим
• Если клавиша только что была нажата (не была нажата в прошлом кадре, но нажата сейчас) - выполняется команда
• Состояние кнопок сохраняется для следующего тика
• Команды выполняются через таймер с задержкой 0.0 для безопасного выполнения

4. Выполнение команд
В зависимости от типа команды используется соответствующий метод:

• Команды чата (начинаются с
  !
  или
  /
  ) - выполняются через
  say
• SourceMod команды (начинаются с
  sm_
  ) - выполняются через
  FakeClientCommand
• Команды say/say_team - выполняются через
  FakeClientCommand
• Обычные консольные команды - выполняются через
  ClientCommand

Поддерживаемые клавиши​

Плагин поддерживает следующие клавиши Source Engine:

Название	Клавиша	Описание
IN_USE	E	Использование/взаимодействие
IN_RELOAD	R	Перезарядка оружия
IN_ATTACK	ЛКМ	Атака/стрельба
IN_ATTACK2	ПКМ	Альтернативная атака/прицел
IN_JUMP	Пробел	Прыжок
IN_DUCK	Ctrl	Приседание
IN_FORWARD	W	Движение вперед
IN_BACK	S	Движение назад
IN_LEFT	A	Поворот влево
IN_RIGHT	D	Поворот вправо
IN_MOVELEFT	A (боковое)	Боковое движение влево
IN_MOVERIGHT	D (боковое)	Боковое движение вправо
IN_RUN	Shift	Бег
IN_WALK	Shift (альтернативный)	Ходьба
IN_ZOOM	ПКМ (в некоторых играх)	Прицеливание
IN_GRENADE1	4	Первая граната
IN_GRENADE2	5	Вторая граната
IN_WEAPON1	1	Первое оружие
IN_WEAPON2	2	Второе оружие
IN_SCORE	Tab	Таблица результатов
IN_ALT1	Q	Альтернативная клавиша 1
IN_ALT2	F	Альтернативная клавиша 2

Файл конфигурации​

Расположение
Файл конфигурации находится по пути:

cfg/sourcemod/key_bind.cfg

Формат файла

"KeyBinds"
{
    "Binds"
    {
        "ИмяБинда1"
        {
            "key"          "IN_USE"
            "command"      "say_team Привет команде!"
            "enabled"      "1"
        }
     
        "ИмяБинда2"
        {
            "key"          "IN_RELOAD"
            "command"      "sm_menu"
            "enabled"      "0"
        }
    }
}

Параметры бинда

• key - название клавиши (например,
  IN_USE
  ,
  IN_RELOAD
  )
• command - команда для выполнения (может быть SourceMod командой, командой чата или консольной командой)
• enabled - включен ли бинд (
  1
  - включен,
  0
  - выключен)

Примеры команд

• say_team Привет команде!
  - сообщение в командный чат
• sm_menu
  - открыть меню SourceMod
• sm_noblock
  - выполнить команду NoBlock
• !voteban
  - команда чата (будет выполнена как
  say !voteban
  )
• /help
  - команда чата (будет выполнена как
  say /help
  )

Команды плагина​

sm_keybind_reload

• Описание: Перезагружает конфигурацию биндов клавиш
• Доступ: Администраторы с флагом
  ADMFLAG_CONFIG
• Альтернатива:
  sm_kb_reload
• Использование:
  sm_keybind_reload

Технические детали​

Структура данных
Каждый бинд хранится в структуре

KeyBind

:

• keyName[32]
  - название клавиши (строка)
• keyFlag
  - флаг клавиши (число, битовая маска)
• command[256]
  - команда для выполнения (строка)
• enabled
  - включен ли бинд (булево значение)

Алгоритм работы

1. При загрузке плагина читается файл конфигурации
2. Все бинды загружаются в массив
   g_KeyBinds
3. При каждом тике в
   OnPlayerRunCmd
   проверяются все бинды
4. Для каждого бинда сравнивается текущее состояние кнопки с предыдущим
5. Если кнопка только что была нажата - команда добавляется в очередь через таймер
6. Таймер выполняет команду в безопасном контексте
7. Команда выполняется через соответствующий метод в зависимости от типа

Безопасность

• Проверка валидности клиента перед выполнением команды
• Игнорирование ботов (
  IsFakeClient
  )
• Проверка подключения клиента (
  IsClientInGame
  )
• Выполнение команд через таймер для избежания проблем в
  OnPlayerRunCmd
• Очистка состояния при отключении клиента

Установка​

1. Скомпилируйте плагин:
   spcomp key_bind.sp
2. Скопируйте
   key_bind.smx
   в
   addons/sourcemod/plugins/
3. Перезапустите сервер или выполните
   sm plugins load key_bind
4. При первом запуске автоматически создастся файл
   cfg/sourcemod/key_bind.cfg
5. Отредактируйте файл конфигурации под свои нужды
6. Выполните
   sm_keybind_reload
   для применения изменений

Логирование​

Плагин записывает в лог следующую информацию:

• Загрузку каждого бинда с указанием имени, команды, клавиши и статуса
• Общее количество загруженных биндов
• Ошибки при загрузке конфигурации
• Создание файла конфигурации по умолчанию
• Ошибки при создании директорий

Ограничения​

• Плагин отслеживает только новые нажатия клавиш (не срабатывает при удержании)
• Некоторые клавиши могут конфликтовать с игровыми механиками (например,
  IN_ATTACK
  для стрельбы)
• Бинды применяются ко всем игрокам одинаково (нет индивидуальных настроек)
• Максимальная длина команды - 256 символов

Версия​

Текущая версия: 1.0.0

Автор​

Автор: DENZEl519&AI

 

[Synd1qate]

Каждый тик проверяются все зарегистрированные клавиши и зачем?

 

[DENZEL519]

Каждый тик проверяются все зарегистрированные клавиши и зачем?

V 1.0.1
Новый оптимизированный подход:
проверяются только изменившиеся кнопки.
Производительность:

• Старый подход: всегда N проверок (N = количество биндов)
• Новый подход: 0 проверок, если ничего не нажато; только нужные проверки при нажатии