Crea tu primer módulo Fabled

Requisitos previos

• Node.js 20.20 o posterior. El repositorio web Fabled actualmente requiere ^20.20.0 o >=22.22.0.
• Una cuenta Fabled. La publicación también requiere un servicio de emparejamiento Module CLI disponible y un espacio de nombres de editor activo.
• Bootstrap público: @fabledgg/module-cli está disponible en npm bajo la etiqueta bootstrap dist, mientras que 0.1.0 permanece reservado para la versión posterior a la fusión.

Ejecute el bootstrap público

Pruebe la CLI pública actual directamente desde npm sin instalarla globalmente:

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

El resto de esta guía utiliza la sintaxis binaria instalada fabled module. Si estás contribuyendo al repositorio web Fabled, puedes usar npm run modules:cli -- module.

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

Elige un estilo de instalación

El formulario único recomendado no necesita instalación global:

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

Para un proyecto de equipo, instale el programa de arranque como una dependencia de desarrollo para que package-lock.json registre la versión resuelta y la validación local y de CI utilice la misma compilación de contrato.

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

Una instalación global es opcional. Expone el mismo binario legendario, pero una versión anclada localmente al proyecto es más fácil de reproducir y auditar.

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

Armar un proyecto

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

El directorio no debe existir aún. El andamio crea el ejemplo de Dice & Chat con un fabled.module.json canónico, una acción de dados revisada, un marco Dice Tray propiedad del host y un archivo de configuración regional en inglés. Cambie el slug del módulo local con --module-id y el nombre para mostrar con --name.

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

Haz la primera comprobación

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

Una validación limpia demuestra que el paquete coincide con el contrato local v1. No aprueba, instala, activa ni ejecuta el módulo.