diff --git a/docs/maps.en.md b/docs/maps.en.md index b9b71399a616b456fa30009041b5f3a3c2141b41..9e9c13ea6ea2ce98a52dc43d53925e35cd4e06eb 100644 --- a/docs/maps.en.md +++ b/docs/maps.en.md @@ -249,20 +249,28 @@ You can embed websites, which will open when upon stepping on predefined tiles. Same as for start and exit layers, add a layer, place tiles at the desired positions, and then set the property `openWebsite` (type string). Use https! +In general we recommend also setting the property `openWebsiteTrigger` to +`onaction`, which will cause the web site to open only after explicit user +interaction (a press on the space bar), which makes visiting the world much +easier on older laptops. +You can also set a custom message to be displayed where setting the +`openWebsiteTriggerMessage` property (which will overwrite the default "Press +SPACE or touch here to open web site"). +  -Also not that websites which are outside of rC3 will be automatically prefixed +Also note that websites which are outside of rC3 will be automatically prefixed with a dereferrer, which will alert visitors that they are now "leaving the event area". -### Embedding jitsi +### Embedding Jitsi You can embed Jitsi rooms in the same way. Simply set the custom property -`jitsiRoom` (type string) and assign it the name of your jitsi room as its value. +`jitsiRoom` (type string) and assign it the name of your Jitsi room as its value.  To avoid unintentional collisions between different assemblies (e.g. so that -everyone can define their own "hackcenter") names of jitsi rooms are local to +everyone can define their own "hackcenter") names of Jitsi rooms are local to your own assembly. If you want to share a room with a different assembly, just prefix its name with `shared-`. @@ -270,12 +278,12 @@ In general we recommend also setting the property `jitsiTrigger` to `onaction`, which will cause the room to open only after explicit user interaction (a press on the space bar), which makes visiting the world much easier on older laptops and prevents people accidentally stumbling into your session. You can also set -a custom message to be displayed where the jitsi can be opened by setting the -`jitsiTriggerMessage` property (which will overwrite the default "press SPACE -to open jitsi meet"). +a custom message to be displayed where the Jitsi can be opened by setting the +`jitsiTriggerMessage` property (which will overwrite the default "Press SPACE +or touch here to enter Jitsi Meet room"). ### Embedding Big Blue Button -This works essentially the same as with jitsi: set `bbbRoom` to your room's name, +This works essentially the same as with Jitsi: set `bbbRoom` to your room's name, and `bbbTrigger` along with `bbbTriggerMessage` to prevent the room from popping open unexpectedly. @@ -332,6 +340,9 @@ on their tiles. Only mp3 files included via a path relativ to your map are supported. External files can not be included. If you want to include streams, please write an email to [world@rc3.world](mailto:world@rc3.world). If you want the audio to also loop, additionally set `audioLoop` (type boolean) to `true`. +To reduce playback volume, you can set `audioVolume` (type float) to a value +between `0.0` (0%) and `1.0` (100%). Users can also set a maximum volume. In this +case the lower value will be used.  diff --git a/docs/maps.md b/docs/maps.md index 40863c2b6e6674ae40ce52794a895a1e244161ef..aced0ca339a74c9c8f5030fd31debd0d6aa24d17 100644 --- a/docs/maps.md +++ b/docs/maps.md @@ -266,6 +266,15 @@ 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` (Typ String). Verwendet https! +Allgemein wird empfohlen, zusätzlich noch die Property `openWebsiteTrigger` auf +`onaction` zu setzen, damit die Website erst nach explizitem Wunsch (einem +Druck auf die Leertaste) aufgeht. Das macht den Besuch der World für langsamere +Endgeräte. +Außerdem könnt ihr mit der Property `openWebsiteTriggerMessage` noch +eine kurze eigene Nachricht einstellen, die Besucher\*innen angezeigt wird, wenn +sie auf den Bereich der Website laufen (dies überschreibt die Standardnachricht +"Press SPACE or touch here to open web site"). +  Beachtet außerdem, dass Webseiten außerhalb der rC3 auf der rc3.world automatisch @@ -280,21 +289,21 @@ Namen den euer Jitsi Raum haben soll.  Um Kollisionen zwischen verschiedenen Assemblies zu verhindern (damit z.B. -alle ihr eigenes "Hackcenter" definieren können) sind die Namen der jitsi-Räume +alle ihr eigenes "Hackcenter" definieren können) sind die Namen der Jitsi-Räume standardmäßig lokal für euer Assembly. Falls ihr einen Raum mit einem anderen Assembly teilen wollt, hängt bitte vorne an den Namen `shared-` an. -Allgemein wird empfohlen, zusätzlich noch die Property `jitsiTrigger` auf -`onaction` zu setzen, damit der jitsi-Raum erst nach explizitem Wunsch (einem +Allgemein wird empfohlen, zusätzlich noch die Property `jitsiTrigger` auf +`onaction` zu setzen, damit der Jitsi-Raum erst nach explizitem Wunsch (einem Druck auf die Leertaste) aufgeht. Das macht den Besuch der World für langsamere Laptops angenehmer und verhindert, dass sich versehentlich wer in eure laufende Session verirrt. Außerdem könnt ihr mit der Property `jitsiTriggerMessage` noch eine kurze eigene Nachricht einstellen, die Besucher\*innen angezeigt wird, wenn -sie auf den Bereich des Jitsis laufen (dies Überschreibt die Standardnachricht -"press SPACE to open jitsi meet"). +sie auf den Bereich des Jitsis laufen (dies überschreibt die Standardnachricht +"Press SPACE or touch here to enter Jitsi Meet room"). ### Big Blue Button einbinden -Dies funktioniert im wesentlichen genauso wie für jitsi: setzt `bbbRoom` auf den +Dies funktioniert im wesentlichen genauso wie für Jitsi: setzt `bbbRoom` auf den Namen eures Raums, und `bbbTrigger` bzw. `bbbTriggerMessage`, um den Raum nicht unverhofft aufploppen zu lassen. @@ -354,6 +363,10 @@ der Karte eingebunden werden können. Externe mp3-Dateien können nicht eingebun werden. Falls ihr Streams eimbinden wollt wendet euch bitte an [world@rc3.world](mailto:world@rc3.world). Soll sich der Audioschnipsel wiederholen, so setzt zusätzlich `audioLoop` (Typ Boolean) auf `true`. +Wenn die Audiodatei leiser wiedergegeben werden soll, kann das mit der Property +`audioVolume` eingestellt werden, die eine Fließkommazahl zwischen `0.0` (0%) und +`1.0` (100%) annehmen kann. User können auch client-seitig eine Maximallautstärke +einstellen - es wird dann immer der kleinere Wert verwendet. 