pf2e-spellbook 1.1.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/index.html

@@ -195,6 +195,8 @@ button{font-family:inherit;font-size:1.05rem;cursor:pointer;}
 }
 .btn.secondary{background:var(--surface-2);color:var(--accent-text);border:1px solid var(--accent-dim);box-shadow:none;}
 .btn:active{transform:translateY(1px);}
+a.btn{display:flex;align-items:center;justify-content:center;gap:8px;text-decoration:none;text-align:center;}
+a.btn .icn{width:1.15em;height:1.15em;}
 .linklike{background:none;border:none;color:var(--info);font-weight:700;text-decoration:underline;padding:0;font-size:inherit;}
 
 label.field{display:block;margin:14px 0;}
@@ -502,6 +504,11 @@ nav.bottom button.on{color:var(--accent-text);}
     <button class="btn secondary" onclick="importCharacter()">Import code</button>
   </div>
   <textarea id="menuIO" rows="3" placeholder="Character code appears here on Export — or paste one here, then tap Import."></textarea>
+
+  <h2 style="margin-top:24px">Support</h2>
+  <p class="meta">This spellbook is a free fan project. If it has earned a place at your table, you can help keep it going:</p>
+  <a class="btn secondary kofi" href="https://ko-fi.com/whytevoyd" target="_blank" rel="noopener"><svg class="icn" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="1.6" stroke-linecap="round" stroke-linejoin="round" aria-hidden="true"><path d="M3.5 8h13v6.5a4 4 0 0 1-4 4h-5a4 4 0 0 1-4-4z"/><path d="M16.5 9h1.75a2.75 2.75 0 1 1 0 5.5H16.5"/><path d="M10 15.2c-1.8-1.1-2.7-2.2-2.7-3.2 0-.9.7-1.6 1.6-1.6.5 0 .9.2 1.1.5.2-.3.6-.5 1.1-.5.9 0 1.6.7 1.6 1.6 0 1-.9 2.1-2.7 3.2z" fill="currentColor" stroke-width="0"/></svg> Support on Ko-fi</a>
+
   <button class="btn secondary" onclick="closeMenu()">← Back</button>
   <p class="meta" style="text-align:center;margin-top:18px;font-size:.8rem">Spell data: Paizo (OGL/ORC) via the Foundry VTT pf2e project · unofficial fan tool<br><span id="dataStamp"></span></p>
 </section>

package/dist/sw.js

@@ -2,7 +2,7 @@
    Network-first for the app page (fresh when online, cached when offline),
    cache-first for static assets. Cache version is stamped at build time so a
    redeploy refreshes clients automatically. */
-const CACHE = "pf2e-spellbook-20260705220027";
+const CACHE = "pf2e-spellbook-20260708225220";
 const SHELL = ["./", "./index.html", "./manifest.webmanifest", "./icon.svg"];
 
 self.addEventListener("install", (e) => {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "pf2e-spellbook",
-  "version": "1.1.0",
+  "version": "1.2.1",
   "description": "Interactive Pathfinder 2e spellbook (single self-contained HTML).",
   "keywords": [
     "pathfinder",
@@ -20,7 +20,14 @@
   "author": "Whyte",
   "license": "SEE LICENSE IN LICENSE",
   "type": "module",
+  "bin": {
+    "pf2e-spellbook": "bin/cli.mjs"
+  },
+  "engines": {
+    "node": ">=18"
+  },
   "files": [
+    "bin/",
     "src/",
     "tools/",
     "data/",

package/src/styles.css

@@ -166,6 +166,8 @@ button{font-family:inherit;font-size:1.05rem;cursor:pointer;}
 }
 .btn.secondary{background:var(--surface-2);color:var(--accent-text);border:1px solid var(--accent-dim);box-shadow:none;}
 .btn:active{transform:translateY(1px);}
+a.btn{display:flex;align-items:center;justify-content:center;gap:8px;text-decoration:none;text-align:center;}
+a.btn .icn{width:1.15em;height:1.15em;}
 .linklike{background:none;border:none;color:var(--info);font-weight:700;text-decoration:underline;padding:0;font-size:inherit;}
 
 label.field{display:block;margin:14px 0;}

package/src/template.html

@@ -73,6 +73,11 @@
     <button class="btn secondary" onclick="importCharacter()">Import code</button>
   </div>
   <textarea id="menuIO" rows="3" placeholder="Character code appears here on Export — or paste one here, then tap Import."></textarea>
+
+  <h2 style="margin-top:24px">Support</h2>
+  <p class="meta">This spellbook is a free fan project. If it has earned a place at your table, you can help keep it going:</p>
+  <a class="btn secondary kofi" href="https://ko-fi.com/whytevoyd" target="_blank" rel="noopener"><svg class="icn" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="1.6" stroke-linecap="round" stroke-linejoin="round" aria-hidden="true"><path d="M3.5 8h13v6.5a4 4 0 0 1-4 4h-5a4 4 0 0 1-4-4z"/><path d="M16.5 9h1.75a2.75 2.75 0 1 1 0 5.5H16.5"/><path d="M10 15.2c-1.8-1.1-2.7-2.2-2.7-3.2 0-.9.7-1.6 1.6-1.6.5 0 .9.2 1.1.5.2-.3.6-.5 1.1-.5.9 0 1.6.7 1.6 1.6 0 1-.9 2.1-2.7 3.2z" fill="currentColor" stroke-width="0"/></svg> Support on Ko-fi</a>
+
   <button class="btn secondary" onclick="closeMenu()">← Back</button>
   <p class="meta" style="text-align:center;margin-top:18px;font-size:.8rem">Spell data: Paizo (OGL/ORC) via the Foundry VTT pf2e project · unofficial fan tool<br><span id="dataStamp"></span></p>
 </section>