@xavatech/create-xara-game 1.0.0 → 1.0.1

package/README.md

@@ -13,7 +13,7 @@ npm run dev
 | `--name` | The game's name, as players see it. Defaults to the folder's name. |
 | `--description` | One line about the game. |
 | `--players` | `2`, or a range like `2-4`. Defaults to `2`. |
-| `--xara-games <dir>` | For Xara's own games. Also adds the game to that [xara-games](https://github.com/xavatech/xara-games) checkout. |
+| `--xara-games <dir>` | For Xara's own games. Creates the game inside that [xara-games](https://github.com/xavatech/xara-games) checkout instead of the current folder. |
 
 The starter is a placeholder game: add 1, 2, or 3, and whoever makes the total 10 wins.
 
@@ -22,10 +22,10 @@ The starter is a placeholder game: add 1, 2, or 3, and whoever makes the total 1
 Name the folder `xara-<game>` and pass `--xara-games`:
 
 ```bash
-npx @xavatech/create-xara-game xara-word-chain --name "Word Chain" --players 2-4 --xara-games ./xara-games
+npx @xavatech/create-xara-game xara-word-chain --name "Word Chain" --players 2-4 --xara-games path/to/xara-games
 ```
 
-This also adds the game as the submodule `games/word-chain` (pointing at `github.com/xavatech/xara-word-chain`), adds it to `games.json`, and builds it into `site/word-chain/`. With the site served at `GAMES_URL`, run the backend's `Game` seeder to list it. Then push the game's repo.
+Run it from any folder, including inside `xara-games` with `--xara-games .`. The game is created at `games/word-chain` in that checkout and registered there as a submodule whose remote is `github.com/xavatech/xara-word-chain`. Nothing is created in the folder you run it from. It is added to `games.json` and built into `site/word-chain/`. With the site served at `GAMES_URL`, run the backend's `Game` seeder to list it. Then create the GitHub repo and push.
 
 ## Change the starter
 

package/index.mjs

@@ -12,7 +12,7 @@ const USAGE = `Start a game for Xara chats.
   --name <name>                The game's name, as players see it. Defaults to the folder's name.
   --description <description>  One line about the game.
   --players <players>          How many play: 2, or a range like 2-4. Defaults to 2.
-  --xara-games <dir>           For Xara's own games: also add it to that xara-games checkout.`;
+  --xara-games <dir>           For Xara's own games: create it in that xara-games checkout, at games/<game>.`;
 
 const fail = (message) => {
   console.error(`\n${message}\n`);
@@ -34,13 +34,15 @@ if (values.help || !positionals[0]) {
   process.exit(values.help ? 0 : 1);
 }
 
-const dir = resolve(positionals[0]);
-const folder = basename(dir);
+const folder = basename(positionals[0]);
 if (!/^[a-z0-9]+(-[a-z0-9]+)*$/.test(folder)) fail("Name the folder like word-chain: lowercase letters, numbers, and dashes.");
-if (existsSync(dir)) fail(`${dir} already exists.`);
 
-// Xara's own repos are named xara-<game>; the game is served at /<game>/.
+// Xara's own repos are named xara-<game>; the game lives in xara-games at games/<game> and is served at /<game>/.
 const path = folder.replace(/^xara-/, "");
+const gamesDir = values["xara-games"] && resolve(values["xara-games"]);
+const dir = gamesDir ? join(gamesDir, "games", path) : resolve(positionals[0]);
+const repoUrl = `https://github.com/xavatech/${folder}.git`;
+if (existsSync(dir)) fail(`${dir} already exists.`);
 const name = values.name?.trim() || path.split("-").map((word) => word[0].toUpperCase() + word.slice(1)).join(" ");
 const description = values.description?.trim() ?? "";
 const [minPlayers, maxPlayers = minPlayers] = values.players.split("-").map(Number);
@@ -48,7 +50,6 @@ if (![minPlayers, maxPlayers].every(Number.isInteger) || minPlayers < 2 || maxPl
   fail("--players is from 2 to 8, like 2 or 2-4.");
 }
 
-const gamesDir = values["xara-games"] && resolve(values["xara-games"]);
 const listFile = gamesDir && join(gamesDir, "games.json");
 const list = listFile && (existsSync(listFile) ? JSON.parse(readFileSync(listFile, "utf8")) : fail(`${listFile} was not found.`));
 if (list?.some((game) => game.path === path || game.name === name)) fail(`${path} or "${name}" is already in games.json.`);
@@ -75,8 +76,9 @@ run("npm install --no-fund --no-audit", dir);
 run(`git init -q -b main && git add -A && git commit -q -m "${name.replace(/"/g, "")} for Xara chats"`, dir);
 
 if (gamesDir) {
-  run(`git -c protocol.file.allow=always submodule add -q "${dir}" games/${path}`, gamesDir);
-  run(`git config -f .gitmodules submodule.games/${path}.url https://github.com/xavatech/${folder}.git`, gamesDir);
+  // The game is already at games/<game>, so this registers that repo in place instead of cloning it.
+  run(`git remote add origin ${repoUrl}`, dir);
+  run(`git submodule add -q ${repoUrl} games/${path}`, gamesDir);
   writeFileSync(listFile, `${JSON.stringify([...list, { path, name, description, minPlayers, maxPlayers }], null, 2)}\n`);
   run(`node build.mjs ${path}`, gamesDir);
   run("git add -A", gamesDir);
@@ -85,7 +87,7 @@ if (gamesDir) {
 console.log(`
 ${name} is ready.
 
-  cd ${positionals[0]}
+  cd ${dir}
   npm run dev        Play it in a browser; every player shares the screen.
 
 Then describe the real game to your coding assistant in that folder.`);
@@ -96,7 +98,7 @@ It is in xara-games at games/${path}, and built into site/${path}/.
 
   List it:  bun run avanda.ts app seed -t Game     (in xara_backend, with xara-games served at GAMES_URL)
   Push it:  create github.com/xavatech/${folder}, then
-            cd ${dir} && git remote add origin https://github.com/xavatech/${folder}.git && git push -u origin main
+            cd ${dir} && git push -u origin main
             cd ${gamesDir} && git commit -m "Add ${name}"`);
 } else {
   console.log(`To ship it, see README.md.`);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@xavatech/create-xara-game",
-  "version": "1.0.0",
+  "version": "1.0.1",
   "description": "Start a game for Xara chats: a working starter with the Xara game SDK and the coding-assistant skill.",
   "type": "module",
   "bin": {