API

  Gratis Plus Pro
Roll20 API    

Esta página trata sobre una función exclusiva para suscriptores Pro o para jugadores en un Juego creado por un suscriptor. Si desea utilizar esta función, considere la posibilidad de actualizar su cuenta.

La APIRoll20 proporciona una potente forma de personalizar y mejorar su juego. Creas scripts de código que instruyen a Roll20 durante el juego, como mover una pieza, agregar marcadores de estado a los tokens o lanzar dados. El uso de las API es sencillo y directo para empezar, pero las posibilidades son infinitas.


 

Guías y Documentación de la API


Agradecimientos

Un agradecimiento especial a nuestro Campeón del Foro (y Scriptomante Arcano), The Aaron, por su disposición y dedicación para compartir su conocimiento con la Comunidad Roll20!


¿Cómo instalo un script de API usando la biblioteca de scripts de un solo clic?

  1. Ve a la página de inicio del juego deseado.
  2. Haz clic en el menú desplegable Configuración y selecciona Scripts de API.
  3. En el menú desplegable Biblioteca de Scripts, localiza el script necesario.
  4. Haz clic en el botón Agregar Script.
  5. ¡Ahora puedes comenzar a usar el script en tu juego!

¿Cómo instalo un script de API si quiero escribir mi propio código o usar código de una fuente externa?

Es un proceso similar a la instalación de un script usando nuestra biblioteca de scripts de un solo clic.

  1. Navega hasta la página de inicio del juego deseado.
  2. Haz clic en el menú desplegable de Configuración y selecciona API Scripts.
  3. En la página de Configuración de API, haz clic en la pestaña Nuevo Script.
  4. Serás llevado a una ventana de editor de código donde puedes insertar tu código de script y nombrar el script.
  5. Copia y pega el código del script y proporciona un nombre para el script.
  6. Haz clic en el botón Guardar Script.
  7. El sandbox de API se reiniciará y ahora puedes empezar a usar el script en el juego.

Si obtuviste el script de una fuente externa, consulta la descripción del script para obtener información e instrucciones importantes.


¡Ayuda! No puedo hacer funcionar mi script.

Si buscas ayuda general para solucionar problemas de la API, consulta nuestro artículo aquí. Si buscas consejos e información avanzada de depuración, consulta nuestro artículo aquí. Si sigue teniendo problemas, no dude encrear un mensaje en nuestro Foro de la API .


Si quiero escribir un script, ¿qué necesito para comenzar?

Los scripts para la API de Roll20 están escritos enJavaScript. Sólo necesita unos conocimientos básicos del lenguaje para empezar, pero si quiere aprender más sobre JavaScript, este curso de Codecademypuede ayudarle a aprender. 

Para comenzar, tu primera parada debe ser la Guía de Uso Avanzado.


¿Cómo funciona?

Escribes scripts que escuchan los eventos que ocurren durante el juego. Los scripts pueden verificar que se sigan las reglas, cambiar propiedades en los objetos y fichas, e incluso proporcionar comandos de chat personalizados. Tus guiones tienen un impacto en todo el juego, influyendo en las acciones tanto del GM como de todos los jugadores. Los scripts avanzados también pueden ejecutarse de forma independiente, realizando acciones automáticas como mover una ficha en una ruta de patrulla o avisar a los jugadores cuando su turno está tardando demasiado.


¿Dónde puedo encontrar scripts prehechos?

La comunidad de scripts de la API es bastante activa, con miembros creando y discutiendo scripts todo el tiempo. Hay 3 lugares básicos para buscar nuevos scripts:

  • La Official Roll20 API Script Repoen GitHub.Aquí es donde encontrará la versión actual de los scripts que los autores han enviado para su inclusión en el repo.
  • El foro de scripts de la API de Roll20 . Aquí es donde los scripts tienden a aparecer primero y donde tiene lugar la discusión sobre los scripts que se están escribiendo o necesitan cambios. Aquí también puedes publicar y pedir ayuda a la comunidad para crear un script que hayas pensado o encontrar un script que satisfaga una necesidad.
  • Índice de scripts de la API de la wiki . Se trata de una buena fuente de información sobre los scripts disponibles.

Contribución de Scripts de la API a la Comunidad

Si creas un script que te gustaría ofrecer al resto de la comunidad de Roll20, puedes enviarlo para que se incluya en el Repositorio de Scripts de la API de Roll20. Tener su script aprobado por el personal de Roll20 e incluido en el repositorio desbloqueará la etiqueta del foro "API Scripter"para su cuenta y le permitirá anunciarse a través de Patreon o sitios similares a Patreon (ver más abajo para más información). Para averiguar qué debes hacer para enviar correctamente tu guión al repositorio, ve a la Official Roll20 API Script Repo.


Reglas de Vinculación de Patreon y Tipeee para Colaboradores de Hojas de Personaje de la Comunidad

Para los autores de scripts de la API que contribuyen al Repositorio de Scripts de la API de Roll20, se les permite anunciarse a través de sitios de servicios de suscripción/donación: Patreon y Tipeee. Roll20 no se hace responsable por ninguna transacción de pago y no puede hacer valer ningún acuerdo privado.

Para calificar, un autor de guiones de API primero debe tener su contribución de guión aprobada por el personal de Roll20 y estar incluido en el Repositorio de Scripts de API de Roll20.

Querrás incluir la información de tu cuenta de Patreon o Tipeee en el archivosheet.jsonque deberá ser incluido junto con tu script en GitHub.

El archivo json debe tener uno de estos campos agregados si deseas hacer publicidad con Patreon o Tipeee:

patreon: Coloca aquí la URL de una campaña de Patreon y aparecerá debajo de la descripción de tu script cuando sea seleccionado. (por ejemplo, "https://www.patreon.com/<name>")

tipeee: Coloca aquí la URL de Tipeee y aparecerá debajo de la descripción de tu script cuando sea seleccionado. (por ejemplo, "https://www.tipeee.com/<name>")

Para obtener más información, consulta la https://github.com/Roll20/roll20-api-scripts#contributing.

Enlazando a Patreon/Tipeee en los foros de Roll20

Solo se permite vincular a Patreon o Tipeee en los foros de Roll20 para miembros preaprobados de la comunidad que hayan contribuido con Hojas de Personaje o Guiones de API. Si deseas solicitar directamente a los usuarios por financiamiento, puedes hacerlo de forma privada, pero no se permiten este tipo de enlaces en un foro público sin ningún material contribuido.

¿Fue útil este artículo?
Usuarios a los que les pareció útil: 52 de 67