Skip to content

HaDiNet/adventure-maps

Repository files navigation

HaDiKo-WorkAdventure-Maps

Hier werden die Maps für das WorkAdventure des HaDiKos gehosted. Dieses ist zu erreichen unter https://play.adventure.hadiko.de.

Geforked von DigitaleGesellschaft, was wiederrum eine Kopie des offiziellen starter kit ist.

In der index.html gibt es weitere Informationen zu Lizenzen und Urheberrechten.

Eigene Maps beisteuern

Um das HaDiKo vollständig digital nachzubauen, sind wir auf deine Hilfe angewiesen! Hier ist erklärt, wie du helfen kannst.

Die Maps bestehen aus mehreren Layern von 32x32 Pixel "Tiles".

Tools die du brauchst

Um Maps zu erstellen oder zu bearbeiten benötigst du:

Repository forken

Zuerst musst du dieses Repository forken. In dem geforkten Repository führst du deine Änderungen durch und öffnest danach einen Pull Request.

Die Map in Tiled öffnen und bearbeiten

Unsere Maps liegen im world-Ordner, z.B. world/k1.json Ein paar Beispiel-/Testmaps findest du in test, oder maps.

Du kannst die JSON-Dateien in Tiled öffnen. Um eine neue Map zu erstellen, lege mit Tiled eine Map im JSON-Format im world-Ordner an.

Nun kannst du die Maps bearbeiten.

Die Tiled software ist relativ intuitiv. Nichtdestotrotz hier ein paar Resourcen, falls du Anleitung brauchst:

Noch ein paar Dinge, die du beachten solltest:

  • Falls du noch nicht weißt wie viele Pixel deine Karte letztendlich groß sein soll, kannst du einer Karte eine unbegrenzte Größe zuweisen beim Erstellen. Bevor du die Karte testen kannst, solltest du darauf achten dass du diese Eigenschaft rückgängig machst (Karte -> Karteneigenschaften -> Unbegrenzt)

Wie WorkAdventure-Maps funktionieren

Damit deine Map von WorkAdventure geladen werden kann, musst du einige Regeln beachten. Am besten liest du den offiziellen WorkAdventure Map Building Guide, der ist nicht so lang, man kann sich innerhalb von 20 Minuten durch alle Seiten durchklicken.

Die Map ausprobieren

Bevor du einen Pull Request erstellst, willst du deine Änderungen oder neuen Maps bestimmt ausprobieren. Hierzu kannst du einen lokalen Mapsserver starten, der deine Maps deinem Browser zur Verfügung stellst. Führe dazu im Repository die folgenden Commands aus:

npm install
npm run start

Danach kannst du die Maps mit einer beliebigen WorkAdventure Instanz ausprobieren, am besten der vom HadiKo:

http://play.adventure.hadiko.de/_/global/localhost:8080/pfad/zur/map.json

Also zum Beispiel:

http://play.adventure.hadiko.de/_/global/localhost:8080/world/k1.json

Urheberrecht und Lizenzen

Damit wir deine Map verwenden können, musst du damit einverstanden sein, sie unter einer CC-BY-SA Lizenz zu veröffentlichen.

Füge hierzu in der index.html einen Vermerk unter "Original Contributions" hinzu. Entweder als zusätzlicher Name bei einer existierenden Map, oder als komplett neue Zeile. Diese hat das Format:

<li><a href="$PFAD_ZUR_MAP.json"</a>: $NAME, $JAHR</li>

Wenn du zusätzliche Tilesets oder sonstige Resourcen einbindest, musst du je nach Lizenz des Quellmaterials diese vermutlich nennen. Füge dazu, ebenfalls in der index.html einen Vermerk der folgenden Form hinzu:

<li>
  <a href="$PFAD_ZUR_DATEI">$NAME_DES_WERKS</a>:
  $URHEBER;
  $LIZENZINFORMATION;
  <a href="$LINK_ZUR_ORIGINALQUELLE">$LINK_ZUR_ORIGINALQUELLE</a>
</li>

Die index.html kann unter https://maps.adventure.hadiko.de abgerufen werden und wird beim joinen auf der Start-Map von https://play.adventure.hadiko.de angezeigt.