HowTo rC3 world maps

[english translation coming soon]

Zum Congress wird es eine Art 2D-Adventure, die rC3 world geben. Dieses Tutorial soll erklären, wie Karten und Inhalte zur rC3 world beigesteuert werden können. Falls danach noch Fragen offen sind, meldet euch gerne in unserem Rocketchat Channel und wir versuchen das Tutorial zu ergänzen.

Disclaimer

Dieses Tutorial ist ein work in progress und wird immer mal wieder erweitert, es lohnt sich daher mehrfach hier vorbeizuschauen.

Known Bugs

Folgende Bugs sind aktuell bekannt, wir versuchen bereits Lösungen dafür zu finden:

  • Ausgänge können nicht auf dem rechten Rand der Karte liegen
  • exitUrl führt bei mehreren Exits von einer Karte zur anderen teils zu falschen Startpunkten
    • exitSceneUrl tut stattdesssen, obwohl angeblich deprecated

Tiles / Sprites

Grundlegend bestehen die Karten aus sogenannten Tiles oder Sprites. Historisch gibt es wohl Unterschiede zwischen den Begriffen, wir werden sie hier aber synonym verwenden. Für die rC3 world werden Tiles in der Größe 32x32 empfohlen, Tiles in anderen Größen können zu Problemen führen. Tiles können Transparenz beinhalten und liegen im png Format vor.

Tiles finden

  • 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:
  • Achtet auf die Größe der Tiles!
  • Achtet auf die Lizenz der Tilesets
    • wir werden nicht aktiv prüfen unter welcher Lizenz eure Tiles stehen, allerdings nach dem Prinzip "takedown on notice" auf Verstöße reagieren.
  • Ort, um Tilesets zu sharen, wird kommen
    • noch nicht ganz klar wie/wo

Tiles gestalten / "pixeln"

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.

  • Achtet auch hierbei darauf, dass die Tiles 32x32 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.
  • Falls 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.
  • Pixel-Art Workshop von blinry: media.ccc.de/v/34C3-jugend-hackt-1016-pixel_art_workshop

Tiles einbinden

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.)

Maps

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.

Neue Karte in Tiled anlegen

Achtet beim Erstellen einer neuen Karte auf folgende Einstellungen:

  • Karte muss orthogonal sein
  • Tilessize sollte 32x32 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.

Karte gestalten

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 Spielerinnen 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.

Spezielle Layer

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.

Start Layer

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.

Exit Layer

Ä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 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.

Es wird voraussichtlich Platzhalter für Links zu anderen Assemblies geben, sobald es Neuigkeiten dazu gibt werden wir diese hier nachtragen. [TODO]

Webseite einbinden

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". Verwendet https!

Jitsi einbinden

Auf die selbe Art könnt ihr auch Jitsi Räume in eure Karte einbinden. Setzt dazu einfach die custom property "jitsiRoom" und gebt ihr als Wert den Namen den euer Jitsi Raum haben soll. Es können keine externen Jitsi Server angegeben, sondern nur von uns bereitgestellte genutzt werden.

Stille Bereiche

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.

Wände / Kollisionen

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.

Karte speichern / exportieren

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.

Wie kommts später in die world?

Eure Karten legt ihr dann bitte in einem git Repo eurer Wahl ab und teilt später in unserem Backend die URL mit, unter der das Repo geklont werden kann. Unsere world-Infrastruktur wird anschließend eine Instanz für euch spawnen, das Karten-Repo pullen und diese dort einbinden.

Wie genau Karten aktualisiert werden können ist noch nicht ganz klar, vermutlich wird jede Instanz ihre Karten alle n Minuten aktualisieren.

Verzeichnisstruktur

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

  • Eure Startkarte muss main.json heißen und 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
│   └── keks.json
├── blubb.json
├── foo
│   ├── bar.json
│   └── tileset2.png
├── main.json
└── tileset.png

Testen

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://play.wa-test.rc3.cccv.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.

rocket channel

Es gibt einen Rocketchat Channel für Fragen und zum Austausch mit anderen Bastelnden: #rc3-world. Fragt dort gerne auch jederzeit zu diesem Howto oder generell zur rC3 world; wir werden versuchen, alle Fragen zu beantworten und das Howto bei Bedarf zu ergänzen.

Eigene Instanzen

Wir werden sämtliche Instanzen für die rC3 world betreiben, versucht bitte nicht eigene Instanzen dafür aufzusetzen, Sprünge zu Instanzen außerhalb der rC3 world werden nicht möglich sein.

Infrastruktur

Die Infrastruktur der rC3 world wird von hetzner online gesponsert.