Skip to content
Snippets Groups Projects
Commit 1b636e8c authored by yourcoke's avatar yourcoke
Browse files

badges doku improved

parent 5bf5f43d
No related branches found
No related tags found
1 merge request!50Badge Award API HowTo
This commit is part of merge request !50. Comments created here will be created in the context of that merge request.
...@@ -21,7 +21,7 @@ This tutorial is "work in progess", hence its worth checking it from time to tim ...@@ -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: World-Exit added.
* 2020-12-22: Cross-Assembly Links added. * 2020-12-22: Cross-Assembly Links added.
* 2020-12-25: Added [exitUrl List](exitUrls.en.md) * 2020-12-25: Added [exitUrl List](exitUrls.en.md)
* 2020-12-27: Award Badge added. * 2020-12-28: Award Badge added.
### Known Bugs ### Known Bugs
Following bugs are known and worked on: Following bugs are known and worked on:
...@@ -174,8 +174,8 @@ Should you not want audio and video communication between participants in certai ...@@ -174,8 +174,8 @@ Should you not want audio and video communication between participants in certai
### Walls / non-accessible areas ### 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. For a change, this is not a layer property, but a tile property. For a description, see the Tiles section above.
##### Award badges ### 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. 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.
![](img/cp_getBadge.png) ![](img/cp_getBadge.png)
......
...@@ -24,6 +24,7 @@ Dieses Tutorial ist ein work in progress und wird immer mal wieder erweitert, es ...@@ -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: World-Exit ergänzt.
* 2020-12-22: Cross-Assembly Links ergänzt. * 2020-12-22: Cross-Assembly Links ergänzt.
* 2020-12-25: Liste der exitUrls ergänzt. * 2020-12-25: Liste der exitUrls ergänzt.
* 2020-12-28: Badgevergabe hinzugefügt
### Known Bugs ### Known Bugs
Folgende Bugs sind aktuell bekannt, wir versuchen bereits, Lösungen dafür zu finden: 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 ...@@ -173,8 +174,8 @@ Solltet ihr in gewissen Bereichen keine Audio/Video Kommunikation zwischen den T
### Wände / nicht begehbare Bereiche ### Wände / nicht begehbare Bereiche
Das ist ausnahmsweise kein Layer, sondern eine Tile-Eigenschaft. Beschreibung siehe weiter oben bei den Tiles. Das ist ausnahmsweise kein Layer, sondern eine Tile-Eigenschaft. Beschreibung siehe weiter oben bei den Tiles.
##### Award badges ##### 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). Verwendet https! Ein Token könnt Ihr für jedes Badge im Backoffice generieren. Es funktioniert jedoch nur ein **Map** Redeem Token. 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.
![](img/cp_getBadge.png) ![](img/cp_getBadge.png)
......
...@@ -105,8 +105,8 @@ Badges are distributed to users via token. A matching token can be generated whe ...@@ -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? 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 ##### Assign directly via Maschinenraum
Within the backoffice Badges can be directly assigned to users. Within the Maschinenraum Badges can be directly assigned to users.
![](img/backoffice_assign_badge.jpg) ![](img/backoffice_assign_badge.jpg)
...@@ -119,7 +119,7 @@ When automaticly assigning badges to users, Redeem Tokens (TM) are necessary. Th ...@@ -119,7 +119,7 @@ When automaticly assigning badges to users, Redeem Tokens (TM) are necessary. Th
![](img/backoffice_redeem_badges.jpg) ![](img/backoffice_redeem_badges.jpg)
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: 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. ...@@ -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 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>`. 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. 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` ...@@ -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 ##### 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.
![](img/cp_getBadge.png) ![](img/cp_getBadge.png)
......
...@@ -111,8 +111,8 @@ Badges werden via Token an die User:innen verteilt. Ein passendes Token kann bei ...@@ -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? 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 ##### Direktzuweisung im Maschinenraum
Im Backoffice können Badges direkt an User vergeben werden. Im Maschinenraum können Badges direkt an User vergeben werden.
![](img/backoffice_assign_badge.jpg) ![](img/backoffice_assign_badge.jpg)
...@@ -125,7 +125,7 @@ Zum sonstigen Vergeben von Badges wind Redeem Tokens (TM) notwending. Es gibt vi ...@@ -125,7 +125,7 @@ Zum sonstigen Vergeben von Badges wind Redeem Tokens (TM) notwending. Es gibt vi
![](img/backoffice_redeem_badges.jpg) ![](img/backoffice_redeem_badges.jpg)
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: REST POST Request to `/api/c/<conference_slug>/assembly/<assembly>/badges/new_redeem_token` mit dem folgenden body:
...@@ -167,7 +167,7 @@ Body: ...@@ -167,7 +167,7 @@ Body:
``` ```
##### Badges in der rc3.world zuweisen ##### 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.
![](img/cp_getBadge.png) ![](img/cp_getBadge.png)
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Please register or to comment