Перейти к содержимому
KILLSCRIPT SDK

Начало работы

Понадобятся Node.js 20 или новее и путь к игровой папке Modules. Глобально устанавливать пакеты не нужно.

  1. Создайте и установите проект

    Окно терминала
    npx killscript@0.1.2 new MyModule --modules "/path/to/KILLSCRIPT/Modules"

    Команда создаёт обычный клиентский модуль, устанавливает зависимости, собирает его и записывает понятную игре папку в Modules/MyModule. Добавляйте --reflex, только если нужна серверная логика:

    Окно терминала
    npx killscript@0.1.2 new MyModule --reflex --modules "/path/to/KILLSCRIPT/Modules"

    Версия указана явно: будущий релиз генератора не сможет незаметно изменить проект, созданный по этой инструкции. Обновляйте её осознанно после чтения заметок к нужному релизу.

    Если игра находится на другом компьютере или SMB-папка ещё не подключена, --modules можно пропустить и установить модуль позже:

    Окно терминала
    cd MyModule
    npm run install:game -- --modules "/path/to/KILLSCRIPT/Modules"

  2. Запустите hot reload

    Окно терминала
    cd MyModule
    npm run dev

    Машинный путь сохраняется в .killscript/local.json и игнорируется Git. Каждое успешное сохранение обновляет сгенерированную папку, а ошибка сборки оставляет в игре предыдущую рабочую версию.

    Клиентский и Reflex-код игра перезагружает из папки автоматически. Реальное изменение scripts/server.lua выводит уведомление и запрашивает перезапуск серверной части в текущем матче. Не перевключайте модуль только ради горячего обновления Reflex: в некоторых сборках игры так перезапускается лишь клиент.

  3. Включите папочный модуль

    Откройте или переоткройте список модулей и один раз включите MyModule. Игра сканирует прямые подпапки Modules, а не папки TypeScript-проектов. Сгенерированная папка сохраняет UUID, поэтому следующие сборки заменяют её на месте. Если уже открытый список не обновился, один раз перезапустите игру.

  4. Сделайте видимое изменение

    Стартовый шаблон использует F6. Нажмите её, чтобы включить или выключить компонент из примера и увидеть подсказку. Измените src/client/features/module-toggle.ts, сохраните файл и проверьте снова — импортировать .KillScript при разработке не надо.

  5. Соберите релиз

    Окно терминала
    npm run build

    Готовый файл появится в dist/MyModule.KillScript.

Если игра не обновляется

Заголовок раздела «Если игра не обновляется»

Запустите:

Окно терминала
npm run doctor

Команда проверит конфигурацию, все настроенные контексты компиляции и подключение к игре. Фильтры консоли, блокировки SMB и ошибки владения папкой разобраны в разделе Решение проблем.

Куда двигаться дальше

Заголовок раздела «Куда двигаться дальше»