Introduction aux scripts de modification (API)

7 novembre 2025 18:33

Cette page concerne une fonctionnalité réservée aux abonnés Pro ou aux joueurs participant à un jeu créé par un abonné. Si vous souhaitez utiliser cette fonctionnalité, nous vous invitons à envisager la mise à niveau de votre compte.

Les scripts de modification (API) offrent un moyen efficace de personnaliser et d'améliorer votre jeu. Vous créez des scripts de code qui fournissent des instructions à Roll20 pendant le jeu, comme déplacer une pièce, ajouter des marqueurs d'état aux jetons, ou lancer les dés. L'utilisation des Mods (API) est simple et intuitive pour débuter, mais les possibilités sont infinies.

Guides et documentation Mod (API)

Remerciements

Nous tenons à remercier tout particulièrement notre champion du forum (et scriptomancien arcanique), The Aaron, pour sa volonté et son dévouement à partager ses connaissances avec la communauté Roll20.

Comment puis-je installer un script Mod (API) à l'aide de la bibliothèque de scripts un clic ?

Veuillez vous rendre sur la page d'accueil du jeu souhaité.
Veuillez cliquer sur le menu déroulant Paramètres et sélectionner Scripts Mod (API).
Dans le menu déroulant Bibliothèque de scripts, veuillez localiser le script requis.
Veuillez cliquer sur le bouton Ajouter un script.
Vous pouvez désormais commencer à utiliser le script dans votre jeu.

Comment puis-je installer un script Mod (API) si je souhaite écrire mon propre code ou utiliser du code provenant d'une source externe ?

Ce processus est similaire à l'installation d'un script à l'aide de notre bibliothèque de scripts un clic.

Veuillez vous rendre sur la page d'accueil du jeu souhaité.
Veuillez cliquer sur le menu déroulant Paramètres et sélectionner Scripts Mod (API).
Dans la page Paramètres du mod (API), veuillez cliquer sur l'onglet Nouveau script.
Vous serez redirigé vers une fenêtre d'éditeur de code où vous pourrez insérer votre code de script et nommer le script.
Veuillez copier-coller le code du script et attribuer un nom au script.
Veuillez cliquer sur le bouton Enregistrer le script.
Le bac à sable Mod (API) redémarrera, et vous pourrez alors commencer à utiliser le script dans le jeu.

Si vous avez obtenu le script auprès d'une source externe, veuillez consulter la description du script pour obtenir des informations et des instructions importantes.

Aidez-moi ! Je n'arrive pas à faire fonctionner mon script.

Si vous avez besoin d'une assistance générale pour le dépannage de Mod (API), veuillez consulter notre article ici. Si vous recherchez des conseils et des informations plus avancés sur le débogage, veuillez consulter notre article ici. Si vous rencontrez toujours des difficultés, n'hésitez pas àcréer un message sur notre forum Mod (API).

Si je souhaite rédiger un script, de quoi ai-je besoin pour commencer ?

Les scripts pour les mods Roll20 (API) sont développés en JavaScript. Une connaissance de base du langage suffit pour débuter, mais si vous souhaitez approfondir vos connaissances en JavaScript, ce cours Codecademypeut vous aider à progresser.

Pour commencer, nous vous recommandons de consulter le Guide d'utilisation avancée.

Comment cela fonctionne-t-il ?

Vous créez des scripts qui détectent 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 chat personnalisées. Vos scripts ont un impact sur l'ensemble du jeu, influençant à la fois les actions du MJ et celles de tous les joueurs. Les scripts avancés peuvent également s'exécuter de manière autonome, effectuant des actions automatiques telles que déplacer un jeton sur un itinéraire de patrouille ou relancer les joueurs lorsque leur tour prend trop de temps.

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

La communauté Mod (API) Script est très active, ses membres créant et discutant de scripts en permanence. Il existe trois endroits principaux où rechercher de nouveaux scripts :

Référentiel officiel des scripts Roll20 Mod (API)sur GitHub. Vous trouverez ici la version actuelle des scripts que les auteurs ont soumis pour inclusion dans le référentiel.
Forum dédié au script Roll20 Mod (API). C'est ici que les scripts apparaissent généralement en premier et que les discussions ont lieu au sujet des scripts en cours de rédaction ou nécessitant des modifications. C'est également ici que vous pouvez publier et solliciter l'aide de la communauté pour créer un script que vous avez imaginé ou pour trouver un script répondant à un besoin.
Index des scripts Mod (API) du Wiki. Il s'agit d'une excellente source d'informations sur les scripts disponibles.

Contribution de scripts Mod (API) à la communauté

Si vous créez un script que vous souhaitez proposer au reste de la communauté Roll20, vous pouvez le soumettre afin qu'il soit inclus dans le référentiel de scripts Roll20 Mod (API). Une fois votre script approuvé par l'équipe Roll20 et ajouté au référentiel, le tag «API Scripter »sera débloqué pour votre compte et vous pourrez faire de la publicité via Patreon ou des sites similaires (voir ci-dessous pour plus d'informations). Pour découvrir la procédure à suivre afin de soumettre correctement votre script au référentiel, veuillez vous rendre sur le référentiel officiel des scripts Roll20 Mod (API) à l'adresse suivante:.

Règles relatives aux liens Patreon et Tipeee pour les contributeurs de la feuille communautaire

Les auteurs de scripts Mod (API) qui contribuent au répertoire de scripts Mod (API) Roll20 sont autorisés à faire de la publicité via les sites de services d'abonnement/de dons : Patreon et Tippee. Roll20 n'est pas responsable des transactions financières et ne peut appliquer aucun accord privé.

Pour être éligible, un auteur de script Mod (API) doit d'abord faire approuver sa contribution par le personnel de Roll20 et l'inclure dans le répertoire de scripts Mod (API) de Roll20.

Veuillez inclure les informations relatives à votre compte Patreon ou Tipeee dans le fichierfeuille.jsonqui doit être joint à votre script lorsque vous le soumettez sur GitHub.

Le fichier json doit contenir l'un des champs suivants si vous souhaitez faire de la publicité avec Patreon ou Tipeee :

patreon : Veuillez insérer ici l'URL d'une campagne Patreon. Elle apparaîtra sous la description de votre script lorsque celui-ci sera sélectionné. (par exemple, «https://www.patreon.com/<name>»)

tipeee : Veuillez insérer ici l'URL d'un Tipeee, et celle-ci apparaîtra sous la description de votre script lorsqu'elle sera sélectionnée. (par exemple, «https://www.tipeee.com/<nom>»)

Pour plus d'informations, veuillez consulter le site https://github.com/Roll20/roll20-api-scripts#contributing.

Lien vers Patreon/Tipeee sur les forums Roll20

La publication de liens vers Patreon ou Tipeee sur les forums Roll20 est réservée aux membres de la communauté pré-approuvés qui ont contribué à la création de feuilles de personnage ou de scripts Mod (API). Si vous souhaitez solliciter directement des utilisateurs pour obtenir un financement, vous pouvez le faire en privé, mais aucun lien de ce type n'est autorisé dans un forum public sans aucune contribution matérielle.