InícioDocs para devsAprenda a criar módulos e sistemas
Tutoriais de implementação 6 min de leitura

Aprenda a criar módulos e sistemas

Escolha o que quer construir e siga do primeiro arquivo ao recurso funcionando na mesa.

O exemplo de resumo lê um ator autorizado e abre o modal nativo. Gravewright 0.3.0, interface em inglês.
O exemplo de resumo lê um ator autorizado e abre o modal nativo. Gravewright 0.3.0, interface em inglês. · Abrir captura completa ↗

Escolha o resultado que você quer entregar

Consulte o mapa completo de capacidades para localizar cada método, operação, superfície e família do Map Builder.

Quero construirTutorialO que vou conseguir testar
Meu primeiro móduloCriar, instalar e atualizar um módulo do zeroBotão na mesa, leitura autorizada e modal nativo
Uma ferramenta de diárioComo criar um módulo de diárioCriar um diário e acrescentar uma seção pela interface do módulo
Uma ação na ficha existenteComo criar um módulo que atua na fichaEditar um nome preservando os dados da ficha, inclusive snapshots de token
Uma biblioteca criada pelo móduloComo criar um módulo de compêndioCriar pack, capturar conteúdo, ler entrada e importar uma cópia
Conteúdo que acompanha meu sistemaComo incluir compêndios em um sistemaInstalar um único ZIP com sistema, JSONs e três packs originais

Comece pelo primeiro tutorial se ainda não instalou um módulo próprio. Os casos acima são pontos de entrada. O catálogo completo abaixo também ensina personagens, itens, cenas, tokens, combate, cartas, áudio, chat/dados, missões, tabelas de rolagem, arquivos, armazenamento, tradução, janelas e servidor. Cada página mostra arquivos necessários, o que mudar, instalação, ativação e resultado a conferir. Use campanha de desenvolvimento e conteúdo original.

Todos os projetos e suas receitas

Antes de escolher um “tipo de módulo”

“Diário”, “ficha” e “compêndio” descrevem o que seu módulo faz. Não são valores para colocar em um campo kind do manifesto. Um módulo de diário é um pacote comum que registra journal.sheet e usa journals. Uma ação de ficha registra actor.sheet e token.sheet. Uma biblioteca pode ser criada como conteúdo da campanha pela API. Um sistema com catálogo declara system e content.compendiums no mesmo manifesto.

DecisãoEscolha
Acrescentar um botão ou painelmode: augment, mantendo a interface existente
Desenhar a ficha do próprio sistemamode: replace e tipos do sistema, como no sistema de exemplo
Salvar dados de um diário/atorAPI pública do documento, usando a revisão lida
Salvar uma preferência do móduloArmazenamento do módulo, sem sobrescrever o documento
Distribuir catálogo com um sistemaArquivos físicos no ZIP e content.compendiums

O ciclo completo de desenvolvimento

  1. Defina uma ação observável: “clicar no botão cria uma seção”, por exemplo. Escolha um recurso que o contrato da release 0.3.0 realmente permite alterar.

  2. Crie uma pasta com manifest.json, a entrada JavaScript, estilos e licença. O manifesto aponta para arquivos; ele não executa a ação sozinho.

  3. Implemente start/register/stop. Use o root e o api da montagem; registre a superfície onde a ferramenta deve aparecer.

  4. Faça um ZIP com o manifesto na raiz. O dono instala esse ZIP na instalação de teste.

  5. O GM ativa a versão exata na mesa. Um sistema também precisa ser escolhido como sistema da campanha.

  6. Abra a janela ou diretório que recebe a montagem. Execute a ação e confirme o documento salvo, não apenas uma mensagem de sucesso.

  7. Teste leitura, conflito, cancelamento e jogador. Uma versão instalada é imutável: altere a versão do pacote antes de instalar novos bytes.

Quando consultar a referência

Os tutoriais ensinam o fluxo completo. Use Exemplos por kind para variar um contrato e a referência de módulos para limites e assinaturas. O guia de API detalha os métodos. Se uma ideia não cabe na release solicitada, descreva a limitação antes de inventar um endpoint ou exigir um novo host.

Como usar a IA para começar um módulo

text
Quero construir [ação concreta] no Gravewright 0.3.0. Parta do tutorial [link] e de seu ZIP. Antes de escrever, mostre qual superfície monta a ferramenta, qual API grava o recurso e onde o pacote será instalado/ativado. Entregue a árvore completa, todos os arquivos, instruções de instalação e passos de teste com resultado observável. Preserve revisões, permissões, seções privadas e snapshots. Não crie um kind de manifesto nem uma API inexistente.