API

  Grátis Plus Pro
Roll20 API    

Esta página diz respeito a uma funcionalidade exclusiva para subscritores Pro ou para jogadores de um Jogo criado por um subscritor. Se você gostaria de usar esse recurso, considere atualizar sua conta.

ARoll20 API fornece uma maneira poderosa de personalizar e aprimorar seu jogo. Você cria scripts de código que instruem o Roll20 durante o jogo, como mover uma peça, adicionar marcadores de status a tokens ou rolar dados. Usar APIs é simples e direto para começar, mas as possibilidades são infinitas.


 

Guias e Documentação da API


Agradecimentos

Um agradecimento especial ao nosso Campeão do Fórum (e Arcane Scriptomancer), The Aaron, por sua disposição e dedicação em compartilhar seu conhecimento com a Comunidade Roll20!


Como eu instalo um script da API usando a biblioteca de scripts de um clique?

  1. Vá para a página de destino do jogo desejado.
  2. Clique na lista suspensa Configurações e selecione Scripts da API.
  3. Na lista suspensa Biblioteca de Scripts, localize o script necessário.
  4. Clique no botão Adicionar Script.
  5. Agora você pode começar a usar o script em seu jogo!

Como eu instalo um script da API se eu quiser escrever meu próprio código ou se eu quiser usar código de uma fonte externa?

É um processo semelhante à instalação de um script usando nossa biblioteca de scripts de um clique.

  1. Navegue até a página inicial do jogo desejado.
  2. Clique na lista suspensa Configurações e selecione Scripts da API.
  3. Na página Configurações da API, clique na guia Novo Script.
  4. Você será levado para uma janela do editor de código onde poderá inserir o código do seu script e nomear o script.
  5. Copie e cole o código do script e forneça um nome para o script.
  6. Clique no botão Salvar Script.
  7. O ambiente de teste da API será reiniciado e você agora pode começar a usar o script no jogo.

Se você obteve o script de uma fonte externa, consulte a descrição do script para obter informações importantes e instruções.


Ajuda! Eu não consigo fazer meu script funcionar!

Se você está procurando assistência geral com solução de problemas da API, confira nosso artigo aqui. Se você está procurando conselhos e informações mais avançadas sobre depuração, confira nosso artigo aqui. Se continuar a ter problemas, sinta-se à vontade paracriar uma mensagem no nosso API Forum.


Se eu quiser escrever um script, o que eu preciso para começar?

Os scripts para a API Roll20 são escritos emJavaScript. Só precisa de um conhecimento básico da linguagem para começar, mas se quiser aprender mais sobre JavaScript, este curso Codecademypode ajudá-lo a aprender. 

Para começar, a sua primeira paragem deve ser o Advanced Use Guide.


Como funciona?

Você escreve scripts que ouvem eventos que acontecem durante o jogo. Os scripts podem verificar se as regras estão sendo seguidas, alterar propriedades de objetos e tokens e até mesmo fornecer comandos de chat personalizados. Seus scripts têm um impacto em todo o jogo, influenciando tanto o GM quanto as ações de todos os jogadores. Scripts avançados também podem ser executados independentemente, realizando ações automáticas, como mover um token em uma rota de patrulha ou cutucar jogadores quando sua vez está demorando muito.


Onde posso encontrar scripts prontos?

A comunidade de Scripts da API é bastante ativa, com membros criando e discutindo scripts o tempo todo. Existem 3 lugares básicos para procurar novos scripts:

  • O Repositório Oficial de Scripts da API do Roll20 no GitHub. É aqui que você encontrará a versão atual dos scripts que os autores enviaram para inclusão no repositório.
  • O Fórum de Scripts da API do Roll20. Aqui é onde os scripts costumam aparecer primeiro e onde acontecem as discussões sobre scripts que estão sendo escritos ou precisam de alterações. Aqui também é onde você pode postar e pedir ajuda da comunidade para criar um script que você pensou ou encontrar um script para suprir uma necessidade.
  • Índice de Scripts da API da Wiki . Esta é uma boa fonte de informação sobre os scripts disponíveis.

Contribuindo com Scripts da API para a Comunidade

Se você criar um script que gostaria de oferecer para o restante da comunidade Roll20, você pode enviá-lo para ser incluído no Repositório de Scripts da API do Roll20. Ter seu script aprovado pela equipe do Roll20 e incluído no repositório desbloqueará a tag do fórum "Desenvolvedor de Scripts da API" para sua conta e permitirá que você faça propaganda via Patreon ou sites semelhantes ao Patreon (veja abaixo para mais informações). Para descobrir o que você precisa fazer para enviar corretamente seu script para o repositório, vá para o Repositório Oficial de Scripts da API Roll20.


Regras de vinculação do Patreon e Tipeee para contribuidores de folhas comunitárias

Para os autores de scripts da API que estão contribuindo para o Repositório de Scripts da API do Roll20, eles têm permissão para anunciar por meio de sites de serviço de assinatura/doação: Patreon e Tippee. O Roll20 não é responsável por quaisquer transações de pagamento e não pode fazer valer quaisquer acordos privados.

Para se qualificar, um autor de script da API deve primeiro ter sua contribuição de script aprovada pela equipe da Roll20 e incluída no Repositório de Scripts da API Roll20.

Deve incluir as informações da sua conta Patreon ou Tipeee no ficheirosheet.jsonque deve ser incluído na submissão do seu script no GitHub.

O arquivo json deve ter um desses campos adicionados se você deseja fazer propaganda com o Patreon ou Tipeee:

patreon: Insira a URL de uma campanha do Patreon aqui e ela aparecerá abaixo da descrição do seu script quando selecionada. (por exemplo,"https://www.patreon.com/<name>")

tipeee: Insira a URL do Tipeee aqui e ela aparecerá abaixo da descrição do seu script quando selecionada. (por exemplo, "https://www.tipeee.com/<name>")

Para mais informações, veja https://github.com/Roll20/roll20-api-scripts#contributing.

Linkando com o Patreon/Tipeee nos Fóruns do Roll20

A vinculação ao Patreon ou Tipeee nos Fóruns do Roll20 só é permitida para membros da comunidade pré-aprovados que tenham contribuído com Folhas de Personagem ou Scripts da API. Se você deseja solicitar financiamento diretamente dos usuários, pode fazê-lo de forma privada, mas nenhum link desse tipo é permitido em um fórum público sem qualquer material contribuído.

Este artigo foi útil?
Utilizadores que acharam útil: 52 de 67