Howto Workadventure Maps

Diese Seite basiert auf https://howto.rc3.world/maps.html mit diversen Ergänzungen.

Instanzen skalieren nicht unendlich, bitte denkt beim Karten erstellen daran. Unsere Erfahrung zeigt, dass das Limit irgendwo bei 200 Nutzer:innen liegt. Karten für 2k Spieler:innen ergeben also keinen Sinn. Bitte versucht nicht, Vortragssäle nachzubauen. Es ergibt schlichtweg keinen Sinn, im Spiel zu idlen und währenddessen Talks zu schauen.

Die Map-Größe kann davon unabhängig relativ flexibel dimensioniert werden. Karten im Bereich von 128×128 Tiles laufen ziemlich gut, Karten im Bereich von 1000×1000 gehen mit einer relevanten Ladezeit einher. Wir raten eher zu mehreren kleineren Karten anstelle einer riesigen.

Falls ihr nicht wisst wo/wie ihr anfangen sollt gibt es verschiedene Starter-Kits das ihr einfach forken könnt:

• https://git.cccv.de/rc3/world-map-starterkit
• https://github.com/workadventure-xce/workadventure-xce-map-starter-kit

Grundlegend bestehen die Karten aus sogenannten Tiles oder Sprites. Historisch gibt es wohl Unterschiede zwischen den Begriffen, wir werden sie hier aber synonym verwenden. Tiles können Transparenz beinhalten und liegen im png-Format vor.

Damit ein Tile weitergehende Eigenschaften als sein Aussehen hat, müssen entsprechende Attribute zugeordnet werden. Dies erfolgt über Layer: Das Layer trägt Attribute, und speichert für welche Felder sie gelten sollen.

Tiles gibt es massig im Internet, häufig zu Tilesets (mehrere Tiles zu einem Thema) zusammengefasst. Seiten auf denen ihr schöne Tiles finden könnt sind zum Beispiel:

• http://itch.io
• http://opengameart.org
• http://deviantart.com
• Shared Tiles Repo

Achtet auf die Größe der Tiles! Achtet auf die Lizenz der Tilesets!

Tiles können auch selbst gestaltet bzw. vorhandene verändert werden, was häufig auch „pixeln“ genannt wird. Hierzu empfiehlt sich der Editor krita, es geht aber prinzipiell auch mit anderen.

• ListenpunktAchtet auch hierbei darauf, dass die Tiles 32×32 Pixel groß sind. Ihr könnt euch unter view → show grid ein Raster einblenden und unter settings → dockers → grid and guides den Einstellungs-Docker einblenden, in dem ihr die Grid-Größe festlegen könnt.
• ListenpunktFalls ihr Übergänge von Materialien gestalten müsst, nutzt Transparenz und baut Übergänge von einem Material zu Transparenz, das ist vielseitiger nutzbar und erspart euch, zu jedem anderen Material einen Übergang gestalten zu müssen.
• ListenpunktPixel-Art Workshop von blinry: http://media.ccc.de/v/34C3-jugend-hackt-1016-pixel_art_workshop

Um Tiles als undurchgängig zu markieren, müsst ihr diese im Tileeditor öffnen und die custom property collides (bool true) für das jeweilige Tile (nicht mit Layern verwechseln!) setzen. Vergesst nicht euer Tileset anschließend zu speichern! Tiled bietet zwar auch die Möglichkeit collision shapes für einzelne Tiles festzulegen, diese werden von der Software allerdings ignoriert.

Tilesets müssen in Tiled in die Map eingebunden werden, ein Verweis auf externe Tilesets im TSX Format ist nicht möglich. (Das heißt nicht, dass die Bilddateien mit eingebunden sind. PNG-Dateien müssen ebenfalls auf den Server geladen werden.)

Karten können mittels des Editors Tiled erstellt werden. Ähnlich wie in diversen Zeichenprogrammen können Karten aus mehreren Layern bestehen, die beim Rendern übereinander gelegt werden. Layer können transparent gestaltet werden.

Achtet beim Erstellen einer neuen Karte auf folgende Einstellungen:

• Karte muss orthogonal sein.
• Tilessize sollte 32×32 sein.
• Während des Erstellens kann es sinnvoll sein, eine unendliche Karte zu verwenden statt vorab eine Größe festzulegen. Dies muss beim finalen Speichern der Karte wieder auf eine feste Größe geändert werden.

Eine Karte kann aus beliebig vielen übereinander gelegten Tile Layern bestehen. Eure Karte braucht dabei mindestens einen Startlayer, der definiert, wo auf der Karte neue Spieler:innen spawnen. Dieses Layer muss zwingend start heißen. Außerdem braucht ihr ein Object Layer floorLayer das definiert, auf welchem Layer sich die Spielfigur bewegt.

Für ein leichteres Gestalten hebt euch den aktuellen Layer hervor:

Es gibt ein paar spezielle Layer bzw. Zusatzfunktionen für Layer. Diese werden bis auf das Start Layer über die custom properties der einzelnen Layer abgebildet.

Eure Karte braucht zwingend ein Start Layer mit dem Namen start. Alle Stellen in diesem Layer, die ein Tile (egal welches) enthalten, sind später Startpunkte für neue Spielfiguren. Gibt es mehrere Tiles, wird beim Betreten zufällig eines davon als Startpunkt ausgewählt. Schiebt dieses Layer am besten ganz nach unten in eurem Stack, die Tiles, die Startpunkte markieren, werden dann einfach von den darüberliegenden verdeckt.

Außerdem könnt ihr weitere Start Layer erstellen, um weitere Einstiegspunkte zu definieren, zum Beispiel um an bestimmte Stellen auf eurer Karte zu springen. Diese Layer funktionieren ähnlich wie der eigentliche Start Layer (also einfach beliebige Tiles an die Stelle, wo die Spielfigur spawnen soll), können beliebig heißen, brauchen allerdings eine custom property startLayer (bool true). Der Name dieses Layers ist auch die „Sprungadresse“, die ihr zum Betreten über dieses Layer braucht. Wenn eure Karte also foo.json heißt und der Start Layer, auf den ihr springen wollt, bar, dann wäre die Sprungmarke dafür foo.json#bar.

Ähnlich wie beim Start Layer könnt ihr Exits definieren. Ihr erzeugt ein Layer, packt an die Stellen an denen ihr Ausgänge haben wollt ein Tile, und gebt dem Layer die custom property exitUrl. Dieser gebt ihr als Wert (string) die Karte bzw. den Startpunkt auf dieser Karte zu der ihr springen wollt, zum Beispiel also foo.json#bar um auf die Karte foo.json und dort auf einen Startpunkt auf dem Layer bar zu springen.

Ihr könnt Webseiten einbinden, die sich beim Betreten von bestimmten Tiles öffnen. Analog zu Start und Exit Layern legt ihr ein Layer dafür an, setzt Tiles an die entsprechenden Stellen und gebt dem Layer die custom property openWebsite (string). Verwendet https!

Jitsi Räume sind per default an die Instanz gebunden, damit jeder sein eigenes „Hackcenter“ haben kann. Es können keine externen Jitsi Server angegeben, sondern nur von uns bereitgestellte genutzt werden.

Solltet ihr in gewissen Bereichen keine Audio/Video Kommunikation zwischen den Teilnehmern wollen, so könnt ihr hierfür einen eigenen Layer anlegen und diesem die custom property silent (bool true) geben.

Das ist ausnahmsweise kein Layer, sondern eine Tile-Eigenschaft. Beschreibung siehe weiter oben bei den Tiles.

Tiles können zu Animationen (Loops) zusammengeführt werden, um z.B. fließendes Wasser oder blinkende Lichter darzustellen. Dazu müssen alle „Frames“ einer Animation jeweils ein eigenes 32×32 Tile sein. Bearbeitet dazu in Tiled das Tileset, wählt das zu animierende Tile (oder ein beliebiges leeres Tile) aus und klickt auf den Animation Editor:

Dann können alle Tiles, die Bestandteil der Animation sein sollen, per drag and drop in die „playlist“ gezogen werden und die Anzeigedauer in Millisekunden kann eingestellt werden:

Im Map-Editor sollten die Animationsloops auch schon dargestellt werden, wenn die Option im „view“ Menü gesetzt ist:

Hinweis: Die Engine macht Tile-Updates nur alle 100ms, also werden Animationen mit Framedurations unter 100ms vermutlich nicht gut aussehen oder gar nicht funktionieren. Größere Animationen über mehrere Tiles müssen in Tiled Tile für Tile animiert werden, funktionieren aber relativ problemlos. (Gelegentlich laufen einzelne Tiles nicht synchron zum Rest, wir wissen doch auch nicht..)

Layer mit der Property playAudio (string) spielen beim Betreten der zugehörigen Tiles Sound ab. Unterstützt werden mp3-Dateien, die relativ zum Pfad der Karte eingebunden werden können. Externe mp3-Dateien können nicht eingebunden werden. Soll sich der Audioschnipsel wiederholen so verwendet stattdessen einfach playAudioLoop (string) als Property.

Bitte verwendet nur GEMA-freie Soundschnipsel! Falls ihr Streams einbindet müsst ihr außerdem eine Trackliste anlegen um der GEMA nachweisen zu können, dass ihr nur freie Musik gespielt habt.

Karten müssen als json gespeichert werden, Tilesets sollten vorher eingebunden werden. Die relevanten Dateien sind anschließend eure Karten im json-Format und die verwendeten Tilesets als png.

Unendliche Karten müsst ihr vor dem Speichern in endliche umwandeln, hierzu einfach in den properties der Karte den Haken bei „infinite“ entfernen und speichern.

Sofern ihr CC-BY Tiles / Bilder verwendet oder eure eigene Lizenz verwenden wollt, könnt ihr dies in der Datei COPYRIGHT tun. Die Datei muss auf der selben Verzeichnisebene wie eure Karte liegen.

Achtet beim Ablegen eurer Karten bitte auf die Verzeichnisstruktur, folgende Dinge solltet ihr konkret beachten:

• Eure Startkarte muss im Hauptverzeichnis liegen.
• Andere Karten können in eigenen Ordnern oder auch im Hauptverzeichnis liegen.
• Achtet bei Verlinkungen der Karten in eurer Karte auf die korrekte relative URL.
• Achtet auf die Pfade eurer Tilesets (zur Not direkt im json anpassen).

Hier ein Beispiel wie ein Verzeichnis mit Karten exemplarisch aussehen könnte:

.
├── bla
│   ├── COPYRIGHT
│   └── keks.json
├── blubb.json
├── COPYRIGHT
├── foo
│   ├── bar.json
│   └── tileset2.png
├── main.json
└── tileset.png

Zum Testen könnt ihr eure Dateien einfach auf einen beliebigen per https erreichbaren Server legen und über die URL auf unserer Testinstanz einbinden. Nehmen wir an, eure Karte läge unter https://example.com/mymaps/foo.json, so wäre die URL zum Testen https://wa.binary-kitchen.de/_/global/example.com/mymaps/foo.json. Die Möglichkeit externe Karten einzubinden existiert nur zum Testen und wird zum rC3 deaktiviert werden.

Ggf. kann es sein, dass ihr passende CORS Header auf dem ausliefernden Webserver setzen müsst.