Primeiros passos
O BTC Studio desenvolve extensões para o TypeWriter, o motor de quests e de narrativa para servidores Paper. Esta documentação descreve cada extensão: o que ela faz, como instalá-la e cada entry que ela adiciona, campo por campo.
TypeWriter em cinco minutos
O TypeWriter substitui os arquivos de configuração por um painel web. Você abre o painel a partir do servidor (/typewriter connect), monta pages compostas por entries, liga-as entre si e publica: o servidor aplica as mudanças sem precisar reiniciar.
| Conceito | O que é |
|---|---|
| Page | Um contêiner de entries. As sequence pages guardam diálogos e ações, as static pages guardam definições (artifacts, speakers, definições de NPC), as manifest pages guardam o que está sempre ativo (audiences, displays) e as cinematic pages guardam linhas do tempo. |
| Entry | Um bloco de construção, identificado pelo seu tipo (por exemplo schematic_block). Cada entry tem campos que você preenche no inspetor. |
| Trigger | Uma ligação de uma entry para a seguinte: um evento dispara uma ação, que dispara um diálogo… |
| Fact | Um valor armazenado ou calculado por jogador, usado em criteria para decidir se uma entry é executada, e alterado por modifiers. |
| Audience | Um filtro de jogadores (em uma região, segurando um item, em uma etapa de quest). Displays como nameplates, fake blocks ou HUDs são exibidos para uma audience. |
| Artifact | Dados persistentes pertencentes a uma extensão (schematics colocados, estoque de lojas, estatísticas). |
As extensões adicionam novos tipos de entry a essa caixa de ferramentas. Depois que uma extensão é instalada, suas entries aparecem na barra de busca do painel e atrás do botão + do tipo de page correspondente.
Instalar uma extensão
- Instale o TypeWriter em um servidor Paper e confirme que o painel abre.
- Baixe a extensão: nas releases do GitHub para as extensões gratuitas, na Voxel ou na BuiltByBit para as pagas. Os botões ficam no topo de cada página de extensão.
- Instale os plugins listados em Requires na página da extensão.
- Coloque o JAR em
plugins/Typewriter/extensions/e reinicie o servidor. - Abra o painel: as novas entries estão disponíveis na barra de busca.
Cada página de extensão mostra a versão que ela documenta e a versão do TypeWriter de que precisa. Ao atualizar o TypeWriter, atualize também suas extensões para uma release compatível.
Encontre seu caminho nesta documentação
- O catálogo de extensões lista todas as extensões, com filtros por disponibilidade e tema.
- Cada página de extensão segue a mesma estrutura: visão geral, recursos, instalação, primeiros passos, comandos, permissões, placeholders, entries, solução de problemas.
- Cada página de entry mostra a entry como ela aparece no painel (identificador, tipo, ícone) e a tabela dos seus campos com tipo, valor padrão e descrição. Essas tabelas são geradas a partir do código-fonte da extensão, portanto correspondem ao código publicado.
| Disponibilidade | Significado |
|---|---|
| Free | Código aberto, disponível para download no GitHub. |
| Paid | Integrações premium, vendidas na Voxel e na BuiltByBit. |
| Private | Roda na rede BornToCraft com o build BTC do TypeWriter; documentada como referência, não distribuída. |
| Soon | Em desenvolvimento; as entries ainda podem mudar. |
Obter ajuda
Faça suas perguntas no Discord do BTC Studio. Para um bug em uma extensão gratuita, abra uma issue no repositório GitHub dela informando a versão da extensão, a versão do TypeWriter e o primeiro erro do log do servidor.