Merge branch 'deinkoks-master-patch-18883' into 'master'

Added BBB Section.

See merge request rc3/howto!18

docs/maps.en.md

@@ -11,6 +11,7 @@ This tutorial is "work in progess", hence its worth checking it from time to tim
 
 * 2020-12-08: Animations added.
 * 2020-12-11: Assembly registration added, Lobbymaps added, hightlighting current layer.
+* 2020-12-15: Sound, BBB, Map size added.
 
 ## Known Bugs
 Following bugs are known and worked on:
@@ -19,7 +20,11 @@ Following bugs are known and worked on:
   exitSceneUrl works instead, but ist deprecated.
 
 ## Limitations
-Instcances wont scale without no limit, please keep that in mind while building maps. From our experience the limit is somewhere around 200 players. Maps for 2k players wont make any sense. Please dont try to build lecture halls. There's no sense in idling in the game while watching talks.
+Instances wont scale indefinetly, please keep that in mind while building maps. From our experience the limit is somewhere around 200 players. Maps for 2k players wont make any sense. Please dont try to build lecture halls. There's no sense in idling in the game while watching talks.
+
+Regardless of this you can choose the map size relativly fleixble.
+Maps in the ballpark of 128x128 tils run quite smooth, maps with 1000x1000 tiles will come with a significant loading time.
+We hence recomend using a number of smaller maps rather than a single big one.
 
 External links will be sent through a dereferrer.
 
@@ -90,10 +95,12 @@ You can embed websites that will open when stepping on certain tiles. To do this
 ![](img/cp_openwebsite.png)
 
 ##### Embedding jitsi
-Jitsi rooms may be embedded into maps in the same way. Simple set the custom property "jitsiRoom" (string) and input the room name as the value. There will only be jitsi rooms on the servers hosted by us, no external servers.
+Jitsi rooms may be embedded into maps in the same way. Simple set the custom property "jitsiRoom" (string) and input the room name as the value.
 
 ![](img/cp_jitsiroom.png)
 
+By default jitsi rooms will be bound to the instance, this is to ensure that everyone has their own "hackcenter". Please prefix your room with "shared", should you want to share a jitsi room across instaces. (e.g. "shared our jitsiroom"). No external jitsi rooms will be allowed only the ones provided by us.
+
 ##### Silent areas
 Should you not want audio and video communication between participants in certain areas, you can set the custom property "silent" bool true in a layer defining the area.
 
@@ -123,6 +130,16 @@ To show animations in tiled, set the corresponding option:
 
 Tip: The engine does tile-updates every 100ms, animations with a shorter frame duration will most likely not look that good or may even do not work.
 
+Bigger animations need to animated in tiled tile by tile. This however is relativly straight forward.
+(Occationally some tiles dont run in sync with the rest, cthulu knows why...)
+
+### Sound
+Layers with the property "playAudio" (String) will play a sound associated with the tile. Both mp3 files, as well as mp3 streams are supported. If you want to loop the audio please use the property "playAudioLoop" (string).
+
+![](img/cp_playaudio.png)
+
+Please only use **GEMA-free** Music, as you will have to register your assembly with GEMA otherwise! If you embed streams you will also be required to keep a tracklist to be able to proove to GEMA that you only played "gema-free music".
+
 ### Saving and exporting maps
 Maps need to be saved as json files, tilesets should be embedded prior to this. The relevant files the will be you map in json format and will use the tilesets in png format. Infinite maps need to be converted to finite dimension maps before exporting. To do so just untick the "infinite" tick box and safe.
 

docs/maps.md

@@ -14,6 +14,7 @@ Dieses Tutorial ist ein work in progress und wird immer mal wieder erweitert, es
 
 * 2020-12-08: Animationen hinzugefügt.
 * 2020-12-11: Assembly Anmeldung hinzugefügt, Lobbykarten hinzugefügt, Layer hervorheben.
+* 2020-12-15: Sound, BBB, Kartengröße hinzugefügt.
 
 ## Known Bugs
 Folgende Bugs sind aktuell bekannt, wir versuchen bereits Lösungen dafür zu finden:
@@ -25,6 +26,10 @@ Folgende Bugs sind aktuell bekannt, wir versuchen bereits Lösungen dafür zu fi
 ## Limitierungen
 Instanzen skalieren nicht unendlich, bitte denkt beim Karten erstellen daran. Unsere Erfahrung zeigt, dass das Limit irgendwo bei 200 Nutzern 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 128x128 Tiles laufen ziemlich gut, Karten im Bereich von 1000x1000 gehen mit einer relevanten Ladezeit einher.
+Wir raten eher zu mehreren kleineren Karten anstelle einer riesigen.
+
 Ausgehenden Links wird ein Dereferrer vorgeschaltet.
 
 ## Tiles / Sprites
@@ -96,10 +101,12 @@ Ihr könnt Webseiten einbinden, die sich beim Betreten von bestimmten Tiles öff
 ![](img/cp_openwebsite.png)
 
 ##### Jitsi einbinden
-Auf die selbe Art könnt ihr auch Jitsi Räume in eure Karte einbinden. Setzt dazu einfach die custom property "_jitsiRoom_" (string) 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.
+Auf die selbe Art könnt ihr auch Jitsi Räume in eure Karte einbinden. Setzt dazu einfach die custom property "_jitsiRoom_" (string) und gebt ihr als Wert den Namen den euer Jitsi Raum haben soll.
 
 ![](img/cp_jitsiroom.png)
 
+ Jitsi Räume sind per default an die Instanz gebunden, damit jeder sein eigenes "Hackcenter" haben kann, falls ihr einen Jitsi Raum über mehrere Instanzen sharen wollt, prefixt ihn mit "shared" (Beispiel: "shared Unser Jitsiraum"). 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.
 
@@ -128,6 +135,16 @@ Im Map-Editor sollten die Animationsloops auch schon dargestellt werden, wenn di
 
 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..)
+
+### Sound
+Layer mit der Property "playAudio" (string) spielen beim betreten der zugehörigen Tiles Sound ab. Es werden sowohl einzelne mp3-Dateien, als auch mp3-Streams unterstützt. Soll sich der Audioschnipsel wiederholen so verwendet stattdessen einfach "playAudioLoop" (string) als Property.
+
+![](img/cp_playaudio.png)
+
+Bitte verwendet nur **GEMA-freie** Musik, da ihr sonst GEMA für eure Assembly anmelden müsst. 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.
+
 ### 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.
 
@@ -175,5 +192,9 @@ Ggf kann es sein, dass ihr passende CORS Header auf dem ausliefernden Webserver
 ## 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.
 
+## Big Blue Button
+Wir mögen BBB, aber WorkAdventure bietet bereits eine solide Einbettung für Jitsi, welches wir auf dezidierter Hardware betreiben. Der Aufwand BBB einbindbar zu machen ist aktuell nicht stemmbar für uns.
+Bitte rechnet nicht damit und benutzt stattdessen Jitsi für den rc3.
+
 ## Infrastruktur
 Die Infrastruktur der rC3 world wird von <a href="https://www.hetzner.com/de/cloud"><img src="img/hetzner-logo.svg" alt="hetzner online" width="100px" /></a> gesponsert.