API

  Kostenlos Plus Pro
Roll20 API    

Auf dieser Seite geht es um eine Funktion, die exklusiv für Pro-Abonnenten oder für Spieler in einem von einem Abonnenten erstellten Spiel verfügbar ist. Wenn du diese Funktion nutzen möchtest, erwäge ein Upgrade deines Kontos.

Die Roll20 API bietet eine leistungsstarke Möglichkeit, dein Spiel anzupassen und zu verbessern. Du erstellst Code-Skripte, die Roll20 während des Spiels steuern, z. B. das Bewegen einer Figur, das Hinzufügen von Statusmarkierungen zu Spielsteinen oder das Würfeln. Der Einstieg in die Verwendung von APIs ist einfach und unkompliziert, die Möglichkeiten sind jedoch endlos.


 

API-Anleitungen und Dokumentation


Danksagungen

Ein besonderer Dank geht an unseren Forum-Champion (und Arcane Scriptomancer), The Aaron, für seine Bereitschaft und sein Engagement, sein Wissen mit der Roll20-Community zu teilen!


Wie installiere ich ein API-Skript mithilfe der One-Click-Skriptbibliothek?

  1. Navigiere zur Spiel-Startseite für das gewünschte Spiel.
  2. Klicke auf das Dropdown-Menü „Einstellungen“ und wähle „API-Skripte“ aus.
  3. Suche im Dropdown-Menü „Skriptbibliothek“ nach dem benötigten Skript.
  4. Klicke auf die Schaltfläche „Skript hinzufügen“.
  5. Du kannst das Skript jetzt in deinem Spiel verwenden!

Wie installiere ich ein API-Skript, wenn ich meinen eigenen Code schreiben oder Code aus einer externen Quelle verwenden möchte?

Es ist ein ähnlicher Vorgang wie die Installation eines Skripts mithilfe unserer Ein-Klick-Skriptbibliothek.

  1. Navigiere zur Spiel-Startseite für das gewünschte Spiel.
  2. Klicke auf das Dropdown-Menü „Einstellungen“ und wähle „API-Skripte“ aus.
  3. Klicke auf der Seite „API-Einstellungen“ auf die Registerkarte „Neues Skript“.
  4. Du wirst zu einem Code-Editor-Fenster weitergeleitet, in dem du deinen Skript-Code einfügen und dem Skript einen Namen geben kannst.
  5. Kopiere den Skript-Code, füge ihn ein und gebe einen Namen für das Skript ein.
  6. Klicke auf die Schaltfläche „Skript speichern“.
  7. Die API-Sandbox wird neu gestartet und du kannst nun mit der Verwendung des Skripts im Spiel beginnen.

Wenn du das Skript von einer externen Quelle erhalten hast, findest in der Beschreibung des Skripts wichtige Informationen und Anweisungen.


Hilfe! Ich bekomme mein Skript nicht zum Laufen!

Wenn Sie allgemeine Unterstützung bei der API-Fehlerbehebung suchen, lesen Sie unseren Artikel hier. Wenn Sie nach weiterführenden Ratschlägen und Informationen zum Debuggen suchen, lesen Sie unseren Artikel hier. Wenn weiterhin Probleme auftreten, kannst du einen Beitrag in unserem API-Forum erstellen.


Was benötige ich als Erstes, wenn ich ein Skript schreiben möchte?

Skripte für die Roll20-API sind in JavaScript geschrieben. Für den Einstieg benötigst du lediglich grundlegende Kenntnisse der Sprache. Wenn du jedoch mehr über JavaScript erfahren möchtest, kann Ihnen dieser Codecademy-Kurs dabei helfen. 

Um zu beginnen, sollte Ihre erste Anlaufstelle das Advanced Use Guidesein.


Wie funktioniert es?

Du schreibst Skripte, die Ereignisse beobachten, die während des Spiels passieren. Skripte können überprüfen, ob Regeln eingehalten werden, Eigenschaften von Objekten und Spielmarker ändern und sogar benutzerdefinierte Chat-Befehle bereitstellen. Deine Skripte haben Auswirkungen auf das komplette Spiel und beeinflussen sowohl den SL als auch die Aktionen aller Spieler. Erweiterte Skripte können auch unabhängig voneinander ausgeführt werden und automatische Aktionen ausführen, z. B. das Verschieben eines Spielsteins auf einer Patrouillenroute oder das Anstoßen von Spielern, wenn dein Zug zu lange dauert.


Wo finde ich vorgefertigte Skripte?

Die API-Script-Community ist ziemlich aktiv und ihre Mitglieder erstellen und diskutieren ständig Skripte. Es gibt drei grundlegende Orte, an denen du nach neuen Skripten suchen können:

  • Das offizielle Roll20 API Script Repoauf GitHub. Hier findest du die aktuelle Version der Skripte, die Autoren zur Aufnahme in das Repo eingereicht haben.
  • Das Roll20 API Script Forum. Hier tauchen in der Regel Skripte zuerst auf und hier finden Diskussionen über Skripte statt, die geschrieben werden oder geändert werden müssen. Hier kannst du Beiträge posten und die Community um Hilfe bei der Erstellung eines Skripts bitten, das du programmieren möchtest, oder bei der Suche nach einem Skript, das deinen Wünschen entspricht.
  • Der API-Skriptindex des Wikis. Dies ist eine gute Informationsquelle über verfügbare Skripte.

Beitragen von API-Skripten zur Community

Wenn du ein Skript erstellst, das du dem Rest der Roll20-Community zur Verfügung stellen möchtest, kannst du es zur Aufnahme in das Roll20 API Script Repository einreichen. Wenn dein Skript von den Roll20-Mitarbeitern genehmigt und in das Repository aufgenommen wird, wird das Forum-Tag „API Scripter“ für dein Konto freigeschaltet und du kannst über Patreon oder Patreon-ähnliche Websites dafür werben (weitere Informationen findest du unten). Um herauszufinden, was du tun musst, um dein Skript korrekt an das Repository zu übermitteln, gehe zum offiziellen Roll20 API Script Repo.


Patreon- und Tipeee-Verknüpfungsregeln für Community Sheet-Mitwirkende

API-Skriptautoren, die zum Roll20 API Script Repo beitragen, dürfen über die Abonnement-/Spendendienstseiten Patreon und Tippee werben. Roll20 ist nicht für den Zahlungsverkehr verantwortlich und kann keine privaten Vereinbarungen durchsetzen.

Um sich zu qualifizieren, muss ein API-Skriptautor zunächst seinen Skriptbeitrag von den Roll20-Mitarbeitern genehmigen lassen und in das Roll20 API Script Repo aufnehmen.

Du solltest deine Patreon- oder Tipeee-Kontoinformationen in die Datei sheet.json hinterlegen, die deiner Skripteinreichung auf GitHub beigefügt werden sollte.

Wenn du mit Patreon oder Tipeee werben möchtest, sollte der JSON-Datei eines dieser Felder hinzugefügt werden:

Patreon: Gebe hier die URL für eine Patreon-Kampagne ein. Bei Auswahl wird sie unter der Beschreibung deines Skripts angezeigt. (z. B. „https://www.patreon.com/<name>“)

tipeee: Gebe hier die URL für ein Tipeee ein. Bei Auswahl wird es unter der Beschreibung deines Skripts angezeigt. (z. B. „https://www.tipeee.com/<name>“)

Weitere Informationen findest du unter https://github.com/Roll20/roll20-api-scripts#contributing.

Verlinkung zu Patreon/Tipeee in den Roll20-Foren

Die Verlinkung zu Patreon oder Tipeee in den Roll20-Foren ist nur vorab genehmigten Community-Mitgliedern gestattet, die entweder Charakterbögen oder API-Skripte beigesteuert haben. Wenn du Benutzer direkt um eine Finanzierung bitten möchtest, kannst dies privat tun. In einem öffentlichen Forum ohne beigesteuertes Material sind solche Links jedoch nicht gestattet.

War dieser Beitrag hilfreich?
49 von 63 fanden dies hilfreich