From b9738fc7154c611b0722bac790c83384c85f6e41 Mon Sep 17 00:00:00 2001 From: maqor <quantum@cert.ccc.de> Date: Sat, 25 Dec 2021 22:41:15 +0100 Subject: [PATCH 1/4] Added that the link back to the lobby will be shown in the Maschinenraum. --- docs/maps.en.md | 2 +- docs/maps.md | 7 ++++--- 2 files changed, 5 insertions(+), 4 deletions(-) diff --git a/docs/maps.en.md b/docs/maps.en.md index 406fed2..8cf4ced 100644 --- a/docs/maps.en.md +++ b/docs/maps.en.md @@ -115,7 +115,7 @@ Where `assembly` is the "technical name" (i.e. slug) of the target assembly, as set in the Maschinenraum for your own assembly. The remaining path is then relative to the map repository of the linked assembly. -To get back to the lobby, just use `lobby` as the slug. +To get back to the lobby, just use `lobby` as the slug. The link you'll have to use to connect your map to the lobby will be shown in the Maschinenraum. Since the validity of such links does not just depend on your own repository but also the entire event (and may even change over time), we cannot check such links diff --git a/docs/maps.md b/docs/maps.md index b058889..adc2295 100644 --- a/docs/maps.md +++ b/docs/maps.md @@ -58,7 +58,7 @@ Die "[scripting API extra](https://workadventu.re/map-building-extra/about.md)" könnt ihr nach Belieben benutzen, wir werden die dort enthaltenen Features unterstützen, allerdings mit der Einschränkung, dass keine Variablen in Links vorkommen dürfen (z.B. in der `openWebsite` Property). Selbst geschriebene -Scripte sind aufgrund des dadurch für uns enstehenden Review-Aufwands nur auf +Scripte sind aufgrund des dadurch für uns entstehenden Review-Aufwands nur auf Anfrage an world@rc3.world möglich. ### Starter-Kit @@ -125,7 +125,7 @@ so wie ihr ihn im Maschinenraum für euer eigenes Assembly festlegen könnt. Der Pfad danach bezieht sich dann auf den Ort der Map innerhalb des Git-Repositories dieses Assemblies. -Um zurück in die lobby zu kommen, benutzt als slug einfach `lobby`. +Um zurück in die lobby zu kommen, benutzt als slug einfach `lobby`. Der genaue Link für eure Assembly wird dann im Maschinenraum stehen. Da die Gültigkeit dieser Links nicht von eurem eigenen Repository, sondern auch vom Rest der Veranstaltung abhängt (und sich auch mit der Zeit ändern kann), können @@ -211,7 +211,8 @@ Eine Karte kann aus beliebig vielen übereinander gelegten Tile Layern bestehen. Eure Karte braucht dabei mindestens einen mit dem Namen `start`. Standardmäßig werden neue Besucher\*innen dann zufällig auf einer der Tiles dieses Layers starten (am besten schiebt ihr diesen Layer im Stapel ganz nach unten, damit -diese Tiles einfach von den anderen überdeckt werden). Außerdem braucht ihr ein +diese Tiles einfach von den anderen überdeckt werden). Dieser Layer benötigt wie alle Startlayer das Custom Property `startLayer` (Typ Boolean), welches ihr auf +`true` setzt. Außerdem braucht ihr ein Layer namens `floorLayer`, dessen Typ `objectgroup` sein muss und der definiert, auf welchem Layer sich die Avatare bewegen bzw. was vor oder hinter ihnen angezeigt werden soll. -- GitLab From 74414ecd3585d4cf5533fa0a37f7077100849fff Mon Sep 17 00:00:00 2001 From: maqor <quantum@cert.ccc.de> Date: Sat, 25 Dec 2021 22:58:23 +0100 Subject: [PATCH 2/4] Corrected 'objectgroup' layers to 'Object Layer', as the former do not exist --- docs/maps.en.md | 4 ++-- docs/maps.md | 6 +++--- 2 files changed, 5 insertions(+), 5 deletions(-) diff --git a/docs/maps.en.md b/docs/maps.en.md index 8cf4ced..65a3ddc 100644 --- a/docs/maps.en.md +++ b/docs/maps.en.md @@ -199,7 +199,7 @@ of each other. Each map will need at least one tile layer named `start`. Visitor to your map will then spawn on a random tile of this layer by default (you can move this layer to the bottom of the stack, and let its tiles be covered by other layers). You will also need another layer named `floorLayer` of the type -`objectgroup`, which defines on which layer avatars will move (i.e. which layers +`Object Layer`, which defines on which layer avatars will move (i.e. which layers will be rendered above or below them). ![](img/layer.png) @@ -308,7 +308,7 @@ it's not always possible to easily walk past each other. ![](img/cp_silent.png) ### Award badges -You can award badges when stepping on certain tiles. Add a layer of type `objectgroup` (important!), and then don't place tiles but points and/or rectangles on that layer. To each of these objects you then assign the custom property `getBadge` (type String). Its value is the token of your badge (which you can create in the Maschinenraum, where you can also create new badges). Note that you will need a **Map** redeem token. +You can award badges when stepping on certain tiles. Add a layer of type `Object Layer` (important!), and then don't place tiles but points and/or rectangles on that layer. To each of these objects you then assign the custom property `getBadge` (type String). Its value is the token of your badge (which you can create in the Maschinenraum, where you can also create new badges). Note that you will need a **Map** redeem token. Badges will then be awarded to visitors walking across the corresponding areas of the map. diff --git a/docs/maps.md b/docs/maps.md index adc2295..3ca2dd9 100644 --- a/docs/maps.md +++ b/docs/maps.md @@ -125,7 +125,7 @@ so wie ihr ihn im Maschinenraum für euer eigenes Assembly festlegen könnt. Der Pfad danach bezieht sich dann auf den Ort der Map innerhalb des Git-Repositories dieses Assemblies. -Um zurück in die lobby zu kommen, benutzt als slug einfach `lobby`. Der genaue Link für eure Assembly wird dann im Maschinenraum stehen. +Um zurück in die lobby zu kommen, benutzt als slug einfach `lobby`. Der genaue Link, den ihr auf eurerKarte eintragen müsst, wird dann im Maschinenraum stehen. Da die Gültigkeit dieser Links nicht von eurem eigenen Repository, sondern auch vom Rest der Veranstaltung abhängt (und sich auch mit der Zeit ändern kann), können @@ -213,7 +213,7 @@ werden neue Besucher\*innen dann zufällig auf einer der Tiles dieses Layers starten (am besten schiebt ihr diesen Layer im Stapel ganz nach unten, damit diese Tiles einfach von den anderen überdeckt werden). Dieser Layer benötigt wie alle Startlayer das Custom Property `startLayer` (Typ Boolean), welches ihr auf `true` setzt. Außerdem braucht ihr ein -Layer namens `floorLayer`, dessen Typ `objectgroup` sein muss und der definiert, +Layer namens `floorLayer`, dessen Typ `Object Layer`(Objektebene) sein muss und der definiert, auf welchem Layer sich die Avatare bewegen bzw. was vor oder hinter ihnen angezeigt werden soll. @@ -331,7 +331,7 @@ Gängen, in denen man sich nicht ohne weiteres ausweichen kann. ### Badgevergabe -Ihr könnt Badges an User*innen vergeben. Legt dazu einen Layer vom Typ `objectgroup` (wichtig!) an, und platziert dann keine Tiles, sondern Punkte und / oder Rechtecke auf diesem Layer. Jedem dieser Objekte weist ihr dann das Custom Property `getBadge` (Typ String) zu. Dessen Wert ist das Token eurer Badge (welches ihr im Maschinenraum erstellt, wo ihr auch neue Badges anlegen könnt).Es funktioniert jedoch nur ein **Map** Redeem Token. +Ihr könnt Badges an User*innen vergeben. Legt dazu einen Layer vom Typ `Object Layer`(Objektebene) (wichtig!) an, und platziert dann keine Tiles, sondern Punkte und / oder Rechtecke auf diesem Layer. Jedem dieser Objekte weist ihr dann das Custom Property `getBadge` (Typ String) zu. Dessen Wert ist das Token eurer Badge (welches ihr im Maschinenraum erstellt, wo ihr auch neue Badges anlegen könnt).Es funktioniert jedoch nur ein **Map** Redeem Token. Wenn jetzt Besucher\*innen über die entsprechenden Stellen der Map laufen, werden sie eure Badge erhalten. -- GitLab From 3933086c4991a3e07a60c2643febf9def50c9cba Mon Sep 17 00:00:00 2001 From: maqor <quantum@cert.ccc.de> Date: Sun, 26 Dec 2021 00:11:27 +0100 Subject: [PATCH 3/4] Added section about embedding website inline in maps --- docs/maps.en.md | 11 +++++++++++ docs/maps.md | 11 +++++++++++ 2 files changed, 22 insertions(+) diff --git a/docs/maps.en.md b/docs/maps.en.md index 65a3ddc..281209e 100644 --- a/docs/maps.en.md +++ b/docs/maps.en.md @@ -274,6 +274,17 @@ 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". +#### Embed website "as map" +Web pages can also be included inline in maps, which means that they are displayed on the map. + +To do this, create a layer of type `Object Layer` and assign it +the custom property `url` (type string). +Its value is then the URL of the web page to be included, that is to be included. +On this layer you create a rectangular area in which the area, +in which the web page will be displayed. + +Additional information can be found in the official [WorkAdventure-HowTo](https://workadventu.re/map-building/website-in-map.md). + ### 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. diff --git a/docs/maps.md b/docs/maps.md index 3ca2dd9..ddeeb46 100644 --- a/docs/maps.md +++ b/docs/maps.md @@ -294,6 +294,17 @@ Beachtet außerdem, dass Webseiten außerhalb der rC3 auf der rc3.world automati ein Dereferrer vorgehängt wird, der Besucher\*innen darauf hinweist, dass sie jetzt "das Gelände verlassen". +#### Webseite "als Karte" einbinden +Webseiten können auch inline in Karten eingebunden werden, dadurch werdensie dann +auf der Map dargestellt. + +Dazu legt ihr einen Layer vom Typ `Object Layer`(Objektebene) an und weist diesem +das Custom Property `url` (Typ String) zu. Dessen Wert ist dann die URL der Webseite, +die eingebunden werden soll. Auf diesem Layer erstellt ihr dann einen rechteckigen +Bereich, in welchem dann die Webseite angezeigt wird. + +Weitere Informationen findet ihr im offiziellen [HowTo von WorkAdventure](https://workadventu.re/map-building/website-in-map.md). + ### Jitsi einbinden Auf dieselbe Art könnt ihr auch Jitsi-Räume in eure Karte einbinden. Setzt dazu einfach die custom property `jitsiRoom` (Type String) und gebt ihr als Wert den -- GitLab From add1703bf4a12dd35e322f898b733b62aa4e707d Mon Sep 17 00:00:00 2001 From: maqor <quantum@cert.ccc.de> Date: Sun, 26 Dec 2021 00:20:58 +0100 Subject: [PATCH 4/4] Fix typo --- docs/maps.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/maps.md b/docs/maps.md index ddeeb46..98cc093 100644 --- a/docs/maps.md +++ b/docs/maps.md @@ -125,7 +125,7 @@ so wie ihr ihn im Maschinenraum für euer eigenes Assembly festlegen könnt. Der Pfad danach bezieht sich dann auf den Ort der Map innerhalb des Git-Repositories dieses Assemblies. -Um zurück in die lobby zu kommen, benutzt als slug einfach `lobby`. Der genaue Link, den ihr auf eurerKarte eintragen müsst, wird dann im Maschinenraum stehen. +Um zurück in die Lobby zu kommen, benutzt als slug einfach `lobby`. Der genaue Link, den ihr auf eurerKarte eintragen müsst, wird dann im Maschinenraum stehen. Da die Gültigkeit dieser Links nicht von eurem eigenen Repository, sondern auch vom Rest der Veranstaltung abhängt (und sich auch mit der Zeit ändern kann), können -- GitLab