CLI
CLI killscript отвечает за весь путь от TypeScript-исходников до читаемого
игрой модуля. Созданный проект предоставляет основные команды как npm scripts,
поэтому глобальная установка обычно не нужна.
Повседневный цикл
Заголовок раздела «Повседневный цикл»# Создать проект и сразу установить его папку в игру.npx killscript@0.1.2 new MyModule --modules "/path/to/Modules"
cd MyModule
# Наблюдать, собирать и синхронизировать корректные изменения.npm run dev
# Проверить типы и Lua без установки и упаковки.npm run check
# Создать dist/MyModule.KillScript.npm run buildДобавьте --reflex к new, если проекту также нужен
src/server/main.ts.
Команды по задачам
Заголовок раздела «Команды по задачам»Создание проекта
Заголовок раздела «Создание проекта»| Команда | Назначение |
|---|---|
killscript new <directory> | Создать новую папку из стартового шаблона |
killscript init [directory] | Инициализировать существующую пустую папку |
Обе команды принимают:
--author <name>— автор в метаданных модуля;--reflex— добавить серверную точку входа Reflex;--modules <path>— запомнить игровую папкуModulesи, если не указан--no-install, установить туда первую сборку;--no-install— не устанавливать зависимости;--no-git— не инициализировать Git.
Подключение и разработка
Заголовок раздела «Подключение и разработка»| Команда | Назначение |
|---|---|
killscript link <Modules> | Сохранить игровой путь текущего компьютера |
killscript install | Один раз собрать и синхронизировать папочный модуль |
killscript dev | Следить за кодом, конфигурацией и ресурсами; синхронизировать последнюю рабочую сборку |
killscript dev --once | Один раз собрать и синхронизировать, затем завершиться |
install и dev принимают --modules <path>. Переданный путь также
сохраняется в .killscript/local.json. Файл игнорируется Git, потому что путь
принадлежит конкретному компьютеру.
Проверка и релиз
Заголовок раздела «Проверка и релиз»| Команда | Назначение |
|---|---|
killscript check | Проверить типы настроенных сред и компиляцию без упаковки |
killscript build | Создать dist/<name>.KillScript |
killscript build --no-pack | Создать только сгенерированную папку |
killscript doctor | Проверить config, entries, компилятор и подключение к игре |
killscript clean | Удалить локальный сгенерированный результат |
killscript clean --game | Также удалить принадлежащую проекту папку в игре |
doctor --modules <path> проверяет путь временно и не заменяет сохранённый.
Безопасная синхронизация
Заголовок раздела «Безопасная синхронизация»CLI относится к установленной папке как к управляемому результату:
- неудачная сборка оставляет в игре последнюю рабочую версию;
- изменённые файлы предпочитают атомарное переименование и используют восстановимую замену, если оно недоступно;
- папка с другим UUID или неподходящим ownership не перезаписывается;
clean --gameудаляет только папку, доказанно принадлежащую проекту.
install и dev --once возвращают ошибочный exit code, если их единственная
сборка не удалась. Поэтому команды подходят для скриптов и CI.
Точные параметры описанной здесь версии показывает
npx killscript@0.1.2 --help или
npx killscript@0.1.2 <command> --help.