Erstellen Sie Ihr erstes Fabled-Modul

Voraussetzungen

• Node.js 20.20 oder neuer. Das Fabled-Web-Repository selbst erfordert derzeit ^20.20.0 oder >=22.22.0.
• Ein sagenumwobenes Konto. Für die Veröffentlichung sind außerdem ein verfügbarer Modul-CLI-Kopplungsdienst und ein aktiver Herausgeber-Namespace erforderlich.
• Öffentlicher Bootstrap: @fabledgg/module-cli ist von npm unter dem Bootstrap-Dist-Tag verfügbar, während 0.1.0 für die Post-Merge-Version reserviert bleibt.

Führen Sie den öffentlichen Bootstrap aus

Probieren Sie die aktuelle öffentliche CLI direkt von npm aus, ohne sie global zu installieren:

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

Der Rest dieses Handbuchs verwendet die installierte Binärschreibweise fabled module. Wenn Sie zum Fabled-Web-Repository selbst beitragen, können Sie stattdessen npm run modules:cli -- module verwenden.

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

Wählen Sie einen Installationsstil

Das empfohlene einmalige Formular erfordert keine globale Installation:

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

Installieren Sie für ein Teamprojekt den Bootstrap als Entwicklungsabhängigkeit, damit package-lock.json die aufgelöste Version aufzeichnet und die lokale und CI-Validierung denselben Vertragsbuild verwenden.

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

Eine globale Installation ist optional. Es stellt die gleiche berühmte Binärdatei bereit, aber eine projektlokal angeheftete Version ist einfacher zu reproduzieren und zu prüfen.

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

Erstellen Sie ein Gerüst für ein Projekt

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

Das Verzeichnis darf noch nicht vorhanden sein. Das Gerüst erstellt das Dice & Chat-Beispiel mit einer kanonischen fabled.module.json, einer überprüften Dice-Aktion, einem hosteigenen Dice Tray-Frame und einer englischen Gebietsschemadatei. Ändern Sie den lokalen Modul-Slug mit --module-id und den Anzeigenamen mit --name.

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

Machen Sie die erste Prüfung

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

Eine saubere Validierung beweist, dass das Paket mit dem lokalen v1-Vertrag übereinstimmt. Das Modul wird nicht genehmigt, installiert, aktiviert oder ausgeführt.