@origingame/create-game 0.4.0 → 0.5.0

package/README.md

@@ -35,8 +35,11 @@ catalogue (`packages/knowledge/looks/catalogue.json`, 37 styles):
 - `--premise "<one line>"` picks the style whose premise fits best (a word
   of the premise in a style's genre counts 3, in its mood 2, in its era,
   audience, name or descriptor 1; a tie goes to a style the engine draws
-  whole, then to catalogue order). On a terminal, with neither flag, create
-  asks for the premise (`--no-prompt` does not);
+  whole, then to catalogue order), among the styles whose `look.profiles`
+  include the game's profile: a 3D game never gets a flipbook-only style,
+  a 2D one never a style of lit meshes (`--look` names any). On a
+  terminal, with neither flag, create asks for the premise (`--no-prompt`
+  does not);
 - otherwise the template's own look stays: the plain template extends
   `faceted-low-poly`, the idle archetype carries its UI style and render
   settings, and the other archetypes get a look that extends nothing (their

package/archetypes/arena/package.json

@@ -13,6 +13,6 @@
     "test": "og test ."
   },
   "dependencies": {
-    "@origingame/engine": "0.4.0"
+    "@origingame/engine": "0.5.0"
   }
 }

package/archetypes/arena/project.ogt

@@ -3,7 +3,7 @@ version 1
 ---
 name "Coin Duel"
 id "arena"
-engine "0.4.0"
+engine "0.5.0"
 entry "src/main.ts"
 profile "2d"
 tick 60

package/archetypes/idle/package.json

@@ -13,6 +13,6 @@
     "test": "og test ."
   },
   "dependencies": {
-    "@origingame/engine": "0.4.0"
+    "@origingame/engine": "0.5.0"
   }
 }

package/archetypes/idle/project.ogt

@@ -3,7 +3,7 @@ version 1
 ---
 name "Spark Orb"
 id "idle"
-engine "0.4.0"
+engine "0.5.0"
 entry "src/main.ts"
 profile "2d"
 tick 60

package/archetypes/match3/package.json

@@ -13,6 +13,6 @@
     "test": "og test ."
   },
   "dependencies": {
-    "@origingame/engine": "0.4.0"
+    "@origingame/engine": "0.5.0"
   }
 }

package/archetypes/match3/project.ogt

@@ -3,7 +3,7 @@ version 1
 ---
 name "Tile Swap"
 id "match3"
-engine "0.4.0"
+engine "0.5.0"
 entry "src/main.ts"
 profile "2d"
 tick 60

package/archetypes/rhythm/package.json

@@ -13,6 +13,6 @@
     "test": "og test ."
   },
   "dependencies": {
-    "@origingame/engine": "0.4.0"
+    "@origingame/engine": "0.5.0"
   }
 }

package/archetypes/rhythm/project.ogt

@@ -3,7 +3,7 @@ version 1
 ---
 name "Three-Lane Beat"
 id "rhythm"
-engine "0.4.0"
+engine "0.5.0"
 entry "src/main.ts"
 profile "2d"
 tick 60

package/archetypes/roguelike/package.json

@@ -13,6 +13,6 @@
     "test": "og test ."
   },
   "dependencies": {
-    "@origingame/engine": "0.4.0"
+    "@origingame/engine": "0.5.0"
   }
 }

package/archetypes/roguelike/project.ogt

@@ -3,7 +3,7 @@ version 1
 ---
 name "Lamp Dive"
 id "roguelike"
-engine "0.4.0"
+engine "0.5.0"
 entry "src/main.ts"
 profile "2d"
 tick 60

package/archetypes/runner/package.json

@@ -13,6 +13,6 @@
     "test": "og test ."
   },
   "dependencies": {
-    "@origingame/engine": "0.4.0"
+    "@origingame/engine": "0.5.0"
   }
 }

package/archetypes/runner/project.ogt

@@ -3,7 +3,7 @@ version 1
 ---
 name "Runner"
 id "runner"
-engine "0.4.0"
+engine "0.5.0"
 entry "src/main.ts"
 profile "2d"
 tick 60

package/archetypes/third-person/package.json

@@ -13,6 +13,6 @@
     "test": "og test ."
   },
   "dependencies": {
-    "@origingame/engine": "0.4.0"
+    "@origingame/engine": "0.5.0"
   }
 }

package/archetypes/third-person/project.ogt

@@ -3,7 +3,7 @@ version 1
 ---
 name "Ember Vale"
 id "third-person"
-engine "0.4.0"
+engine "0.5.0"
 entry "src/main.ts"
 profile "3d"
 tick 60

package/archetypes/topdown/package.json

@@ -13,6 +13,6 @@
     "test": "og test ."
   },
   "dependencies": {
-    "@origingame/engine": "0.4.0"
+    "@origingame/engine": "0.5.0"
   }
 }

package/archetypes/topdown/project.ogt

@@ -3,7 +3,7 @@ version 1
 ---
 name "Tomb Room"
 id "topdown"
-engine "0.4.0"
+engine "0.5.0"
 entry "src/main.ts"
 profile "2d"
 tick 60

package/archetypes/tower-defense/package.json

@@ -13,6 +13,6 @@
     "test": "og test ."
   },
   "dependencies": {
-    "@origingame/engine": "0.4.0"
+    "@origingame/engine": "0.5.0"
   }
 }

package/archetypes/tower-defense/project.ogt

@@ -3,7 +3,7 @@ version 1
 ---
 name "Path Guard"
 id "tower-defense"
-engine "0.4.0"
+engine "0.5.0"
 entry "src/main.ts"
 profile "2d"
 tick 60

package/bin/create.ts

@@ -101,7 +101,8 @@ export interface Style {
   readonly category: string;
   readonly descriptor: string;
   readonly premise: Readonly<Record<string, string>>;
-  readonly look: { readonly presetReady: boolean; readonly support: string; readonly missing: readonly string[] };
+  /** `profiles`: the project profiles the look draws for, `2d`, `3d` or both (a flipbook or hand-pixelled style is 2D only, a style of meshes and lit materials 3D only). */
+  readonly look: { readonly presetReady: boolean; readonly support: string; readonly profiles: readonly Profile[]; readonly missing: readonly string[] };
   readonly ui: string;
 }
 
@@ -135,9 +136,12 @@ export function words(text: string): string[] {
  * the premise found in a style's genre counts 3, in its mood 2, in its era
  * or audience 1, in its name or descriptor 1. Ties go to the style whose
  * look the engine draws whole (support `full`), then to catalogue order.
- * Null when no word matches any style. Only styles with a preset are chosen.
+ * Null when no word matches any style. Only styles with a preset that draw
+ * for the project's profile (`look.profiles`, 3D unless `2d`) are chosen: a
+ * 3D party premise never lands on a flipbook style, a 2D platformer never on
+ * a style of lit meshes. `--look` is not weighed here and may pick any.
  */
-export function pickStyle(premise: string, styles: readonly Style[]): { style: Style; score: number } | null {
+export function pickStyle(premise: string, styles: readonly Style[], profile: Profile = "3d"): { style: Style; score: number } | null {
   const asked = new Set(words(premise));
   if (asked.size === 0) return null;
   const weights: [(s: Style) => string, number][] = [
@@ -149,7 +153,7 @@ export function pickStyle(premise: string, styles: readonly Style[]): { style: S
   ];
   let best: { style: Style; score: number; full: boolean } | null = null;
   for (const style of styles) {
-    if (!style.look.presetReady) continue;
+    if (!style.look.presetReady || !style.look.profiles.includes(profile)) continue;
     let score = 0;
     for (const [field, weight] of weights) {
       const have = new Set(words(field(style)));
@@ -368,13 +372,13 @@ export function create(options: CreateOptions): Created {
   if (options.profile !== undefined && options.archetype !== undefined) {
     throw new Error(`--profile and --archetype together: an archetype has its own profile (${options.archetype}); drop one`);
   }
-  const choice = chooseStyle(options);
   const asked = options.profile ?? (options.premise !== undefined ? premiseProfile(options.premise) : null);
   const template = options.template ?? templateDir(options.archetype, asked ?? "3d");
   const profile: CreatedProfile = {
     value: profileOf(template),
     chosen: options.archetype !== undefined ? "archetype" : options.profile !== undefined ? "flag" : asked !== null ? "premise" : "template",
   };
+  const choice = chooseStyle(options, profile.value);
   const list = files(template);
   const written: string[] = [];
   mkdirSync(dir, { recursive: true });
@@ -402,8 +406,8 @@ export function create(options: CreateOptions): Created {
  * chose, and the entry's GameDesc.look pointed at it (inserted after
  * `og.game({` when the template names none).
  */
-/** The preset `--look` names or the premise fits; throws for a slug the catalogue has no preset for. */
-function chooseStyle(options: CreateOptions): { styles: Style[]; style: Style | undefined; chosen: CreatedLook["chosen"]; notes: string[] } {
+/** The preset `--look` names or the premise fits for the project's profile; throws for a slug the catalogue has no preset for. */
+function chooseStyle(options: CreateOptions, profile: Profile): { styles: Style[]; style: Style | undefined; chosen: CreatedLook["chosen"]; notes: string[] } {
   const styles = readCatalogue(options.catalogue);
   if (options.look !== undefined) {
     const style = styles.find((s) => s.slug === options.look);
@@ -413,9 +417,9 @@ function chooseStyle(options: CreateOptions): { styles: Style[]; style: Style |
     return { styles, style, chosen: "flag", notes: [] };
   }
   if (options.premise !== undefined && options.premise.trim() !== "") {
-    const pick = pickStyle(options.premise, styles);
+    const pick = pickStyle(options.premise, styles, profile);
     if (pick) return { styles, style: pick.style, chosen: "premise", notes: [] };
-    return { styles, style: undefined, chosen: "none", notes: [`no catalogue style matched the premise "${options.premise}"; the look keeps the template's (og-taste §1 chooses one by genre, mood, era and audience: pass --look <slug>)`] };
+    return { styles, style: undefined, chosen: "none", notes: [`no catalogue style matched the premise "${options.premise}" for a ${profile.toUpperCase()} game; the look keeps the template's (og-taste §1 chooses one by genre, mood, era and audience: pass --look <slug>)`] };
   }
   return { styles, style: undefined, chosen: "none", notes: [] };
 }
@@ -485,8 +489,8 @@ Scaffolds an Origin Engine game into dir (default: ./origin-game).
   --id     the game's id, lowercase-hyphen (default: from the name)
   --profile    2d writes the 2D starter (a platformer: sprites, tilemap, 2D physics), 3d the 3D template (default: 2d for a premise that says 2D, platformer, side-scroller, metroidvania or pixel art without saying 3D; else 3d)
   --archetype  start from a complete archetype game (runner, match3, topdown, tower-defense, roguelike, idle, rhythm, third-person, arena) instead of the template; it has its own profile
-  --premise    the game in one line (genre, mood, setting, audience): its look extends the style catalogue's best match (asked for on a terminal when neither this nor --look is given)
-  --look   the style catalogue slug the look extends (og-taste §12), such as anime-cel-3d or 16bit-pixel
+  --premise    the game in one line (genre, mood, setting, audience): its look extends the style catalogue's best match among the styles drawn for the game's profile (asked for on a terminal when neither this nor --look is given)
+  --look   the style catalogue slug the look extends (og-taste §12), such as anime-cel-3d or 16bit-pixel; it wins over the premise and the profile
   --no-prompt  never ask for the premise
   --force  write into a directory that is not empty`;
 

package/looks/catalogue.json

@@ -37,6 +37,10 @@
         "preset": "templates/looks/expressionist-painting.ogt",
         "presetReady": true,
         "support": "content",
+        "profiles": [
+          "2d",
+          "3d"
+        ],
         "primitives": [
           "Stylise.paintRadius",
           "Stylise.paintCanvas",
@@ -88,6 +92,10 @@
         "preset": "templates/looks/bold-comic-illustration.ogt",
         "presetReady": true,
         "support": "full",
+        "profiles": [
+          "2d",
+          "3d"
+        ],
         "primitives": [
           "StandardMaterialDesc.toon",
           "PostEffects.outline",
@@ -137,6 +145,10 @@
         "preset": "templates/looks/watercolor-wash.ogt",
         "presetReady": true,
         "support": "full",
+        "profiles": [
+          "2d",
+          "3d"
+        ],
         "primitives": [
           "Stylise.paintEdgeDarkening",
           "Stylise.paintBleed",
@@ -186,6 +198,9 @@
         "preset": "templates/looks/pixel-3d-hybrid.ogt",
         "presetReady": true,
         "support": "full",
+        "profiles": [
+          "3d"
+        ],
         "primitives": [
           "PostEffects.depthOfField",
           "PostEffects.ao",
@@ -237,6 +252,9 @@
         "preset": "templates/looks/faceted-low-poly.ogt",
         "presetReady": true,
         "support": "full",
+        "profiles": [
+          "3d"
+        ],
         "primitives": [
           "StandardMaterialDesc.flatShading",
           "Fog",
@@ -276,8 +294,8 @@
         "Animation holds poses for 2 or more ticks (stepped, not interpolated)."
       ],
       "premise": {
-        "genre": "adventure, platformer, comedy",
-        "mood": "warm, odd, handmade",
+        "genre": "adventure, platformer, comedy, party games",
+        "mood": "warm, odd, playful, handmade",
         "era": "stop-motion film",
         "audience": "all ages, art-house"
       },
@@ -285,6 +303,9 @@
         "preset": "templates/looks/sculpted-clay.ogt",
         "presetReady": true,
         "support": "full",
+        "profiles": [
+          "3d"
+        ],
         "primitives": [
           "StandardMaterialDesc.roughness",
           "StandardMaterialDesc.sheen",
@@ -336,6 +357,9 @@
         "preset": "templates/looks/8bit-pixel.ogt",
         "presetReady": true,
         "support": "full",
+        "profiles": [
+          "2d"
+        ],
         "primitives": [
           "Stylise.pixelHeight",
           "Stylise.palette",
@@ -386,6 +410,9 @@
         "preset": "templates/looks/voxel-worlds.ogt",
         "presetReady": true,
         "support": "full",
+        "profiles": [
+          "3d"
+        ],
         "primitives": [
           "StandardMaterialDesc.flatShading",
           "PostEffects.ao",
@@ -434,6 +461,9 @@
         "preset": "templates/looks/illuminated-manuscript.ogt",
         "presetReady": true,
         "support": "content",
+        "profiles": [
+          "2d"
+        ],
         "primitives": [
           "Stylise.paintCanvas",
           "Stylise.ink",
@@ -485,6 +515,9 @@
         "preset": "templates/looks/rubber-hose-animation.ogt",
         "presetReady": true,
         "support": "content",
+        "profiles": [
+          "2d"
+        ],
         "primitives": [
           "PostEffects.filmGrain",
           "PostEffects.vignette",
@@ -536,6 +569,9 @@
         "preset": "templates/looks/pencil-hatching.ogt",
         "presetReady": true,
         "support": "full",
+        "profiles": [
+          "3d"
+        ],
         "primitives": [
           "Stylise.hatching",
           "Stylise.hatchingLevels",
@@ -585,6 +621,9 @@
         "preset": "templates/looks/gothic-contour.ogt",
         "presetReady": true,
         "support": "content",
+        "profiles": [
+          "2d"
+        ],
         "primitives": [
           "Fog",
           "PostEffects.glow",
@@ -637,6 +676,10 @@
         "preset": "templates/looks/lush-painted-worlds.ogt",
         "presetReady": true,
         "support": "content",
+        "profiles": [
+          "2d",
+          "3d"
+        ],
         "primitives": [
           "Stylise.paintRadius",
           "Stylise.paintCanvas",
@@ -688,6 +731,10 @@
         "preset": "templates/looks/decorative-storybook.ogt",
         "presetReady": true,
         "support": "content",
+        "profiles": [
+          "2d",
+          "3d"
+        ],
         "primitives": [
           "Stylise.ink",
           "Stylise.paintCanvas",
@@ -738,6 +785,9 @@
         "preset": "templates/looks/classical-painting-collage.ogt",
         "presetReady": true,
         "support": "content",
+        "profiles": [
+          "2d"
+        ],
         "primitives": [
           "sprites with transforms",
           "PostEffects.vignette",
@@ -788,6 +838,9 @@
         "preset": "templates/looks/detailed-doodle.ogt",
         "presetReady": true,
         "support": "content",
+        "profiles": [
+          "2d"
+        ],
         "primitives": [
           "Stylise.ink",
           "unlit materials",
@@ -838,6 +891,10 @@
         "preset": "templates/looks/black-figure-pottery.ogt",
         "presetReady": true,
         "support": "content",
+        "profiles": [
+          "2d",
+          "3d"
+        ],
         "primitives": [
           "Stylise.palette",
           "Stylise.posterize",
@@ -888,6 +945,9 @@
         "preset": "templates/looks/heavy-ink-shadows.ogt",
         "presetReady": true,
         "support": "full",
+        "profiles": [
+          "3d"
+        ],
         "primitives": [
           "Stylise.posterize",
           "Stylise.hatching",
@@ -937,6 +997,9 @@
         "preset": "templates/looks/monochrome-pixel.ogt",
         "presetReady": true,
         "support": "full",
+        "profiles": [
+          "2d"
+        ],
         "primitives": [
           "Stylise.pixelHeight",
           "Stylise.palette",
@@ -986,6 +1049,9 @@
         "preset": "templates/looks/16bit-pixel.ogt",
         "presetReady": true,
         "support": "full",
+        "profiles": [
+          "2d"
+        ],
         "primitives": [
           "Stylise.pixelHeight",
           "Stylise.pixelSnap",
@@ -1035,6 +1101,9 @@
         "preset": "templates/looks/detailed-pixel.ogt",
         "presetReady": true,
         "support": "full",
+        "profiles": [
+          "2d"
+        ],
         "primitives": [
           "Stylise.pixelHeight",
           "Stylise.pixelSnap",
@@ -1085,6 +1154,9 @@
         "preset": "templates/looks/luminous-pixel.ogt",
         "presetReady": true,
         "support": "full",
+        "profiles": [
+          "2d"
+        ],
         "primitives": [
           "Stylise.pixelHeight",
           "Lighting2D",
@@ -1135,6 +1207,9 @@
         "preset": "templates/looks/topdown-tile-pixel.ogt",
         "presetReady": true,
         "support": "full",
+        "profiles": [
+          "2d"
+        ],
         "primitives": [
           "tilemap layers",
           "Sprite.sortY",
@@ -1184,6 +1259,9 @@
         "preset": "templates/looks/low-resolution-3d.ogt",
         "presetReady": true,
         "support": "full",
+        "profiles": [
+          "3d"
+        ],
         "primitives": [
           "Stylise.pixelHeight",
           "Stylise.vertexSnap",
@@ -1235,6 +1313,9 @@
         "preset": "templates/looks/coarse-pixel.ogt",
         "presetReady": true,
         "support": "full",
+        "profiles": [
+          "2d"
+        ],
         "primitives": [
           "Stylise.pixelHeight",
           "Stylise.palette",
@@ -1283,6 +1364,9 @@
         "preset": "templates/looks/anime-cel-3d.ogt",
         "presetReady": true,
         "support": "full",
+        "profiles": [
+          "3d"
+        ],
         "primitives": [
           "StandardMaterialDesc.toon",
           "StandardMaterialDesc.gradientMap",
@@ -1334,6 +1418,9 @@
         "preset": "templates/looks/inked-comic-3d.ogt",
         "presetReady": true,
         "support": "full",
+        "profiles": [
+          "3d"
+        ],
         "primitives": [
           "PostEffects.outline",
           "StandardMaterialDesc.toon",
@@ -1385,6 +1472,9 @@
         "preset": "templates/looks/paper-craft.ogt",
         "presetReady": true,
         "support": "full",
+        "profiles": [
+          "3d"
+        ],
         "primitives": [
           "StandardMaterialDesc.flatShading",
           "MaterialStyle.flatShading",
@@ -1435,6 +1525,9 @@
         "preset": "templates/looks/miniature-diorama.ogt",
         "presetReady": true,
         "support": "full",
+        "profiles": [
+          "3d"
+        ],
         "primitives": [
           "PostEffects.depthOfField",
           "PostEffects.ao",
@@ -1485,6 +1578,9 @@
         "preset": "templates/looks/painterly-3d.ogt",
         "presetReady": true,
         "support": "full",
+        "profiles": [
+          "3d"
+        ],
         "primitives": [
           "Stylise.paintRadius",
           "Stylise.paintAnisotropy",
@@ -1535,6 +1631,9 @@
         "preset": "templates/looks/cinematic-realism.ogt",
         "presetReady": true,
         "support": "full",
+        "profiles": [
+          "3d"
+        ],
         "primitives": [
           "StandardMaterial (PBR)",
           "Environment",
@@ -1587,6 +1686,9 @@
         "preset": "templates/looks/muted-cinematic-3d.ogt",
         "presetReady": true,
         "support": "full",
+        "profiles": [
+          "3d"
+        ],
         "primitives": [
           "PostEffects.godRays",
           "Fog",
@@ -1638,6 +1740,10 @@
         "preset": "templates/looks/layered-silhouette.ogt",
         "presetReady": true,
         "support": "full",
+        "profiles": [
+          "2d",
+          "3d"
+        ],
         "primitives": [
           "Stylise.depthBands",
           "Fog",
@@ -1687,6 +1793,10 @@
         "preset": "templates/looks/minimal-geometric.ogt",
         "presetReady": true,
         "support": "full",
+        "profiles": [
+          "2d",
+          "3d"
+        ],
         "primitives": [
           "unlit materials",
           "boxGeometry/sphereGeometry/planeGeometry",
@@ -1736,6 +1846,10 @@
         "preset": "templates/looks/neon-vector.ogt",
         "presetReady": true,
         "support": "full",
+        "profiles": [
+          "2d",
+          "3d"
+        ],
         "primitives": [
           "RenderSettings.bloom",
           "emissive unlit materials",
@@ -1787,6 +1901,9 @@
         "preset": "templates/looks/monochrome-dither-3d.ogt",
         "presetReady": true,
         "support": "full",
+        "profiles": [
+          "3d"
+        ],
         "primitives": [
           "Stylise.posterize",
           "Stylise.palette",
@@ -1836,6 +1953,10 @@
         "preset": "templates/looks/luminous-layered-painting.ogt",
         "presetReady": true,
         "support": "full",
+        "profiles": [
+          "2d",
+          "3d"
+        ],
         "primitives": [
           "sprite layers",
           "Fog",

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@origingame/create-game",
-  "version": "0.4.0",
+  "version": "0.5.0",
   "description": "Scaffolds an Origin Engine game from the project template: npm create @origingame/game.",
   "license": "MIT",
   "repository": {

package/template/package.json

@@ -13,6 +13,6 @@
     "test": "og test ."
   },
   "dependencies": {
-    "@origingame/engine": "0.4.0"
+    "@origingame/engine": "0.5.0"
   }
 }

package/template/project.ogt

@@ -7,7 +7,7 @@ version 1
 name "Origin Game"
 id "origin-game"
 # The engine this game is written against (design §9: upgrades are explicit).
-engine "0.4.0"
+engine "0.5.0"
 entry "src/main.ts"
 # 2d (orthographic camera, sprites, 2D physics) or 3d.
 profile "3d"

package/template-2d/package.json

@@ -13,6 +13,6 @@
     "test": "og test ."
   },
   "dependencies": {
-    "@origingame/engine": "0.4.0"
+    "@origingame/engine": "0.5.0"
   }
 }

package/template-2d/project.ogt

@@ -7,7 +7,7 @@ version 1
 name "Origin Game 2D"
 id "origin-game-2d"
 # The engine this game is written against (design §9: upgrades are explicit).
-engine "0.4.0"
+engine "0.5.0"
 entry "src/main.ts"
 # 2d: an orthographic camera, sprites, flipbooks, tilemaps and 2D physics.
 profile "2d"