create-okona-game 0.1.3 → 0.3.0

package/README.md

@@ -6,6 +6,6 @@ npm create okona-game my-party-game
 
 Scaffolds a phone-controlled multiplayer HTML5 game for [Okona](https://okonaonline.com): a lobby that shows the join code until the room is full, six seats with names and colours pushed to each phone, the frame loop, and a `game.js` with `start` / `update` / `draw` hooks holding a small sample (a coin-grab race) to replace with your game.
 
-Open `index.html` in a browser and the keyboard is P1 — no build step, no `package.json`. Ship it with the [`okona` CLI](https://www.npmjs.com/package/okona-cli) (`npx okona-cli`, Node 18.17+): push to your sandbox first to try it with real phones, then publish, and phones join by scanning the code on the TV.
+Open `index.html` in a browser and the keyboard is P1 — no build step, no `package.json`. Ship it with the [`okona` CLI](https://www.npmjs.com/package/okona-cli) (`npx okona-cli`, Node 18.17+): push to your sandbox first to try it with real phones, then submit it to the Okona catalog; once it's approved, players join by scanning the code on the TV.
 
 Zero dependencies. Docs: https://okonaonline.com/developers/docs.html#html5 · SDK reference: https://okonaonline.com/developers/docs.html#js-sdk

package/index.js

@@ -4,7 +4,8 @@
 //   npm create okona-game my-game        (or: npx create-okona-game my-game)
 //
 // Copies the template (lobby + join code + seats in index.html, your game in
-// game.js, an icon, a README) into ./my-game with the name filled in. Zero
+// game.js, an icon, an okona.json catalog record, a README) into ./my-game
+// with the name filled in. Zero
 // dependencies, Node ≥ 18. `--force` writes into a non-empty directory.
 import { mkdir, readdir, readFile, writeFile, copyFile, stat } from "node:fs/promises";
 import { join, resolve, dirname, basename } from "node:path";
@@ -35,7 +36,7 @@ export async function scaffold(target, { name, force = false } = {}) {
         const src = join(TEMPLATE, f);
         if ((await stat(src)).isDirectory()) continue;
         const dest = join(dir, f === "gitignore" ? ".gitignore" : f);
-        if (/\.(html|js|md)$/.test(f) || f === "gitignore") {
+        if (/\.(html|js|md|json)$/.test(f) || f === "gitignore") {
             const text = (await readFile(src, "utf8")).split("{{NAME}}").join(title);
             await writeFile(dest, text);
         } else {
@@ -59,9 +60,10 @@ if (isMain) {
         console.log("  Next:");
         console.log("    open index.html in a browser — the keyboard is P1 (WASD + Space)");
         console.log("    edit game.js — start / update / draw are yours");
-        console.log("    npx okona-cli login && npx okona-cli create --title \"" + r.title + "\" --description \"…\" --runtime html5");
-        console.log("    npx okona-cli push . --game <id> --icon icon.png --sandbox    # try it with real phones first");
-        console.log("    npx okona-cli push . --game <id> --icon icon.png --publish    # → https://play.okonaonline.com/games/?id=<id>");
+        console.log("    edit okona.json — title, description, keywords (the icon is icon.png; add \"screenshots\": \"shots\" for a folder of them)");
+        console.log("    npx okona-cli login && npx okona-cli create    # reads okona.json, writes the new game id back into it");
+        console.log("    npx okona-cli push . --sandbox                  # catalog + icon + build; try it with real phones first");
+        console.log("    npx okona-cli push . --publish                  # submit for review: Okona approves it into the catalog");
         console.log("    (npx okona-cli runs the okona command without installing it; Node 18.17+)\n");
         console.log("  Docs: https://okonaonline.com/developers/docs.html#html5\n");
     }).catch((e) => {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "create-okona-game",
-  "version": "0.1.3",
+  "version": "0.3.0",
   "description": "Scaffold a phone-controlled multiplayer HTML5 game for Okona: lobby, join code, six seats, and a game.js to make yours.",
   "license": "MIT",
   "homepage": "https://okonaonline.com/developers/docs.html#html5",

package/template/README.md

@@ -5,20 +5,23 @@ A phone-controlled multiplayer game for [Okona](https://okonaonline.com). Up to
 - `index.html` — the lobby, join code, seats and frame loop (rarely needs changes)
 - `game.js` — **your game**: `start`, `update`, `draw`, and the join/leave/park/resume hooks
 - `icon.png` — the icon shown in the Okona portal (replace it)
+- `okona.json` — the catalog record: title, description, genre, keywords, the icon, screenshots. `okona push` syncs it
 
 ## Play it locally
 
 Open `index.html` in a browser (or `npx serve .`). The keyboard is P1: WASD/arrows move, Space is A, Shift is B. Phones need the real thing, below.
 
-## Publish
+## Submit to Okona
 
 The `okona` CLI is the npm package `okona-cli` (Node 18.17+); `npx` runs it without installing.
 
 ```
 npx okona-cli login                 # once: approve a code in the portal
-npx okona-cli create --title "{{NAME}}" --description "…" --runtime html5
-npx okona-cli push . --game <id> --icon icon.png --sandbox    # try it with real phones first
-npx okona-cli push . --game <id> --icon icon.png --publish    # → https://play.okonaonline.com/games/?id=<id>
+npx okona-cli create                # reads okona.json, writes the new game id back into it
+npx okona-cli push . --sandbox      # catalog + icon + build in one go; try it with real phones first
+npx okona-cli push . --publish      # submit for review: Okona approves it into the catalog or sends it back
 ```
 
+Screenshots: put up to six images in a `shots/` folder and add `"screenshots": "shots"` to `okona.json` — the next push uploads them in name order (1.png, 2.png, …). `npx okona-cli update --title "…"` changes a field without a build upload; `npx okona-cli game <id>` shows what the portal has.
+
 Docs: https://okonaonline.com/developers/docs.html#html5 · SDK reference: https://okonaonline.com/developers/docs.html#js-sdk · The contract in one line: `Okona.pads()`, `Okona.on('join'|'leave'|'park'|'resume'|'pairing')`, `Okona.drawQr()`, `Okona.players.setIdentity()`, `Okona.rumble()`, `Okona.track()`.

package/template/index.html

@@ -3,11 +3,11 @@
   {{NAME}} — an Okona game.
 
   This file is the LOBBY and the game loop; your game lives in game.js.
-  Six phones scan the code on screen and become gamepads. Okona hosts the
-  game at one link. Open this file in a browser and the keyboard is P1
+  Six phones scan the code on screen and become gamepads. Submit it to the
+  Okona catalog when it's ready. Open this file in a browser and the keyboard is P1
   (WASD/arrows, Space = A, Shift = B) so you can play what you build.
 
-  Publish: npx okona-cli push . --game <id> --icon icon.png --publish
+  Submit:  npx okona-cli create && npx okona-cli push . --publish   (okona.json holds the title, icon, screenshots)
   Docs:    https://okonaonline.com/developers/docs.html#html5
 -->
 <html lang="en">

package/template/okona.json

@@ -0,0 +1,8 @@
+{
+  "title": "{{NAME}}",
+  "description": "A phone-controlled multiplayer game. Scan the code on screen to play.",
+  "genre": "multiplayer-party",
+  "keywords": ["party", "multiplayer"],
+  "controller": "basic",
+  "icon": "icon.png"
+}