@origingame/create-game 0.1.0 → 0.2.0

package/README.md

@@ -1,7 +1,8 @@
 # @origingame/create-game
 
-Scaffolds an Origin Engine game from the project template (`templates/game`
-of the engine repository): `project.ogt`, `src/`, `assets/`, `tests/`,
+Scaffolds an Origin Engine game from a project template of the engine
+repository, the 3D template `templates/game` or the 2D starter
+`templates/game-2d`: `project.ogt`, `src/`, `assets/`, `tests/`,
 `package.json` and `tsconfig.json`, with the game's name and id filled in.
 
 ```sh
@@ -9,13 +10,20 @@ bun packages/create/bin/create.ts my-game --name "My Game"   # in the engine rep
 cd my-game && bun install && og cook && og run .
 ```
 
-`create [dir] [--name "Name"] [--id slug] [--archetype name] [--premise "one line"] [--look slug] [--force]`: the
+`create [dir] [--name "Name"] [--id slug] [--profile 2d|3d] [--archetype name] [--premise "one line"] [--look slug] [--force]`: the
 id defaults to the name in lowercase-hyphen form (or the directory's name);
 a directory that is not empty is refused unless `--force` is given.
+`--profile 2d` writes the 2D starter (a courier's platformer: sprites,
+flipbooks, a tilemap with one-way ledges, 2D physics, a HUD and a pause
+menu, one playtest), `--profile 3d` the 3D template; without the flag, a
+premise that says 2D, platformer, side-scroller, metroidvania, pixel art,
+sprites or tiles without saying 3D gets the 2D starter, anything else the
+3D template. The output's `Profile:` line says which and why.
 `--archetype` starts from a complete game of `templates/archetypes/`
-instead of the template: `runner`, `match3`, `topdown`, `tower-defense`,
+instead of either template: `runner`, `match3`, `topdown`, `tower-defense`,
 `roguelike`, `idle`, `rhythm` or `third-person` (the published package carries them under
-`archetypes/`).
+`archetypes/`); an archetype has its own profile, so `--profile` beside it
+is refused.
 
 Every game gets its look: `assets/looks/<id>.ogt`, an `.ogt` of `type look`
 (og-taste §12 of the knowledge package) that `GameDesc.look` in the entry
@@ -42,8 +50,8 @@ is, what it extends and how to change it. For an archetype, a preset moves
 the frames its `references/` hold; create says so and how to record them
 again.
 
-The published package carries the template under `template/` and the style
-catalogue under `looks/`, copied by the `prepack` script
+The published package carries the 3D template under `template/`, the 2D
+starter under `template-2d/` and the style catalogue under `looks/`, copied by the `prepack` script
 (`scripts/pack-template.ts`); build output (`cooked/`,
 `dist/`, `node_modules/`) is never copied. The template's `gitattributes`
 (media through Git LFS) is written as the project's `.gitattributes`: under

package/archetypes/README.md

@@ -1,8 +1,10 @@
 # Archetypes
 
 Complete games a Maker starts from, each a project like `templates/game`
-(`project.ogt`, `src/`, `assets/`, `tests/`, `package.json`,
-`tsconfig.json`) that `og run`, `og test` and `og build` take as is. They
+and the 2D starter `templates/game-2d` (`project.ogt`, `src/`, `assets/`,
+`tests/`, `package.json`, `tsconfig.json`) that `og run`, `og test` and
+`og build` take as is; `npm create @origingame/game --archetype <name>`
+writes one, with its own profile. They
 rebuild the platform's six Godot Discover prototypes on Origin Engine,
 keeping each prototype's premise and lessons and none of its code or art,
 and add a top-down room built for the engine's 2D and game-feel modules

package/archetypes/idle/gitignore

@@ -0,0 +1,8 @@
+# og cook output: rebuilt from assets/, never committed.
+cooked/
+# og build output.
+dist/
+# og run and og test output, and og's bundled entry.
+og-out/
+.og/
+node_modules/

package/archetypes/idle/package.json

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

package/archetypes/idle/project.ogt

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

package/archetypes/match3/gitignore

@@ -0,0 +1,8 @@
+# og cook output: rebuilt from assets/, never committed.
+cooked/
+# og build output.
+dist/
+# og run and og test output, and og's bundled entry.
+og-out/
+.og/
+node_modules/

package/archetypes/match3/package.json

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

package/archetypes/match3/project.ogt

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

package/archetypes/rhythm/gitignore

@@ -0,0 +1,8 @@
+# og cook output: rebuilt from assets/, never committed.
+cooked/
+# og build output.
+dist/
+# og run and og test output, and og's bundled entry.
+og-out/
+.og/
+node_modules/

package/archetypes/rhythm/package.json

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

package/archetypes/rhythm/project.ogt

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

package/archetypes/roguelike/gitignore

@@ -0,0 +1,8 @@
+# og cook output: rebuilt from assets/, never committed.
+cooked/
+# og build output.
+dist/
+# og run and og test output, and og's bundled entry.
+og-out/
+.og/
+node_modules/

package/archetypes/roguelike/package.json

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

package/archetypes/roguelike/project.ogt

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

package/archetypes/runner/gitignore

@@ -0,0 +1,8 @@
+# og cook output: rebuilt from assets/, never committed.
+cooked/
+# og build output.
+dist/
+# og run and og test output, and og's bundled entry.
+og-out/
+.og/
+node_modules/

package/archetypes/runner/package.json

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

package/archetypes/runner/project.ogt

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

package/archetypes/third-person/gitignore

@@ -0,0 +1,8 @@
+# og cook output: rebuilt from assets/, never committed.
+cooked/
+# og build output.
+dist/
+# og run and og test output, and og's bundled entry.
+og-out/
+.og/
+node_modules/

package/archetypes/third-person/package.json

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

package/archetypes/third-person/project.ogt

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

package/archetypes/topdown/gitignore

@@ -0,0 +1,8 @@
+# og cook output: rebuilt from assets/, never committed.
+cooked/
+# og build output.
+dist/
+# og run and og test output, and og's bundled entry.
+og-out/
+.og/
+node_modules/

package/archetypes/topdown/package.json

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

package/archetypes/topdown/project.ogt

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

package/archetypes/tower-defense/gitignore

@@ -0,0 +1,8 @@
+# og cook output: rebuilt from assets/, never committed.
+cooked/
+# og build output.
+dist/
+# og run and og test output, and og's bundled entry.
+og-out/
+.og/
+node_modules/

package/archetypes/tower-defense/package.json

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

package/archetypes/tower-defense/project.ogt

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

package/bin/create.ts

@@ -2,13 +2,16 @@
 // `npm create @origingame/game` (and `bun create`): scaffolds the Origin
 // Engine project template (templates/game) into a directory, naming the game.
 //
-//   create [dir] [--name "Name"] [--id slug] [--archetype runner|match3|...]
+//   create [dir] [--name "Name"] [--id slug] [--profile 2d|3d] [--archetype runner|match3|...]
 //          [--premise "one line"] [--look <slug>] [--force]
 //
-// The template comes from ./template/ in the published package (prepack:
-// scripts/pack-template.ts) or ../../templates/game in the engine repository;
-// an archetype (a complete small game to start from) from ./archetypes/<name>/
-// or ../../templates/archetypes/<name>/.
+// The template comes from ./template/ (the 3D template, templates/game) or
+// ./template-2d/ (the 2D starter, templates/game-2d) in the published
+// package (prepack: scripts/pack-template.ts), or from ../../templates/ in
+// the engine repository; an archetype (a complete small game to start from)
+// from ./archetypes/<name>/ or ../../templates/archetypes/<name>/. The 2D
+// starter is written for --profile 2d, or for a premise that says 2D
+// (platformer, side-scroller, metroidvania, pixel art) without saying 3D.
 //
 // Every game gets its look, `assets/looks/<id>.ogt`, named by GameDesc.look
 // in the entry: it extends the style catalogue's preset given by --look, or
@@ -28,9 +31,16 @@ export const SKIPPED = new Set(["cooked", "dist", "node_modules", "og-out", ".og
  * Template files stored under another name and renamed in the scaffold: the
  * template's Git attributes route media through LFS in a game's repository,
  * but as `.gitattributes` they would do the same in the engine repository,
- * which stores the template's media as plain blobs.
+ * which stores the template's media as plain blobs; and `.gitignore`, which
+ * npm drops from every tarball, so the published package carries it as
+ * `gitignore` (scripts/pack-template.ts renames it at pack; the engine
+ * repository keeps the dotted name, and a copy taken from there scaffolds
+ * the same).
  */
-export const RENAMED: ReadonlyMap<string, string> = new Map([["gitattributes", ".gitattributes"]]);
+export const RENAMED: ReadonlyMap<string, string> = new Map([
+  ["gitattributes", ".gitattributes"],
+  ["gitignore", ".gitignore"],
+]);
 
 export interface CreateOptions {
   readonly dir: string;
@@ -39,6 +49,8 @@ export interface CreateOptions {
   readonly force?: boolean;
   /** Start from an archetype (`runner`, `match3`, `topdown`, `tower-defense`, `roguelike`, `idle`, `rhythm`, `third-person`: templates/archetypes/README.md) instead of the project template. */
   readonly archetype?: string;
+  /** The template's profile: `2d` writes the 2D starter (templates/game-2d), `3d` the 3D template (templates/game). Unset, a premise that says 2D picks `2d`; else `3d`. Not for an archetype, which has its own. */
+  readonly profile?: Profile;
   /** The template directory; found next to this file when omitted. */
   readonly template?: string;
   /** A style catalogue slug the game's look extends (og-taste §12). */
@@ -61,11 +73,22 @@ export interface CreatedLook {
   readonly chosen: "flag" | "premise" | "template" | "none";
 }
 
+/** A project's profile (`project.ogt`'s `profile` line): 2D or 3D. */
+export type Profile = "2d" | "3d";
+
+/** The profile the game was written in, and how it was chosen. */
+export interface CreatedProfile {
+  readonly value: Profile;
+  /** `flag` for --profile, `premise` for a premise that says 2D, `archetype` for an archetype's own, `template` for the 3D template by default. */
+  readonly chosen: "flag" | "premise" | "archetype" | "template";
+}
+
 export interface Created {
   readonly dir: string;
   readonly name: string;
   readonly id: string;
   readonly files: readonly string[];
+  readonly profile: CreatedProfile;
   readonly look: CreatedLook;
   /** What the game's author should know, such as reference frames a look will move. */
   readonly notes: readonly string[];
@@ -157,8 +180,30 @@ function title(id: string): string {
     .join(" ");
 }
 
-/** The template this copy of the package scaffolds. */
-export function templateDir(archetype?: string): string {
+/** Words of a premise that say the game is 2D (platformer, side-scroller, metroidvania, pixel art, sprites, tiles). */
+const TWO_D = new Set(["platformer", "platforming", "side-scroller", "side-scrolling", "sidescroller", "sidescrolling", "scroller", "metroidvania", "pixel", "pixel-art", "pixelart", "sprite", "tilemap", "tile", "8bit", "16bit", "1bit"]);
+const THREE_D = new Set(["third-person", "first-person", "fps", "voxel", "lowpoly", "low-poly"]);
+
+/**
+ * The profile a premise asks for: `2d` when it uses a 2D word (TWO_D, or
+ * `2D` itself) and no 3D word (THREE_D, or `3D`), else null: the template's
+ * own, 3D, applies.
+ */
+export function premiseProfile(premise: string): Profile | null {
+  const asked = new Set(words(premise));
+  const says = (w: string) => new RegExp(`(^|[^a-z0-9])${w}($|[^a-z0-9])`, "i").test(premise);
+  if (says("3d") || [...THREE_D].some((w) => asked.has(w))) return null;
+  return says("2d") || [...TWO_D].some((w) => asked.has(w)) ? "2d" : null;
+}
+
+/** The `profile "2d"` line of a project manifest; `3d` when it has none. */
+function profileOf(dir: string): Profile {
+  const m = /^profile[ \t]+"(2d|3d)"/m.exec(readFileSync(join(dir, "project.ogt"), "utf8"));
+  return m?.[1] === "2d" ? "2d" : "3d";
+}
+
+/** The template this copy of the package scaffolds: the archetype's, or the project template of a profile (3D unless `2d`). */
+export function templateDir(archetype?: string, profile: Profile = "3d"): string {
   const here = dirname(fileURLToPath(import.meta.url));
   if (archetype !== undefined) {
     const roots = [join(here, "..", "archetypes"), join(here, "..", "..", "..", "templates", "archetypes")];
@@ -168,10 +213,12 @@ export function templateDir(archetype?: string): string {
     const known = roots.filter(existsSync).flatMap((r) => readdirSync(r).filter((d) => existsSync(join(r, d, "project.ogt"))));
     throw new Error(`no archetype '${archetype}': choose one of ${[...new Set(known)].sort().join(", ") || "(none shipped)"}`);
   }
-  for (const candidate of [join(here, "..", "template"), join(here, "..", "..", "..", "templates", "game")]) {
+  const packed = profile === "2d" ? "template-2d" : "template";
+  const source = profile === "2d" ? "game-2d" : "game";
+  for (const candidate of [join(here, "..", packed), join(here, "..", "..", "..", "templates", source)]) {
     if (existsSync(join(candidate, "project.ogt"))) return candidate;
   }
-  throw new Error(`no project template next to ${here}: expected ../template (published package) or ../../../templates/game (engine repository)`);
+  throw new Error(`no ${profile} project template next to ${here}: expected ../${packed} (published package) or ../../../templates/${source} (engine repository)`);
 }
 
 function ogtString(value: string): string {
@@ -315,8 +362,16 @@ export function create(options: CreateOptions): Created {
       throw new Error(`${dir} is not empty; pick an empty directory, or pass --force to write the template over it`);
     }
   }
+  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 template = options.template ?? templateDir(options.archetype);
+  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 list = files(template);
   const written: string[] = [];
   mkdirSync(dir, { recursive: true });
@@ -335,7 +390,7 @@ export function create(options: CreateOptions): Created {
     writeFileSync(pkgPath, JSON.stringify(pkg, null, 2) + "\n");
   }
   const { look, notes } = writeLook(dir, name, id, choice, written);
-  return { dir, name, id, files: written, look, notes };
+  return { dir, name, id, files: written, profile, look, notes };
 }
 
 /**
@@ -420,12 +475,13 @@ function writeLook(dir: string, name: string, id: string, choice: ReturnType<typ
   return { look, notes };
 }
 
-const USAGE = `usage: create [dir] [--name "Name"] [--id slug] [--archetype name] [--premise "one line"] [--look slug] [--force]
+const USAGE = `usage: create [dir] [--name "Name"] [--id slug] [--profile 2d|3d] [--archetype name] [--premise "one line"] [--look slug] [--force]
 
 Scaffolds an Origin Engine game into dir (default: ./origin-game).
   --name   the game's display name (default: from the id or the directory)
   --id     the game's id, lowercase-hyphen (default: from the name)
-  --archetype  start from a complete archetype game (runner, match3, topdown, tower-defense, roguelike, idle, rhythm, third-person) instead of the template
+  --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) 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
   --no-prompt  never ask for the premise
@@ -437,6 +493,7 @@ function main(argv: string[]): number {
   let id: string | undefined;
   let force = false;
   let archetype: string | undefined;
+  let profile: Profile | undefined;
   let premise: string | undefined;
   let look: string | undefined;
   let ask = true;
@@ -451,7 +508,11 @@ function main(argv: string[]): number {
     else if (a === "--id") id = value();
     else if (a === "--force") force = true;
     else if (a === "--archetype") archetype = value();
-    else if (a === "--premise") premise = value();
+    else if (a === "--profile") {
+      const v = value();
+      if (v !== "2d" && v !== "3d") throw new Error(`--profile ${v}: use 2d or 3d. ${USAGE}`);
+      profile = v;
+    } else if (a === "--premise") premise = value();
     else if (a === "--look") look = value();
     else if (a === "--no-prompt") ask = false;
     else if (a === "-h" || a === "--help") {
@@ -469,13 +530,16 @@ function main(argv: string[]): number {
     ...(name ? { name } : {}),
     ...(id ? { id } : {}),
     ...(archetype ? { archetype } : {}),
+    ...(profile ? { profile } : {}),
     ...(premise ? { premise } : {}),
     ...(look ? { look } : {}),
     force,
   });
   const shown = relative(process.cwd(), made.dir) || ".";
   const style = made.look.extends ? `extends ${made.look.extends}${made.look.chosen === "premise" ? " (from the premise)" : made.look.chosen === "flag" ? " (--look)" : ""}` : "extends no preset";
+  const how = { flag: " (--profile)", premise: " (from the premise)", archetype: ` (the ${archetype} archetype's)`, template: "" }[made.profile.chosen];
   console.log(`Created ${made.name} (${made.id}) in ${shown}: ${made.files.length} files.
+Profile: ${made.profile.value}${how}.
 Look: ${made.look.file}, ${style}; README.md says how to change it.${made.notes.map((n) => `\nNote: ${n}`).join("")}
 
 Next:

package/package.json

@@ -1,16 +1,16 @@
 {
   "name": "@origingame/create-game",
-  "version": "0.1.0",
+  "version": "0.2.0",
   "description": "Scaffolds an Origin Engine game from the project template: npm create @origingame/game.",
   "license": "MIT",
   "repository": {
     "type": "git",
-    "url": "git+https://github.com/fran0220/origin-engine.git",
+    "url": "git+https://github.com/originai-game/origin-engine.git",
     "directory": "packages/create"
   },
-  "homepage": "https://github.com/fran0220/origin-engine#readme",
+  "homepage": "https://github.com/originai-game/origin-engine#readme",
   "bugs": {
-    "url": "https://github.com/fran0220/origin-engine/issues"
+    "url": "https://github.com/originai-game/origin-engine/issues"
   },
   "publishConfig": {
     "access": "public"
@@ -22,6 +22,7 @@
   "files": [
     "bin",
     "template",
+    "template-2d",
     "archetypes",
     "looks",
     "README.md"

package/template/gitignore

@@ -0,0 +1,8 @@
+# og cook output: rebuilt from assets/, never committed.
+cooked/
+# og build output.
+dist/
+# og run and og test output, and og's bundled entry.
+og-out/
+.og/
+node_modules/

package/template/package.json

@@ -13,6 +13,6 @@
     "test": "og test ."
   },
   "dependencies": {
-    "@origingame/engine": "0.1.0"
+    "@origingame/engine": "0.2.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.1.0"
+engine "0.2.0"
 entry "src/main.ts"
 # 2d (orthographic camera, sprites, 2D physics) or 3d.
 profile "3d"

package/template-2d/.origin/setup

@@ -0,0 +1,14 @@
+#!/bin/sh
+# Prepares this Game's cloud sandbox snapshot: Origin runs it once per
+# snapshot build, in the checkout, without a terminal, for at most 20 minutes,
+# and saves the result for new sandboxes of the Game. Keep it idempotent; it
+# never receives credentials. Only ignored output is kept: node_modules/ and
+# cooked/ (og cook is incremental, so a new sandbox starts cooked).
+set -eu
+if [ -f bun.lock ]; then bun install --frozen-lockfile; else bun install; fi
+og="${ORIGIN_OG_BIN:-og}"
+if ! command -v "$og" >/dev/null 2>&1; then
+  echo "no og on this executor class; the first og run cooks instead"
+  exit 0
+fi
+"$og" cook .

package/template-2d/LICENSES.md

@@ -0,0 +1,14 @@
+# Asset licences
+
+Nothing in this project is downloaded: the art and sounds are the engine's
+runner archetype's (`templates/archetypes/runner`, drawn and synthesised by
+its `tools/make-assets.py`), and the rest is written by hand.
+
+| File | Licence | Origin |
+|---|---|---|
+| `assets/sprites/courier.png`, `assets/sprites/coin.png` and their `.ogt` | CC0 1.0 | self-made: the runner archetype's courier and coin |
+| `assets/tiles/city.png` | CC0 1.0 | self-made: the runner archetype's city tileset |
+| `assets/tiles/city.ogt`, `assets/maps/level.ogt` | CC0 1.0 | self-made, written by hand |
+| `assets/audio/jump.wav`, `assets/audio/coin.wav` | CC0 1.0 | self-made: the runner archetype's synthesised tones |
+| `assets/fonts/ui.ttf` | SIL Open Font License 1.1 (`assets/fonts/OFL.txt`) | Noto Sans SC Regular, subset to Latin-1 by the runner archetype from the project template's `assets/fonts/NotoSansSC-Regular-subset.ttf` |
+| `assets/looks/*.ogt`, `assets/strings/*.ogt`, every other `.ogt` | CC0 1.0 | self-made, written by hand |

package/template-2d/README.md

@@ -0,0 +1,39 @@
+# The 2D starter
+
+What `npm create @origingame/game` writes for a 2D game (`--profile 2d`, or
+a premise that says 2D, platformer, side-scroller, metroidvania or pixel
+art): the smallest whole 2D Origin Engine project. A courier runs and jumps
+the rooftops of one level, takes coins, jumps up through one-way ledges and
+lands on them, loses a life in the pit and clears the level at the far
+wall; Escape (or the HUD's Pause) opens the pause menu.
+
+```sh
+og run .     # headless with the probe; og dev . reloads on save
+og test .    # tests/smoke.og.ts
+og build .   # the play page
+```
+
+## What it demonstrates, and the skills it exercises
+
+| Part | Where | Skill |
+|---|---|---|
+| The project in the 2D profile: an orthographic camera, sprites, 2D physics | `project.ogt`, `start` in `src/main.ts` | og-game §2, §8 |
+| A hand-written tilemap over a tileset: a parallax skyline, roofs that collide, ledges on their own collider layer (`colliderLayers 2`) that the controller makes one-way | `assets/maps/level.ogt`, `assets/tiles/city.ogt` | og-game §8 (the grammar) |
+| A flipbook sheet, its clips numbered in file order and checked against the code | `assets/sprites/courier.ogt`, `CLIP`, `checkClips` | og-game §8 |
+| og.PlatformerController: run, jump (held for the full height), coyote time, the jump buffer, one-way ledges, Down to drop | `Control`, the hero in `start` | og-game §13; og-feel §12 |
+| The map's objects: the spawn, the coins, the goal | `start`, `Pickups` | og-game §8 |
+| Input on the press's tick: keys, a pad, the HUD's touch controls on a phone | `Control`, `Hud` | og-feel §1; og-ui §5 |
+| The UI kit's platformer HUD and pause menu, every word from the string table | `Hud`, `assets/strings/en.ogt` | og-ui §1, §6; og-i18n §1 |
+| A camera that follows with a dead zone and look-ahead | og.Follow2D on the hero | og-feel §8 |
+| The frame's art direction as data: a look extending the 16bit-pixel preset | `assets/looks/origin-game-2d.ogt` (a created game's is `<id>.ogt`) | og-taste §1, §12 |
+| A playtest that asserts on dumps, never on the code | `tests/smoke.og.ts` | og-build §3, §4 |
+
+What a game made from it changes first: the art (the courier and the city
+are the runner archetype's, `templates/archetypes/runner/tools/make-assets.py`
+draws them), the level (`assets/maps/level.ogt`, or a Tiled `.tmj` beside
+it, og-game §8), the controller's tunables (og-feel §12) and what the map's
+objects mean. The 2D archetypes (`templates/archetypes/`) are whole games
+to start from instead: a runner, a top-down room, match-3, a roguelike,
+tower defence, an idle game and a rhythm game.
+
+Asset licences: `LICENSES.md`.