API

  Gratuit Plus Pro
Roll20 API    

Cette page concerne une fonctionnalité exclusive aux abonnés Pro, ou aux joueurs d'un jeu créé par un abonné. Si vous souhaitez utiliser cette fonctionnalité, envisagez de mettre à niveau votre compte.

L'API Roll20 offre un moyen puissant de personnaliser et d'améliorer votre jeu. Vous créez des scripts de code qui donnent des instructions à Roll20 pendant le jeu, comme déplacer une pièce, ajouter des marqueurs d'état aux jetons ou lancer des dés. L'utilisation des APIs est simple et facile pour commencer, mais les possibilités sont infinies.


 

Guides et documentation API


Remerciements

Un grand merci à notre Champion du Forum (et Arcane Scriptomancer), The Aaron, pour sa volonté et son dévouement à partager ses connaissances avec la communauté Roll20!


Comment installer un script API en utilisant la bibliothèque de script en un clic?

  1. Accédez à la page d'accueil du jeu souhaité.
  2. Cliquez sur le menu Paramètres et sélectionnez Scripts API.
  3. Dans le menu déroulant Bibliothèque de scripts, localisez le script requis.
  4. Cliquez sur le bouton Ajouter un script.
  5. Vous pouvez maintenant commencer à utiliser le script dans votre jeu!

Comment installer un script API si je veux écrire mon propre code ou si je veux utiliser du code provenant d'une source externe?

C'est un processus similaire à l'installation d'un script en utilisant notre bibliothèque de script en un clic.

  1. Accédez à la page de présentation du jeu souhaité.
  2. Cliquez sur le menu déroulant Paramètres et sélectionnez Scripts API.
  3. Dans la page Paramètres de l'API, cliquez sur l'onglet Nouveau Script.
  4. Vous serez dirigé vers une fenêtre d'éditeur de code où vous pouvez insérer votre code de script et nommer le script.
  5. Copiez-collez le code du script et donnez-lui un nom.
  6. Cliquez sur le bouton Enregistrer le Script.
  7. Le bac à sable API redémarrera et vous pourrez maintenant utiliser le script en jeu.

Si vous avez obtenu le script à partir d'une source externe, consultez la description du script pour obtenir des informations importantes et des instructions.


Aide! Je n'arrive pas à faire fonctionner mon script!

Si vous recherchez une assistance générale pour le dépannage de l'API, consultez notre article ici. Si vous êtes à la recherche de conseils et d'informations plus avancés sur le débogage, consultez notre article ici. Si vous rencontrez toujours des problèmes, n'hésitez pas àcréer un message sur notre forum API.


Si je veux écrire un script, de quoi ai-je besoin pour commencer?

Les scripts pour le Roll20 API sont écrits enJavaScript. Vous n'avez besoin que d'une compréhension de base du langage pour commencer, mais si vous voulez en savoir plus sur JavaScript, ce cours Codecademypeut vous aider à l'apprendre. 

Pour commencer, rendez-vous d'abord dans le Guide d'utilisation avancée.


Comment ça marche?

Vous écrivez des scripts qui écoutent les événements qui se produisent pendant le jeu. Les scripts peuvent vérifier que les règles sont respectées, modifier les propriétés des objets et des jetons, et même fournir des commandes de discussion personnalisées. Vos scripts ont un impact global sur le jeu, influençant à la fois les actions du MJ et de tous les joueurs. Les scripts avancés peuvent également s'exécuter indépendamment, effectuant des actions automatiques telles que déplacer un jeton sur un itinéraire de patrouille ou rappeler à l'ordre les joueurs lorsque leur tour prend trop de temps.


Où puis-je trouver des scripts pré-faits?

La communauté des scripts API est assez active avec des membres qui créent et discutent constamment de scripts. Il y a 3 endroits de base où chercher de nouveaux scripts:

  • The Official Roll20 API Script Reposur GitHub.C'est là que vous trouverez la version actuelle des scripts que les auteurs ont soumis pour inclusion dans le repo.
  • Le Roll20 API Script Forum. C'est là que les scripts ont tendance à apparaître en premier et que se déroulent les discussions sur les scripts en cours d'écriture ou nécessitant des modifications. C'est également ici que vous pouvez publier et demander de l'aide à la communauté pour créer un script auquel vous avez pensé ou trouver un script répondant à un besoin.
  • Index des scripts API du wiki . Il s'agit d'une bonne source d'informations sur les scripts disponibles.

Contribuer aux scripts API pour la communauté

Si vous créez un script que vous souhaitez proposer au reste de la communauté Roll20, vous pouvez le soumettre pour qu'il soit inclus dans le référentiel des scripts API Roll20. Avoir votre script approuvé par l'équipe Roll20 et inclus dans le référentiel débloquera la balise forum "API Scripter ".pour votre compte et vous permettra de faire de la publicité via Patreon ou des sites similaires à Patreon (voir ci-dessous pour plus d'informations). Pour savoir ce que vous devez faire pour soumettre correctement votre script au dépôt, rendez-vous sur le Dépôt officiel des scripts API Roll20.


Règles de liaison Patreon et Tipeee pour les contributeurs de feuilles de communauté

Pour les auteurs de scripts API qui contribuent au référentiel des scripts API Roll20, ils sont autorisés à faire de la publicité via les sites de service d'abonnement/don: Patreon et Tippee. Roll20 n'est pas responsable des transactions financières et ne peut pas faire respecter les accords privés.

Pour être éligible, un auteur de script API doit d'abord obtenir l'approbation de son script par le personnel de Roll20 et l'inclure dans le Dépôt des scripts API Roll20.

Vous devrez inclure les informations de votre compte Patreon ou Tipeee dans le fichiersheet.jsonqui doit être inclus avec votre soumission de script sur GitHub.

Le fichier json devrait avoir l'un de ces champs ajouté si vous souhaitez faire de la publicité avec Patreon ou Tipeee :

patreon : Placez l'URL d'une campagne Patreon ici, et elle apparaîtra sous la description de votre script lorsqu'il est sélectionné. (par exemple : "https://www.patreon.com/<name>")

tipeee : Placez l'URL d'un Tipeee ici, et il apparaîtra sous la description de votre script lorsqu'il est sélectionné. (par exemple, "https://www.tipeee.com/<name>")

Pour plus d'informations, consultez https://github.com/Roll20/roll20-api-scripts#contributing.

Lien vers Patreon/Tipeee sur les forums Roll20

Le lien vers Patreon ou Tipeee sur les forums Roll20 n'est autorisé que pour les membres de la communauté pré-approuvés ayant contribué soit des feuilles de personnage, soit des scripts API. Si vous souhaitez solliciter directement des utilisateurs pour obtenir des financements, vous pouvez le faire en privé, mais de tels liens ne sont pas autorisés dans un forum public sans aucun matériel contribué.

Cet article vous a-t-il été utile ?
Utilisateurs qui ont trouvé cela utile : 52 sur 67