Erste Schritte
BTC Studio entwickelt Erweiterungen für TypeWriter, die Quest- und Storytelling-Engine für Paper-Server. Diese Dokumentation beschreibt jede Erweiterung: was sie leistet, wie du sie installierst und jeden Entry, den sie hinzufügt, Feld für Feld.
TypeWriter in fünf Minuten
TypeWriter ersetzt Konfigurationsdateien durch ein Web-Panel. Du öffnest das Panel vom Server aus (/typewriter connect), baust Pages aus Entries, verknüpfst sie miteinander und veröffentlichst: Der Server übernimmt die Änderungen ohne Neustart.
| Konzept | Was es ist |
|---|---|
| Page | Ein Container für Entries. Sequence-Pages enthalten Dialoge und Aktionen, statische Pages enthalten Definitionen (Artifacts, Speaker, NPC-Definitionen), Manifest-Pages enthalten alles, was dauerhaft aktiv ist (Audiences, Displays), Cinematic-Pages enthalten Timelines. |
| Entry | Ein einzelner Baustein, der über seinen Typ identifiziert wird (zum Beispiel schematic_block). Jeder Entry hat Felder, die du im Inspector ausfüllst. |
| Trigger | Eine Verbindung von einem Entry zum nächsten: Ein Event löst eine Aktion aus, die einen Dialog auslöst … |
| Fact | Ein pro Spieler gespeicherter oder berechneter Wert, der in Criteria verwendet wird, um zu entscheiden, ob ein Entry ausgeführt wird, und der durch Modifier verändert wird. |
| Audience | Ein Filter für Spieler (in einer Region, mit einem Item in der Hand, bei einem Quest-Schritt). Displays wie Nameplates, Fake-Blöcke oder HUDs werden einer Audience angezeigt. |
| Artifact | Persistente Daten, die einer Erweiterung gehören (platzierte Schematics, Shop-Bestand, Statistiken). |
Erweiterungen fügen diesem Werkzeugkasten neue Entry-Typen hinzu. Sobald eine Erweiterung installiert ist, erscheinen ihre Entries in der Suchleiste des Panels und hinter dem +-Button des passenden Page-Typs.
Eine Erweiterung installieren
- Installiere TypeWriter auf einem Paper-Server und stelle sicher, dass sich das Panel öffnen lässt.
- Lade die Erweiterung herunter: bei kostenlosen Erweiterungen von ihren GitHub-Releases, bei kostenpflichtigen von Voxel oder BuiltByBit. Die Buttons findest du oben auf jeder Erweiterungsseite.
- Installiere die Plugins, die auf der Erweiterungsseite unter Requires aufgeführt sind.
- Lege die JAR-Datei in
plugins/Typewriter/extensions/ab und starte den Server neu. - Öffne das Panel: Die neuen Entries stehen in der Suchleiste zur Verfügung.
Jede Erweiterungsseite zeigt die dokumentierte Version und die benötigte TypeWriter-Version an. Wenn du TypeWriter aktualisierst, aktualisiere gleichzeitig auch seine Erweiterungen auf ein passendes Release.
So findest du dich in dieser Dokumentation zurecht
- Der Erweiterungskatalog listet jede Erweiterung auf, mit Filtern nach Verfügbarkeit und Thema.
- Jede Erweiterungsseite folgt demselben Aufbau: Überblick, Funktionen, Installation, Erste Schritte, Befehle, Berechtigungen, Platzhalter, Entries, Fehlerbehebung.
- Jede Entry-Seite zeigt den Entry so, wie er im Panel erscheint (Bezeichner, Art, Icon), sowie die Tabelle seiner Felder mit Typ, Standardwert und Beschreibung. Diese Tabellen werden aus dem Quellcode der Erweiterung generiert und entsprechen daher dem veröffentlichten Code.
| Verfügbarkeit | Bedeutung |
|---|---|
| Free | Open Source, als Download auf GitHub verfügbar. |
| Paid | Premium-Integrationen, verkauft auf Voxel und BuiltByBit. |
| Private | Läuft im BornToCraft-Netzwerk auf dem BTC-Build von TypeWriter; zur Referenz dokumentiert, nicht verteilt. |
| Soon | In Entwicklung; Entries können sich noch ändern. |
Hilfe erhalten
Stelle deine Fragen im BTC Studio Discord. Bei einem Fehler in einer kostenlosen Erweiterung eröffne ein Issue im zugehörigen GitHub-Repository und gib die Erweiterungsversion, die TypeWriter-Version und den ersten Fehler aus dem Server-Log an.