Einführung in Mod-Skripte (API)

Diese Seite handelt von einer Funktion, die exklusiv für Pro-Abonnenten oder für Spieler in einem von einem Pro-Abonnenten erstellten Spiel verfügbar ist. Wenn du diese Funktion nutzen willst, solltest du ein Upgrade deines Kontos in Betracht ziehen.

Mod-Skripte (API) bieten eine leistungsstarke Möglichkeit, dein Spiel anzupassen und zu verbessern. Du erstellst Skripte, die Roll20 während des Spiels Anweisungen geben, zum Beispiel eine Figur zu bewegen, Statusmarker zu Spielmarkern hinzuzufügen oder Würfel zu werfen. Die Verwendung von Mods (API) ist einfach und unkompliziert, um loszulegen, aber die Möglichkeiten sind endlos.


 

Mod (API): Leitfäden und Dokumentation


Danksagungen

Ein großes Dankeschön an unseren Forum-Champion (und arkanen Schriftmagier) The Aaron, für seine Bereitschaft und sein Engagement, sein Wissen mit der Roll20-Community zu teilen!


Wie installiere ich ein Mod (API)-Skript mithilfe der Ein-Klick-Skriptbibliothek?

  1. Navigiere zur Zielseite des gewünschten Spiels.
  2. Klicke auf das Dropdown-Menü Einstellungen und wähle Mod (API)-Skripte aus.
  3. Such in der Dropdown-Liste „Skriptbibliothek“ das gewünschte Skript.
  4. Klick auf den Knopf „Skript hinzufügen“.
  5. Jetzt kannst du das Skript in deinem Spiel verwenden!

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

Es ist ein ähnlicher Prozess wie das Installieren eines Skripts über unsere Ein-Klick-Skriptbibliothek.

  1. Navigiere zur Zielseite des gewünschten Spiels.
  2. Klicke auf das Dropdown-Menü Einstellungen und wähle Mod (API)-Skripte aus.
  3. Auf der Mod (API)-Einstellungsseite klicke auf den Tab Neues Skript.
  4. Du kommst zu einem Code-Editor-Fenster, wo du deinen Skriptcode einfügen und das Skript benennen kannst.
  5. Kopiere den Skriptcode und gib dem Skript einen Namen.
  6. Klick auf den Knopf „Skript speichern“.
  7. Der Mod (API)-Sandbox wird neu gestartet, und du kannst das Skript jetzt im Spiel verwenden.

Wenn du das Skript von einer externen Quelle bekommen hast, schau dir die Beschreibung des Skripts an, um wichtige Infos und Anweisungen zu bekommen.


Hilfe! Ich krieg mein Skript einfach nicht zum Laufen!

Wenn du allgemeine Unterstützung bei der API-Fehlerbehebung suchst, lese unseren Artikel hier durch. Wenn du nach weiterführenden Tipps und Infos zum Debuggen suchst, schau dir unseren Artikel hier an. Falls du immer noch Probleme hast, zögere nicht, einen Beitrag in unseremMod (API) Forum zu erstellen.


Was brauche ich, um ein Skript zu schreiben?

Skripte für Roll20 Mods (API) werden in JavaScript geschrieben. Du brauchst nur ein paar Grundkenntnisse der Sprache, um loszulegen, aber wenn du mehr über JavaScript lernen willst, kann dir dieser Codecademy-Kurs dabei helfen. 

Als Erstes solltest du dir den Leitfaden für Fortgeschrittene anschauen.


Wie funktioniert es?

Du schreibst Skripte, die auf Ereignisse während des Spiels reagieren. Skripte können prüfen, ob Regeln eingehalten werden, Eigenschaften von Objekten und Spielmarkern ändern und sogar eigene Chat-Befehle bereitstellen. Deine Skripte haben Auswirkungen auf das ganze Spiel und beeinflussen sowohl die Handlungen der SL als auch die aller Spieler. Fortgeschrittene Skripte können auch eigenständig laufen und automatische Aktionen ausführen, zum Beispiel einen Spielmarker auf einer Patrouillenroute bewegen oder Spieler anstupsen, wenn ihr Zug zu lange dauert.


Wo finde ich vorgefertigte Skripte?

Die Mod (API) Skript-Community ist recht aktiv, mit Mitgliedern, die ständig Skripte erstellen und diskutieren. Es gibt drei grundlegende Orte, an denen man nach neuen Skripten suchen kann:

  • Das offizielle Roll20 Mod (API) Skript-Repo auf GitHub. Hier findest du die aktuelle Version der Skripte, die Autoren zur Aufnahme in das Repository eingereicht haben.
  • Das Roll20 Mod (API) Skript-Forum. Hier tauchen Skripte meistens zuerst auf und hier wird auch über Skripte diskutiert, die gerade geschrieben werden oder geändert werden müssen. Hier kannst du auch Beiträge posten und die Community um Hilfe bitten, wenn du ein Skript erstellen möchtest, das dir vorschwebt, oder ein Skript suchst, das einen bestimmten Zweck erfüllt.
  • Der Mod (API)-Skript-Index des Wikis. Hier findest du gute Infos zu den verfügbaren Skripten.

Beitragen von Mod (API) Skripten an die Community

Wenn du ein Skript erstellst, das du der Rest der Roll20-Community anbieten möchtest, kannst du es einreichen, um in das Roll20 Mod (API) Skript-Repository aufgenommen zu werden. Nach der Genehmigung deines Skripts durch das Roll20-Team und der Aufnahme in das Repository wird das "API-Skriptautor" Forum-Stichwort für dein Konto freigeschaltet und ermöglicht dir die Werbung über Patreon oder ähnliche Seiten (siehe unten für weitere Informationen). Um herauszufinden, was du tun musst, um dein Skript korrekt im Repository einzureichen, gehe zum Offiziellen Roll20 Mod (API) Skript Repo.


Patreon- und Tipeee-Regeln zur Verknüpfung für Community-Bogen-Mitwirkende

Für Mod (API) Skriptautoren, die zum Roll20 Mod (API) Skript Repo beitragen, ist es genehmigt, über Abonnement-/Spendendienste wie Patreon und Tippee zu werben. Roll20 ist nicht für Zahlungsvorgänge verantwortlich und kann private Vereinbarungen nicht durchsetzen.

Um sich zu qualifizieren, muss ein Mod (API) Skriptautor zunächst seinen Skriptbeitrag vom Roll20-Team genehmigen lassen und im Roll20 Mod (API) Skript Repository aufnehmen.

Du solltest deine Patreon- oder Tipeee-Kontodaten in die Datei sheet.json aufnehmen, die du zusammen mit deinem Skript auf GitHub einreichen solltest.

Die json-Datei sollte eines dieser Felder enthalten, wenn du mit Patreon oder Tipeee werben möchtest:

patreon: Gib hier die URL für eine Patreon-Kampagne ein, dann erscheint sie unter der Beschreibung deines Skripts, wenn es ausgewählt ist. (z.B."https://www.patreon.com/<name>")

tipeee: Gib hier die URL für eine Tipeee-Seite ein; sie erscheint dann unter der Beschreibung deines Skripts, wenn es ausgewählt ist. (z.B. "https://www.tipeee.com/<name>")

Mehr Infos 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 Nutzer direkt um Spenden bitten möchtest, kannst du das privat tun, aber solche Links sind in einem öffentlichen Forum ohne Beiträge nicht erlaubt.

War dieser Beitrag hilfreich?
71 von 92 fanden dies hilfreich