From 1b636e8c2a90abe3f126c70e34a49abb24d09df1 Mon Sep 17 00:00:00 2001 From: yourcoke <deinkoks@gmail.com> Date: Mon, 28 Dec 2020 11:52:38 +0100 Subject: [PATCH] badges doku improved --- docs/maps.en.md | 6 +++--- docs/maps.md | 5 +++-- docs/maschinenraum.en.md | 9 +++++---- docs/maschinenraum.md | 8 ++++---- 4 files changed, 15 insertions(+), 13 deletions(-) diff --git a/docs/maps.en.md b/docs/maps.en.md index 7440b91..6bc2467 100644 --- a/docs/maps.en.md +++ b/docs/maps.en.md @@ -21,7 +21,7 @@ This tutorial is "work in progess", hence its worth checking it from time to tim * 2020-12-22: World-Exit added. * 2020-12-22: Cross-Assembly Links added. * 2020-12-25: Added [exitUrl List](exitUrls.en.md) -* 2020-12-27: Award Badge added. +* 2020-12-28: Award Badge added. ### Known Bugs Following bugs are known and worked on: @@ -174,8 +174,8 @@ Should you not want audio and video communication between participants in certai ### Walls / non-accessible areas For a change, this is not a layer property, but a tile property. For a description, see the Tiles section above. -##### Award badges -You can award badges when stepping on certain tiles. To do this, give the layer the property "getBadge" (string). Use https. The token is a map token, which can be generated in the Backoffice for each badge. +### Award badges +You can award badges when stepping on certain tiles. To do this, give the layer the property "getBadge" (string). The token is a map token, which can be generated in the Backoffice for each badge.  diff --git a/docs/maps.md b/docs/maps.md index 60aa0bb..4ced80f 100644 --- a/docs/maps.md +++ b/docs/maps.md @@ -24,6 +24,7 @@ Dieses Tutorial ist ein work in progress und wird immer mal wieder erweitert, es * 2020-12-22: World-Exit ergänzt. * 2020-12-22: Cross-Assembly Links ergänzt. * 2020-12-25: Liste der exitUrls ergänzt. +* 2020-12-28: Badgevergabe hinzugefügt ### Known Bugs Folgende Bugs sind aktuell bekannt, wir versuchen bereits, Lösungen dafür zu finden: @@ -173,8 +174,8 @@ Solltet ihr in gewissen Bereichen keine Audio/Video Kommunikation zwischen den T ### Wände / nicht begehbare Bereiche Das ist ausnahmsweise kein Layer, sondern eine Tile-Eigenschaft. Beschreibung siehe weiter oben bei den Tiles. -##### Award badges -Ihr könnt Badges an User vergeben, wenn diese ein bestimmten Tile betreten. 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 "_getBadge_" (string). Verwendet https! Ein Token könnt Ihr für jedes Badge im Backoffice generieren. Es funktioniert jedoch nur ein **Map** Redeem Token. +##### Badgevergabe +Ihr könnt Badges an User vergeben, wenn diese ein bestimmten Tile betreten. 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 "_getBadge_" (string). Ein Token könnt Ihr für jedes Badge im Backoffice generieren. Es funktioniert jedoch nur ein **Map** Redeem Token.  diff --git a/docs/maschinenraum.en.md b/docs/maschinenraum.en.md index e7a5389..1e2ad23 100644 --- a/docs/maschinenraum.en.md +++ b/docs/maschinenraum.en.md @@ -105,8 +105,8 @@ Badges are distributed to users via token. A matching token can be generated whe Users will find collected badges in their profile. Users will always have to actively accept a badge - who wants to suddenly find a pink dolphine vibrator in their profile? -##### Assign directly via Backoffice -Within the backoffice Badges can be directly assigned to users. +##### Assign directly via Maschinenraum +Within the Maschinenraum Badges can be directly assigned to users.  @@ -119,7 +119,7 @@ When automaticly assigning badges to users, Redeem Tokens (TM) are necessary. Th  -These can be created via the Backoffice (see image) or via API: +These can be created via the Maschinenraum (see image) or via API: Just send a REST POST Request to `/api/c/<conference_slug>/assembly/<assembly>/badges/new_redeem_token` with the following body: ``` @@ -139,6 +139,7 @@ Badges can be distributed via the Redeem Tokens. A user can go to his profile (`/<conference_slug>/me`) and redeem a token in "My badges". A url is available to auto-fill in the token input field: `/<conference_slug>/me/redeem_badge/<redeem_token>`. +This is perfect to use it in QR codes. When a user redeems a badge via his profile, it is automatically accepted and set to private on their profile. @@ -157,7 +158,7 @@ Just send a REST POST Request to `/api/c/<conference_slug>/badges/redeem_token` ``` ##### Using the rc3.world map to assign badges -In the rc3.world map a tile can be linked to assigning a badge. It works simiar to opening a website. Zou need to generate a Map Redeem Token. +In the rc3.world map a tile can be linked to assigning a badge. It works simiar to opening a website, but using the `getBadge` property instead. Usage of **Map** Redeem Tokens is required.  diff --git a/docs/maschinenraum.md b/docs/maschinenraum.md index 079908d..b406d52 100644 --- a/docs/maschinenraum.md +++ b/docs/maschinenraum.md @@ -111,8 +111,8 @@ Badges werden via Token an die User:innen verteilt. Ein passendes Token kann bei Gesammelte Badges finden User:innen in ihrem Profil. User:innen müssen den Erhalt der Badges immer aktiv bestätigen - wer möchte schon plötzlich einen rosafarbenen Delphin-Vibrator im Profil vorfinden? -##### Direktzuweisung im Backoffice -Im Backoffice können Badges direkt an User vergeben werden. +##### Direktzuweisung im Maschinenraum +Im Maschinenraum können Badges direkt an User vergeben werden.  @@ -125,7 +125,7 @@ Zum sonstigen Vergeben von Badges wind Redeem Tokens (TM) notwending. Es gibt vi  -Diese Redeem Tokens können im Backoffice (siehe Bild) oder per API erstellt werden: +Diese Redeem Tokens können im Maschinenraum (siehe Bild) oder per API erstellt werden: REST POST Request to `/api/c/<conference_slug>/assembly/<assembly>/badges/new_redeem_token` mit dem folgenden body: @@ -167,7 +167,7 @@ Body: ``` ##### Badges in der rc3.world zuweisen -In der rc3.world map kann ein Tile zu einem Badge verlinkt werden. Wenn der Benutzer dieses Teil betritt, bekommt er automatisch den Badge zugewiesen. Es funktioniert ähnlich wie das öffnen einer Website. Es muss ein Map Redeem Token benutzt werden. +In der rc3.world map kann ein Tile zu einem Badge verlinkt werden. Wenn der Benutzer dieses Teil betritt, bekommt er automatisch den Badge zugewiesen. Es funktioniert ähnlich wie das öffnen einer Website, hierfür wird das `getBadge` Property verwendet. Es müssen **Map** Redeem Tokens verwendet werden.  -- GitLab