Skip to content

@opys/cli ​

npm

Команда opys. Вона збирає конфігурацію в один файл для поширення, а потім встановлює і запускає або конфігурацію, або зібраний файл.

sh
npm install -g @opys/cli

Потрібен Node.js 20 або новіший. Конфігурація це звичайний файл JavaScript, тому встановіть у свій проєкт те, що він імпортує:

sh
npm install -D @opys/dev @opys/minecraft

Приклад ​

sh
opys launch                 # зібрати конфігурацію, встановити, запустити гру
opys install                # те саме, без запуску гри
opys build                  # записати бандл, названий в `output` конфігурації

Зібраний бандл працює без конфігурації. Значення гравця надходять з --var:

sh
opys launch game.opys --var root=/path/to/install --var username=Player \
  --var uuid=00000000-0000-0000-0000-000000000001 --var token=0

Команди ​

КомандаЗбираєВстановлюєЗапускає гру
opys buildтакніні
opys installтактакні
opys launchтактактак
opys install <bundle>нітакні
opys launch <bundle>нітактак
  • Без названого бандла команда читає opys.config.mjs у поточній теці.
  • opys install встановлює файли й зупиняється. Власна робота завантажувача модів під час першого запуску, як-от латання гри Forge, відбувається, коли гра вперше стартує.
  • Бандл це шлях або URL http(s). URL читається частинами, як його читає лаунчер: завантажується лише те, чого бракує встановленню.
  • З названим бандлом жодна конфігурація не завантажується, тому її run не відбувається. Передайте те, що він би встановив, через --var.

Параметри ​

ПараметрКомандиЩо робить
-i, --inputусі, з конфігурацієюФайл конфігурації. Типово opys.config.mjs.
-o, --outputbuildБандл для запису. Типово: output конфігурації.
--mode <value>усі, з конфігурацієюПередається функції конфігурації. Типово: команда.
--var <key=value>install, launchВстановлює змінну. Повторіть для кількох.
--feature <a,b>install, launchВмикає прапорці, через кому.
--log-level <l>усіsilent, error, warn, info або debug.
-vусіТе саме, що --log-level debug.

opys build без -o і без output у конфігурації друкує маніфест як JSON. Це для читання і порівняння. Встановити з цього не можна, бо вбудованих файлів там немає.

Коди виходу ​

КодЗначення
0Успіх.
1Помилка в команді чи конфігурації або невдале збирання.
2Не вдалося завантаження.
3Файл не збігся зі своїм хешем.
4Не вдалося розпакувати архів.
5Гра стартувала, а потім вийшла з власною помилкою.

Кожна команда ​

Кожна команда, у кожному способі використання.

sh
# збирання
opys build                               # записує `output` конфігурації
opys build -o dist/game.opys             # записує сюди замість
opys build -i packs/server.config.mjs    # інша конфігурація
opys build --mode release                # функція конфігурації отримує { mode: 'release' }
opys build > manifest.json               # вихід не названо: маніфест як JSON

# встановлення без запуску гри
opys install
opys install --feature java_console
opys install game.opys --var root=/srv/game
opys install https://example.com/game.opys --var root=/srv/game

# запуск
opys launch
opys launch --mode dev                   # типово `mode` це 'launch'
opys launch --var username=Tester        # перекриває одну змінну
opys launch --feature java_console,custom_java
opys launch game.opys --var root=/srv/game --var username=Player \
  --var uuid=00000000-0000-0000-0000-000000000001 --var token=0

# скільки говорить
opys launch -v
opys build --log-level silent

Документація ​

Частина opys.