Criador do Módulo

Crie seu primeiro módulo Fabled

Instale o Módulo CLI, crie um pacote válido e entenda os arquivos que ele cria.

Pré-requisitos

Node.js 20.20 ou mais recente. O próprio repositório web Fabled atualmente requer ^20.20.0 ou >=22.22.0.
Uma conta Fable. A publicação também requer um serviço de emparelhamento Module CLI disponível e um namespace de editor ativo.
Bootstrap público: @fabledgg/module-cli está disponível no npm sob a tag dist-tag de bootstrap enquanto 0.1.0 permanece reservado para a versão pós-mesclagem.

Execute o bootstrap público

Experimente a CLI pública atual diretamente do npm sem instalá-la globalmente:

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

O restante deste guia usa o comando binário instalado fabled module. Se você estiver contribuindo para o próprio repositório da web Fabled, poderá usar npm run modules:cli -- module.

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

Escolha um estilo de instalação

O formulário único recomendado não precisa de instalação global:

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

Para um projeto de equipe, instale o bootstrap como uma dependência de desenvolvimento para que package-lock.json registre a versão resolvida e a validação local e de CI use a mesma construção de contrato.

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

Uma instalação global é opcional. Ele expõe o mesmo binário lendário, mas uma versão fixada no local do projeto é mais fácil de reproduzir e auditar.

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

Estruturar um projeto

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

O diretório ainda não deve existir. O andaime cria o exemplo Dice & Chat com um fabled.module.json canônico, uma ação de dados revisada, um quadro Dice Tray de propriedade do host e um arquivo de localidade em inglês. Altere o slug do módulo local com --module-id e o nome de exibição com --name.

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

Faça a primeira verificação

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

Uma validação limpa prova que o pacote corresponde ao contrato v1 local. Ele não aprova, instala, ativa ou executa o módulo.