@lampdotdev/lamp 0.0.0-stage → 0.35.0

package/Resources/Devices/xbox-one.json

@@ -0,0 +1,367 @@
+{
+  "app": {
+    "declared": {
+      "files": {
+        "Web/app.js": "// The controller moves focus and presses buttons: Lamp's lamp.js gives the d-pad and left stick as arrow keys, A as\n// Enter and B as Escape.\nfunction focusables() { return Array.prototype.slice.call(document.querySelectorAll(\".focusable\")); }\n\n// Moves focus to the nearest focusable thing in the direction of an arrow (the controller's d-pad and stick).\ndocument.addEventListener(\"keydown\", function (e) {\n  var dirs = { ArrowUp: [0, -1], ArrowDown: [0, 1], ArrowLeft: [-1, 0], ArrowRight: [1, 0] };\n  var d = dirs[e.key];\n  if (!d) return;\n  var current = document.activeElement, items = focusables();\n  if (!current || items.indexOf(current) < 0) { if (items[0]) items[0].focus(); return; }\n  var r = current.getBoundingClientRect(), best = null, bestScore = Infinity;\n  items.forEach(function (el) {\n    if (el === current) return;\n    var o = el.getBoundingClientRect();\n    var dx = (o.left + o.width / 2) - (r.left + r.width / 2), dy = (o.top + o.height / 2) - (r.top + r.height / 2);\n    if (dx * d[0] + dy * d[1] <= 0) return;\n    var score = Math.abs(dx * d[0] + dy * d[1]) + 2 * Math.abs(dx * d[1] + dy * d[0]);\n    if (score < bestScore) { bestScore = score; best = el; }\n  });\n  if (best) { best.focus(); e.preventDefault(); }\n});\n\nwindow.addEventListener(\"load\", function () { var f = focusables()[0]; if (f) f.focus(); });\n",
+        "Web/index.html": "<!doctype html>\n<html>\n<head>\n<meta charset=\"utf-8\">\n<title>{{NAME}}</title>\n<link rel=\"stylesheet\" href=\"style.css\">\n</head>\n<body>\n<main id=\"app\">\n  <h1>{{NAME}}</h1>\n  <p>Made with Lamp.</p>\n  <button class=\"focusable\" autofocus>Start</button>\n</main>\n<script src=\"lamp.js\"></script>\n<script src=\"app.js\"></script>\n</body>\n</html>\n",
+        "Web/style.css": "html, body { margin: 0; width: 1920px; height: 1080px; overflow: hidden; background: #10131c; color: #f4f5f8;\n  font-family: \"Segoe UI\", sans-serif; }\n#app { padding: 96px 120px; }\nh1 { font-size: 88px; margin: 0 0 24px; }\np { font-size: 40px; opacity: .8; }\nbutton { font: inherit; font-size: 40px; padding: 20px 48px; border-radius: 16px; border: 4px solid transparent;\n  background: #2a3042; color: inherit; }\nbutton:focus { outline: none; border-color: #7aa2ff; transform: scale(1.06); }\n"
+      },
+      "host": "webview2",
+      "output": "build/app.zip",
+      "package": "rm -f build/app.zip && mkdir -p build && cd Web && zip -qr ../build/app.zip .",
+      "rules": "The app is a web page in Web/ (HTML, CSS and JavaScript, no build step and no frameworks from the network), shown full screen at 1920x1080 on the Xbox in Lamp's host for Microsoft Edge's Chromium web view (WebView2), served from the package at https://lamp.example/: modern JavaScript and CSS work, as in a current Chrome, and so does WebGL 2. The page is 1920x1080 CSS pixels, as in the preview. Design for a TV across the room: large type (36px and up), high contrast, nothing that scrolls the whole page. It's driven by the controller: Lamp's lamp.js gives the d-pad and left stick as the arrow keys, A as Enter (which also presses the focused element) and B as Escape, and the other buttons as keys named GamepadX, GamepadY, GamepadLeftShoulder, GamepadRightShoulder, GamepadLeftTrigger, GamepadRightTrigger, GamepadMenu and GamepadView; read e.key, never e.keyCode. Give every control the class `focusable` and a visible :focus style, and use the arrow-focus code in app.js; B (Escape) goes back a screen, and on the first screen does nothing, since the app stays open. index.html loads Lamp's lamp.js before app.js; keep it so. Lamp wraps Web/ into a signed Windows package itself. console.log, console.error and uncaught errors go to the app's log on the Xbox, which look_at_app with on_device shows beside the console's own screenshot: look there to see how it really runs. Lamp writes three.js in Web/three before every build (never edit it, never load a 3D library from the network); for a 3D game or scene, read the 3d-game skill with read_skill before writing it: it says how a page with no game runtime loads the library and sizes its renderer. An Xbox One is a modest console: draw many copies of one shape as one instanced draw, never as hundreds of separate meshes, reuse geometries and materials, keep to a standard lit material or cheaper, one or two lights and no real-time shadows, and aim for 60 frames a second. In a game, read the controller directly each frame while it's played with navigator.getGamepads()[0] (the standard mapping: axes 0 and 1 the left stick, 2 and 3 the right, with a dead zone of about 0.15; buttons[0] A, [1] B, [2] X, [3] Y, [4] and [5] the bumpers, [6] and [7] the triggers' value, [12] to [15] the d-pad), and ignore the arrow and Enter keys lamp.js sends meanwhile. Shake the controller with the standard gp.vibrationActuator.playEffect('dual-rumble', { duration, strongMagnitude, weakMagnitude }) ('trigger-rumble' with leftTrigger and rightTrigger for the triggers' own motors), which Lamp's host plays on the controller; keep each effect short (under a second) and call it again for a long rumble. Take the keyboard too, as the same moves (WASD or the arrows, Space, Enter, Escape for B): that's how the game is played in the preview on the person's Mac, where you try it with use_app, holding a key with amount in seconds. A game (anything played, 2D or 3D) also has capabilities.json at the app's root (beside Web/, not in it) saying {\"game\": true}: Lamp then installs it on the Xbox as a game, which the console gives about five times the memory and its whole GPU; an app with menus and pages leaves it out.",
+      "start": "index.html",
+      "support": {
+        "web": "Web/lamp.js",
+        "three": "Web/three"
+      },
+      "wrap": "msix",
+      "preview": "Web"
+    },
+    "purpose": "an app, or a game played through menus (a quiz, a board or card game)"
+  },
+  "supports": [
+    "web"
+  ],
+  "input": {
+    "controller": "xbox",
+    "layout": "xbox"
+  },
+  "bridge": {
+    "install": [
+      {
+        "http": {
+          "auth": {
+            "digest": false,
+            "password": "{field:password}",
+            "user": "lamp"
+          },
+          "https": true,
+          "path": "/api/os/info",
+          "port": 11443
+        }
+      },
+      {
+        "http": {
+          "auth": {
+            "digest": false,
+            "password": "{field:password}",
+            "user": "lamp"
+          },
+          "body": "{\"Value\":\"{isGame}\"}",
+          "headers": {
+            "Content-Type": "application/json",
+            "X-CSRF-Token": "{cookie:CSRF-Token}"
+          },
+          "https": true,
+          "method": "PUT",
+          "path": "/ext/settings/DefaultUWPContentTypeToGame",
+          "port": 11443,
+          "restore": "Value"
+        }
+      },
+      {
+        "http": {
+          "auth": {
+            "digest": false,
+            "password": "{field:password}",
+            "user": "lamp"
+          },
+          "form": {
+            "app.msix": "@{package}",
+            "lamp.cer": "@{certificate}"
+          },
+          "headers": {
+            "X-CSRF-Token": "{cookie:CSRF-Token}"
+          },
+          "https": true,
+          "method": "POST",
+          "path": "/api/app/packagemanager/package?package=app.msix",
+          "port": 11443
+        }
+      },
+      {
+        "http": {
+          "auth": {
+            "digest": false,
+            "password": "{field:password}",
+            "user": "lamp"
+          },
+          "expect": {
+            "equals": "true",
+            "json": "Success"
+          },
+          "https": true,
+          "path": "/api/app/packagemanager/state",
+          "poll": 300,
+          "port": 11443
+        }
+      },
+      {
+        "http": {
+          "auth": {
+            "digest": false,
+            "password": "{field:password}",
+            "user": "lamp"
+          },
+          "expect": {
+            "equals": "{packageFullName}",
+            "json": "InstalledPackages.*.PackageFullName"
+          },
+          "https": true,
+          "path": "/api/app/packagemanager/packages",
+          "port": 11443,
+          "until": 120
+        }
+      }
+    ],
+    "launch": [
+      {
+        "http": {
+          "auth": {
+            "digest": false,
+            "password": "{field:password}",
+            "user": "lamp"
+          },
+          "https": true,
+          "path": "/api/os/info",
+          "port": 11443
+        }
+      },
+      {
+        "http": {
+          "auth": {
+            "digest": false,
+            "password": "{field:password}",
+            "user": "lamp"
+          },
+          "headers": {
+            "X-CSRF-Token": "{cookie:CSRF-Token}"
+          },
+          "https": true,
+          "method": "POST",
+          "path": "/api/taskmanager/app?appid={base64:appUserModelID}&package={base64:packageFullName}",
+          "port": 11443
+        }
+      }
+    ],
+    "running": [
+      {
+        "http": {
+          "auth": {
+            "digest": false,
+            "password": "{field:password}",
+            "user": "lamp"
+          },
+          "expect": {
+            "equals": "{packageFullName}",
+            "json": "Processes.*.PackageFullName"
+          },
+          "https": true,
+          "path": "/api/resourcemanager/processes",
+          "port": 11443,
+          "until": 8
+        }
+      }
+    ],
+    "look": [
+      {
+        "http": {
+          "auth": {
+            "digest": false,
+            "password": "{field:password}",
+            "user": "lamp"
+          },
+          "https": true,
+          "keep": "picture",
+          "path": "/ext/screenshot",
+          "port": 11443
+        }
+      }
+    ],
+    "stop": [
+      {
+        "http": {
+          "auth": {
+            "digest": false,
+            "password": "{field:password}",
+            "user": "lamp"
+          },
+          "https": true,
+          "path": "/api/os/info",
+          "port": 11443
+        }
+      },
+      {
+        "http": {
+          "auth": {
+            "digest": false,
+            "password": "{field:password}",
+            "user": "lamp"
+          },
+          "headers": {
+            "X-CSRF-Token": "{cookie:CSRF-Token}"
+          },
+          "https": true,
+          "method": "DELETE",
+          "path": "/api/taskmanager/app?package={base64:packageFullName}&forcestop=yes",
+          "port": 11443
+        }
+      }
+    ],
+    "log": [
+      {
+        "http": {
+          "auth": {
+            "digest": false,
+            "password": "{field:password}",
+            "user": "lamp"
+          },
+          "https": true,
+          "keep": "log",
+          "path": "/api/filesystem/apps/file?knownfolderid=LocalAppData&packagefullname={packageFullName}&path=%5CLocalState&filename=log.txt",
+          "port": 11443
+        }
+      }
+    ],
+    "remove": [
+      {
+        "http": {
+          "auth": {
+            "digest": false,
+            "password": "{field:password}",
+            "user": "lamp"
+          },
+          "https": true,
+          "path": "/api/os/info",
+          "port": 11443
+        }
+      },
+      {
+        "http": {
+          "auth": {
+            "digest": false,
+            "password": "{field:password}",
+            "user": "lamp"
+          },
+          "headers": {
+            "X-CSRF-Token": "{cookie:CSRF-Token}"
+          },
+          "https": true,
+          "method": "DELETE",
+          "path": "/api/app/packagemanager/package?package={packageFullName}",
+          "port": 11443
+        }
+      }
+    ]
+  },
+  "find": [
+    {
+      "contains": "UPnP-Device-Host",
+      "ssdp": "urn:schemas-upnp-org:device:MediaRenderer:1"
+    }
+  ],
+  "id": "xbox-one",
+  "identity": {
+    "id": {
+      "description": true,
+      "xml": "device/UDN"
+    },
+    "model": {
+      "contains": "Xbox",
+      "description": true,
+      "xml": "device/modelName"
+    },
+    "name": {
+      "description": true,
+      "xml": "device/friendlyName"
+    },
+    "os": "Xbox OS"
+  },
+  "kind": "game console",
+  "maker": "Microsoft",
+  "name": "Xbox",
+  "sources": [
+    "https://learn.microsoft.com/en-us/windows/uwp/xbox-apps/devkit-activation",
+    "https://learn.microsoft.com/en-us/windows/uwp/xbox-apps/device-portal-xbox",
+    "https://learn.microsoft.com/en-us/windows/uwp/debug-test-perf/device-portal-api-core"
+  ],
+  "steps": [
+    {
+      "accepts": [
+        "account",
+        "softwareRisk"
+      ],
+      "check": [
+        {
+          "tcp": 11443
+        }
+      ],
+      "id": "dev-mode",
+      "known": {
+        "how": "people",
+        "model": "Xbox Series X",
+        "source": "https://learn.microsoft.com/en-us/windows/uwp/xbox-apps/devkit-activation",
+        "version": "10.0.26100"
+      },
+      "lines": [
+        "Join the Microsoft developer program at the link (one-time fee)",
+        "On the Xbox, install Xbox Dev Mode from the Store",
+        "Open it and enter its code at aka.ms/activatexbox",
+        "Back on the Xbox, choose Switch and restart",
+        "In Dev Home, open Remote Access Settings",
+        "Check Enable Xbox Device Portal"
+      ],
+      "link": "https://partner.microsoft.com/dashboard/registration",
+      "title": "Switch the Xbox to Developer Mode",
+      "wait": true
+    },
+    {
+      "check": [
+        {
+          "field": "password"
+        },
+        {
+          "contains": "Xbox",
+          "http": {
+            "auth": {
+              "digest": false,
+              "password": "{field:password}",
+              "user": "lamp"
+            },
+            "https": true,
+            "path": "/api/os/info",
+            "port": 11443
+          },
+          "json": "Platform"
+        }
+      ],
+      "field": {
+        "key": "password",
+        "label": "Device Portal password",
+        "secret": true
+      },
+      "id": "device-portal",
+      "known": {
+        "how": "people",
+        "model": "Xbox Series X",
+        "source": "https://learn.microsoft.com/en-us/windows/uwp/xbox-apps/device-portal-xbox",
+        "version": "10.0.26100"
+      },
+      "lines": [
+        "In Remote Access Settings, choose Set username and password",
+        "Use lamp as the user name, and pick a password",
+        "Type that password here"
+      ],
+      "model": true,
+      "title": "Give Lamp the Device Portal password"
+    }
+  ],
+  "kinds": {
+    "game": {
+      "lamp": "native-game",
+      "purpose": "a game of Lamp's own (C++ on its game kit) when it's played on the Xbox: the package it goes there as"
+    }
+  },
+  "certificateRoot": "/config/rootcertificate"
+}

package/Resources/GameKit/NOTICE.md

@@ -0,0 +1,63 @@
+# The game kit's libraries
+
+Lamp writes these into every Xbox game it makes, and the game is built with them. Each is used as published, at the
+commit named, under its own licence.
+
+- sokol_gfx.h, sokol_log.h, sokol_gl.h, sokol_debugtext.h, sokol_shape.h: https://github.com/floooh/sokol at
+  efeb77603e24daea7d1dd6445b9358bb5d82533b, zlib licence (below).
+- HandmadeMath.h: https://github.com/HandmadeMath/HandmadeMath at 661fef0893bccfe30342049e848b8d54e7430234, public
+  domain (the file's own words, with a fallback grant of a perpetual, irrevocable license to copy, modify and
+  distribute it).
+- cgltf.h: https://github.com/jkuhlmann/cgltf at 85cd62382dfea638278962690cf515023f33ed00, MIT licence, Copyright (c)
+  2018-2021 Johannes Kuhlmann.
+- stb_image.h and stb_vorbis.c: https://github.com/nothings/stb at 003501f6d7a8668ce8b6d875e34dd97ad0d5d5b5, MIT
+  licence or public domain, Copyright (c) 2017 Sean Barrett (the licence is at the end of each file).
+- dr_wav.h, dr_mp3.h: https://github.com/mackron/dr_libs at dfe8377631000664666519fdb83da193fd8037f4, public domain
+  (Unlicense) or MIT No Attribution, Copyright 2023 David Reid (the licence is at the end of each file).
+
+## sokol
+
+zlib/libpng license
+
+Copyright (c) 2018 Andre Weissflog
+
+This software is provided 'as-is', without any express or implied warranty.
+In no event will the authors be held liable for any damages arising from the
+use of this software.
+
+Permission is granted to anyone to use this software for any purpose,
+including commercial applications, and to alter it and redistribute it
+freely, subject to the following restrictions:
+
+    1. The origin of this software must not be misrepresented; you must not
+    claim that you wrote the original software. If you use this software in a
+    product, an acknowledgment in the product documentation would be
+    appreciated but is not required.
+
+    2. Altered source versions must be plainly marked as such, and must not
+    be misrepresented as being the original software.
+
+    3. This notice may not be removed or altered from any source
+    distribution.
+
+## MIT licence (cgltf)
+
+Copyright (c) 2018-2021 Johannes Kuhlmann
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.