Add endpoints on pusher to resolve wokas

docs/dev/README.md

@@ -13,4 +13,6 @@ Check out the [contributing guide](../../CONTRIBUTING.md)
 
 ## Front documentation
 
+- [How to add translations](how-to-translate.md)
 - [How to add new functions in the scripting API](contributing-to-scripting-api.md)
+- [About Wokas](wokas.md)

docs/dev/wokas.md

@@ -0,0 +1,30 @@
+# About Wokas
+
+Wokas are made of a set of layers (for custom wokas), or of only 1 layers (if selected from the first screen)
+
+Internally, each layer has:
+
+- a name
+- a URL
+
+## Connection to a map
+
+When a user connects to a map, it sends, as a web-socket parameter, the list of layer **names**.
+
+The pusher is in charge of converting those layer names into the URLs. This way, a client cannot send any random
+URL to the pusher.
+
+When the pusher receives the layer names, it validates these names and sends back the URLs + sends the names+urls to the back.
+If the layers cannot be validated, the websocket connections sends an error message and closes. The user is sent back to the "choose your Woka" screen.
+
+## Getting the list of available Wokas
+
+The pusher can send the list of available Wokas to the user.
+It can actually query the admin for this list, if needed (= if an admin is configured)
+
+## In the pusher
+
+The pusher contains a classes in charge of managing the Wokas:
+
+- `LocalWokaService`: used when no admin is connected. Returns a hard-coded list of Wokas (stored in `pusher/data/woka.json`).
+- `AdminWokaService`: used to delegate the list of Wokas to the admin.