Twórca modułu

Zbuduj swój pierwszy moduł Fabled

Zainstaluj interfejs CLI modułu, zbuduj prawidłowy pakiet i zapoznaj się z plikami, które tworzy.

Wymagania wstępne

Node.js 20.20 lub nowszy. Samo repozytorium internetowe Fabled wymaga obecnie ^20.20.0 lub >=22.22.0.
Konto Legendarne. Publikowanie wymaga również dostępnej usługi parowania interfejsu CLI modułu i aktywnej przestrzeni nazw wydawcy.
Publiczny bootstrap: @fabledgg/module-cli jest dostępny od npm pod tagiem dist bootstrap, podczas gdy wersja 0.1.0 pozostaje zarezerwowana dla wydania po połączeniu.

Uruchom publiczny pasek startowy

Wypróbuj bieżący publiczny interfejs CLI bezpośrednio z npm, bez instalowania go globalnie:

npx @fabledgg/module-cli@bootstrap module --help

Pozostała część tego przewodnika używa zainstalowanego polecenia binarnego fabled module. Jeśli współtworzysz samo repozytorium internetowe Fabled, możesz zamiast tego użyć npm run modules:cli -- module.

npx @fabledgg/module-cli@bootstrap module init my-dice \
  --publisher-id my-studio \
  --publisher-name \"My Studio\"

Wybierz styl instalacji

Zalecany jednorazowy formularz nie wymaga instalacji globalnej:

npx @fabledgg/module-cli@bootstrap module --help

W przypadku projektu zespołowego zainstaluj pasek startowy jako zależność programistyczną, aby package-lock.json rejestrował rozwiązaną wersję, a walidacja lokalna i CI korzystała z tej samej kompilacji kontraktu.

npm install --save-dev @fabledgg/module-cli@bootstrap
npx fabled module --help

Instalacja globalna jest opcjonalna. Ujawnia ten sam legendarny plik binarny, ale wersja przypięta lokalnie w projekcie jest łatwiejsza do odtworzenia i kontrolowania.

npm install --global @fabledgg/module-cli@bootstrap
fabled module --help

Stwórz rusztowanie projektu

fabled module init my-dice \
  --publisher-id my-studio \
  --publisher-name "My Studio"

Katalog nie może już istnieć. Scafold tworzy przykład Dice & Chat z kanonicznym plikiem fabled.module.json, sprawdzoną akcją kości, ramką Dice Tray należącą do hosta i plikiem ustawień regionalnych w języku angielskim. Zmień moduł lokalny za pomocą --module-id i nazwę wyświetlaną za pomocą --name.

my-dice/
├── fabled.module.json
├── actions/roll.json
├── frames/dice-tray.json
└── locales/en.json

Dokonaj pierwszego sprawdzenia

fabled module validate my-dice
fabled module pack my-dice --output my-dice.zip
fabled module inspect my-dice.zip

Czysta walidacja potwierdza, że pakiet jest zgodny z lokalną umową v1. Nie zatwierdza, nie instaluje, nie aktywuje ani nie uruchamia modułu.