Merge branch 'main' into feat/dashboard

.github/workflows/docs.yml

@@ -25,5 +25,7 @@ jobs:
           ssh-add -vvv
           ls ~/.ssh/
           ssh-keyscan -H "${{ secrets.SSH_IP }}" >> ~/.ssh/known_hosts
-      - name: deploy
+      - name: build
         run: ssh -vT "bauer@${{ secrets.SSH_IP }}" "cd ~/clones/metagallery/stiller-backend/docs && mdbook build"
+      - name: deploy
+        run: ssh -vT "bauer@${{ secrets.SSH_IP }}" "sudo cp -r ~/clones/metagallery/stiller-backend/docs/book /var/www/stillerdocs && sudo chown --recursive www-data /var/www/stillerdocs"

app/README.md

@@ -15,9 +15,21 @@
 
 ## Resources
 
-- 3D Gallery: <https://www.cgtrader.com/items/5155429/download-page>
 - 3D scenes: <https://sketchfab.com/search?q=gallery&type=models>
 - FPV example: <https://github.com/jgcarrillo/react-fp-movement>
 - Virtual museum: <https://github.com/r23/Virtual-Reality-Museum>
   - <https://github.com/r23/Virtual-Reality-Museum/blob/a37c16ce8cf00addeab8600c728ad04b925961e7/index.html#L132>
   - <https://github.com/r23/Virtual-Reality-Museum/blob/master/models/good_samaritan.mtl>
+
+## Attributions
+
+Template rooms 3D models:
+
+- Template 1 <https://www.cgtrader.com/items/5155429/download-page> by cgtrader
+- Template 2 <https://sketchfab.com/3d-models/gallery-showroom-22b427f9480d4e31b9bfe26f19b746e1> by jimbogies
+- Template 3 <https://sketchfab.com/3d-models/vr-gallery-house-baked-8e3b280476eb4790af97e2abd3d9be59> by Elin
+- Template 4 <https://sketchfab.com/3d-models/wip-exhibition-room-f962e5da8fed46508daec928dc740301> by Loïc Norgeot
+- Template 5 <https://sketchfab.com/3d-models/vr-gallery-1e087aa25dc742e680accb15249bd6be> by Maxim Mavrichev
+- Template 6 <https://sketchfab.com/3d-models/vegetable-gallery-a0c6c7a2f4234b5fa45af74743790aff> by Moshe Caine
+- Template 7 <https://sketchfab.com/3d-models/wip-exhibition-room-cb21a403f6774ef19835295b4a238842> by Loïc Norgeot
+- Template 8 <https://sketchfab.com/3d-models/landscape-gallery-by-stoneysteiner-3702735762544e5796be4740cb6d5efc> by stoneysteiner

app/docs/template_file.md

@@ -0,0 +1,49 @@
+# Template files
+
+The metagallery template file format is no more than a tarball containing
+the following files:
+
+```txt
+template.tar/
+  |- slots.json
+  |- topview.svg
+  +- scene.glb
+```
+
+The `slots.json` file contains the information about the available slots in
+the scene for the user to drop images/3D models.
+
+```json
+[
+  {
+    "id": "slot1",
+    "type": "2d",
+    "props": {},
+    "v": [
+      [-2.190093, 2.930420, 1.957159],
+      [-2.190091, 1.010420, 1.957159],
+      [-3.686093, 2.930418, 1.957160],
+      [-3.686091, 1.010419, 1.957160]
+    ]
+  },
+  {
+    "id": "slot2",
+    "type": "3d",
+    "props": {
+      "rotating": false,
+      "scale": 1
+    },
+    "v": [
+      [-2.190093, 2.930420, 1.957159]
+    ]
+  },
+]
+```
+
+For `2d` slots, the `v` array should contain the 4 vertices that represent the
+4 corners of the slot frame.
+
+For `3d` slots, the `v` array should contain a single vertex that represents
+the origin position of the 3D model. If `rotating` is enabled (default=`false`),
+the model will constantly rotate around the Z axis. If the `scale` property
+exists (default=`1`), the model will be scaled by the given factor.

app/index.html

@@ -8,6 +8,7 @@
       content="minimum-scale=1, initial-scale=1, width=device-width, user-scalable=no"
     />
     <title>Metagallery</title>
+    <link rel="icon" href="/favicon.svg" type="image/svg+xml" />
     <link rel="preconnect" href="https://fonts.googleapis.com">
     <link rel="preconnect" href="https://fonts.gstatic.com" crossorigin>
     <link href="https://fonts.googleapis.com/css2?family=Inter:ital,opsz,wght@0,14..32,100..900;1,14..32,100..900&display=swap" rel="stylesheet">