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

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.