pf2e-spellbook 1.0.0 → 1.2.1

package/README.md

@@ -76,6 +76,21 @@ curse, companions/familiars).
 
 ## Using it
 
+### Quick start (npm)
+
+With [Node.js](https://nodejs.org) installed:
+
+```sh
+npx pf2e-spellbook
+```
+
+That downloads the latest release, serves it at `http://localhost:8724`, and opens
+your browser. Characters are saved in that browser (per origin), so they survive
+package updates. `--port N` picks another port (a different port is a different
+origin, i.e. a separate set of characters); `--no-open` skips the browser launch.
+
+### The HTML file itself
+
 Open `dist/index.html` in any browser — no server, no install, works offline. State
 is saved in the browser's localStorage per device.
 

package/bin/cli.mjs

@@ -0,0 +1,86 @@
+#!/usr/bin/env node
+// Serves the built spellbook from dist/ on localhost and opens the browser.
+// The port is fixed by default: localStorage (where all characters live) is
+// keyed by origin, so a stable http://localhost:8724 keeps characters across
+// package updates and install locations. localhost is a secure context, so
+// the service worker and the "Install app" PWA button work too.
+import http from 'node:http';
+import { readFile } from 'node:fs/promises';
+import { fileURLToPath } from 'node:url';
+import { spawn } from 'node:child_process';
+
+const DEFAULT_PORT = 8724;
+
+const args = process.argv.slice(2);
+if (args.includes('--help') || args.includes('-h')) {
+  console.log(`Usage: pf2e-spellbook [--port N] [--no-open]
+
+Serves the PF2e Spellbook at http://localhost:${DEFAULT_PORT} and opens your browser.
+
+  --port N    listen on port N instead of ${DEFAULT_PORT} (note: characters are
+              stored per-origin, so a different port is a different spellbook)
+  --no-open   don't open the browser, just serve`);
+  process.exit(0);
+}
+const portIdx = args.indexOf('--port');
+const port = portIdx !== -1 ? Number(args[portIdx + 1]) : DEFAULT_PORT;
+if (!Number.isInteger(port) || port < 1 || port > 65535) {
+  console.error(`pf2e-spellbook: invalid --port ${args[portIdx + 1]}`);
+  process.exit(1);
+}
+const noOpen = args.includes('--no-open');
+
+const distDir = new URL('../dist/', import.meta.url);
+const FILES = {
+  '/': ['index.html', 'text/html; charset=utf-8'],
+  '/index.html': ['index.html', 'text/html; charset=utf-8'],
+  '/sw.js': ['sw.js', 'text/javascript; charset=utf-8'],
+  '/manifest.webmanifest': ['manifest.webmanifest', 'application/manifest+json'],
+  '/icon.svg': ['icon.svg', 'image/svg+xml'],
+};
+
+const server = http.createServer(async (req, res) => {
+  const entry = FILES[new URL(req.url, 'http://localhost').pathname];
+  if (!entry || (req.method !== 'GET' && req.method !== 'HEAD')) {
+    res.writeHead(404, { 'Content-Type': 'text/plain' }).end('Not found');
+    return;
+  }
+  const [file, type] = entry;
+  try {
+    const body = await readFile(new URL(file, distDir));
+    // no-cache so package updates (new sw.js/index.html) are picked up on reload
+    res.writeHead(200, {
+      'Content-Type': type,
+      'Content-Length': body.byteLength,
+      'Cache-Control': 'no-cache',
+    });
+    res.end(req.method === 'HEAD' ? undefined : body);
+  } catch {
+    res.writeHead(500, { 'Content-Type': 'text/plain' }).end('Read error');
+  }
+});
+
+function openBrowser(url) {
+  const [cmd, cmdArgs] =
+    process.platform === 'darwin' ? ['open', [url]]
+    : process.platform === 'win32' ? ['cmd', ['/c', 'start', '', url]]
+    : ['xdg-open', [url]];
+  spawn(cmd, cmdArgs, { stdio: 'ignore', detached: true }).on('error', () => {
+    console.error(`Couldn't open a browser — go to ${url}`);
+  }).unref();
+}
+
+const url = `http://localhost:${port}/`;
+server.on('error', (err) => {
+  if (err.code === 'EADDRINUSE') {
+    console.log(`Port ${port} is in use — assuming the spellbook is already running at ${url}`);
+    if (!noOpen) openBrowser(url);
+    process.exit(0);
+  }
+  console.error(`pf2e-spellbook: ${err.message}`);
+  process.exit(1);
+});
+server.listen(port, '127.0.0.1', () => {
+  console.log(`PF2e Spellbook running at ${url}  (Ctrl+C to stop)`);
+  if (!noOpen) openBrowser(url);
+});

package/dist/icon.svg

@@ -1,8 +1,8 @@
 <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 512 512" role="img" aria-label="Spellbook">
-  <rect width="512" height="512" rx="104" fill="#231710"/>
-  <g fill="none" stroke="#e0b252" stroke-width="22" stroke-linejoin="round" stroke-linecap="round">
+  <rect width="512" height="512" rx="104" fill="#1d2027"/>
+  <g fill="none" stroke="#7b6cf0" stroke-width="22" stroke-linejoin="round" stroke-linecap="round">
     <path d="M256 152 C220 128 168 128 130 146 L130 372 C168 354 220 354 256 380 C292 354 344 354 382 372 L382 146 C344 128 292 128 256 152 Z"/>
     <line x1="256" y1="152" x2="256" y2="380"/>
   </g>
-  <path d="M366 96 l12 30 30 12 -30 12 -12 30 -12 -30 -30 -12 30 -12 z" fill="#f4ead8"/>
+  <path d="M366 96 l12 30 30 12 -30 12 -12 30 -12 -30 -30 -12 30 -12 z" fill="#e8eaf0"/>
 </svg>