create-vimp-game 0.3.6 → 0.4.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "create-vimp-game",
-  "version": "0.3.6",
+  "version": "0.4.0",
   "description": "Scaffolder for VIMP game plugins",
   "keywords": [
     "vimp",

package/src/versions.generated.json

@@ -1,4 +1,4 @@
 {
-  "engine": "0.22.1",
-  "core": "0.8.4"
+  "engine": "0.24.0",
+  "core": "0.9.1"
 }

package/templates/default/scripts/build-game-manifest.js

@@ -153,7 +153,17 @@ if (hasNodeCore) {
 
 const manifest = {
   id: '{{GAME_ID}}',
+  // a generation stamp, not a gate: the engine no longer rejects a package
+  // whose engineApi is older than its own, so a game does not expire when the
+  // engine releases (docs/en/plugin-api.md)
   engineApi: ENGINE_API_VERSION,
+  // engine capabilities the game cannot run without — names from
+  // `vimp-engine/lib/capabilities.js`, checked by contract rule B2. Empty is
+  // the normal state: a game that degrades gracefully (does not ask for the
+  // service, does not subscribe to the port) declares nothing. Add a name
+  // only when its absence makes the match unplayable — an engine too old to
+  // provide it then refuses the game instead of half-running it.
+  requires: [],
   version,
   title: '{{GAME_TITLE}}',
   entries: {

package/templates/default/src/client/index.js

@@ -10,8 +10,14 @@ import { isNodeCore, loadNodeCore, loadWebCore } from '../host/nodeCore.js';
 // GameManifest.entries.client.
 export default {
   id: '{{GAME_ID}}',
+  // same generation stamp as the host half and the manifest: imported, never
+  // a literal, and not something the game ages out of (see src/host/index.js)
   engineApi: ENGINE_API_VERSION,
 
+  // same list as the host half and GameManifest.requires — read by the
+  // standalone SDK, which has no manifest to read it from
+  requires: [],
+
   // MUST return { core, memory }: `memory` is the WebAssembly memory the
   // engine reads the hot buffer out of every render tick. Without it the
   // client silently renders nothing but the discrete frames.

package/templates/default/src/host/index.js

@@ -21,9 +21,18 @@ import { isNodeCore, loadNodeCore, loadWebCore } from './nodeCore.js';
 export default {
   id: '{{GAME_ID}}',
   // never a literal: a number written by hand agrees with the engine on the
-  // day it is typed and silently disagrees after the next release
+  // day it is typed and silently disagrees after the next release.
+  // It is a generation stamp, not a gate — the engine accepts a package whose
+  // engineApi is older than its own, so the game does not expire when the
+  // engine releases (docs/en/plugin-api.md)
   engineApi: ENGINE_API_VERSION,
 
+  // engine capabilities the game cannot run without — the same list as
+  // GameManifest.requires (scripts/build-game-manifest.js), repeated here
+  // because the standalone SDK has no manifest: `npm run dev` builds the
+  // match from the live plugin objects. Empty is the normal state
+  requires: [],
+
   // wasmUrl comes from the manifest: init() loads by an explicit URL instead
   // of the glue module's own import.meta.url resolution, which does not
   // survive inside a Worker

package/templates/default/tests/config/contract.test.js

@@ -14,9 +14,13 @@ describe('game config', () => {
     expect(() => assertGameConfigShape(hostPlugin)).not.toThrow();
   });
 
-  it('declares one API version in both halves', () => {
+  // rule B2: the two halves and the manifest must agree with EACH OTHER —
+  // a mismatch there is a stale bundle inside one package. Agreement with the
+  // installed engine is no longer required of a published game; here it holds
+  // because both halves import the value instead of writing a literal
+  it('stamps one generation on both halves', () => {
+    expect(hostPlugin.engineApi).toBe(clientPlugin.engineApi);
     expect(hostPlugin.engineApi).toBe(ENGINE_API_VERSION);
-    expect(clientPlugin.engineApi).toBe(ENGINE_API_VERSION);
     expect(hostPlugin.id).toBe(clientPlugin.id);
   });
 });