LegacyX-Killfeed: документація плагіна для передавання подій про вбивства
О материале
Можливості
LegacyX-Killfeed — плагін CounterStrikeSharp для CS2, який надсилає події про вбивства до Root API. Ці дані призначені для живої стрічки вбивств на сайті. Плагін передає їх через API, а не під’єднується безпосередньо до бази даних.
Плагін обробляє подію смерті гравця, якщо жертва чинна. Для кожного запису формуються ідентифікатор події, ідентифікатор сервера, дані нападника й жертви, зброя, ознака пострілу в голову та час. Для ботів Steam ID не передається; якщо нападника немає, його ім’я позначається як World. Імена та назва зброї обмежуються за довжиною, а назва зброї додатково очищується від непідтримуваних символів.
Події відправляються пакетами: перевірка черги відбувається раз на секунду, не більш як 50 записів за запит. Черга обмежена 500 подіями; коли вона переповнена, найстаріший запис видаляється. Невдалі запити не накопичуються для повторного надсилання: під час недоступності API події можуть бути втрачені.
Вимоги
- Ігровий сервер CS2 із встановленим CounterStrikeSharp.
- Плагін має бути зібраний разом із бібліотекою
LegacyX.Shared.Configuration, яку використовують модулі репозиторію. - Для надсилання даних потрібні базова адреса Root API, токен плагіна та ID сервера. У таблиці репозиторію для
LegacyX-Killfeedзазначено область токенаservers:write.
У репозиторії міститься вихідний код, а не готовий DLL чи ігровий сервер. Версії залежностей для цього плагіна в наведеній документації не визначені.
Встановлення та збирання
З кореня репозиторію можна зібрати всі модулі й сформувати пакет із файлами для сервера:
./scripts/build-all.sh
./scripts/package.sh
Пакет створюється в dist/legacyx-cs2 і відтворює структуру game/csgo. Файли плагіна розміщуються в addons/counterstrikesharp/plugins/LegacyX-Killfeed/; спільна бібліотека має бути в каталозі addons/counterstrikesharp/shared/LegacyX.Shared.Configuration/. Зібрані файли потрібно встановити на сервер і перезапустити його. Скрипт розгортання також підтримує встановлення пакета в каталоги серверів, але сам репозиторій не містить готової збірки.
Налаштування
Конфігурація модулів зберігається в центральному файлі CounterStrikeSharp/.env. Спільний завантажувач спершу перевіряє змінні середовища процесу, а потім цей файл. Назви параметрів, які плагін читає безпосередньо:
LEGACYX_API_BASE_URL— базова адреса API.LEGACYX_SERVER_ID— ID сервера. Допустимий формат: від 1 до 64 символів із набору літер, цифр, крапки, підкреслення, двокрапки та дефіса.PLUGIN_TOKENу налаштуваннях модуляKILLFEED; якщо його не задано, плагін використовуєLEGACYX_PLUGIN_TOKEN. Токен має містити щонайменше 20 символів.ENABLEDу налаштуваннях модуляKILLFEED— перемикач роботи; значення за замовчуванням —true.
Не додавайте секрети до вихідного коду або локальних JSON/CFG-файлів. README вказує на кореневий .env.example як шаблон, але його конкретні значення тут не наведені. За відсутності обов’язкових параметрів плагін не надсилатиме події.
Передавання подій
Запити надходять на /api/v1/plugin/killfeed/events методом POST із Bearer-токеном. Час очікування HTTP-запиту обмежений п’ятьма секундами. Плагін записує в журнал код відповіді, якщо API повернув помилку, або тип винятку, якщо API недоступний. Окремих ігрових команд для керування Killfeed документація не описує.
Завантаження
Версія: git-f7886b544165.
ZIP містить вихідні коди; перед встановленням може знадобитися компіляція. Файл плагіна: LegacyX-Killfeed/LegacyXKillfeed.cs.






Комментарии (0)