@origingame/create-game 0.0.0-stage → 0.1.0

package/package.json

@@ -1,6 +1,33 @@
 {
   "name": "@origingame/create-game",
-  "version": "0.0.0-stage",
-  "stub": true,
-  "description": "Temporary package placeholder for staged publishing"
-}
+  "version": "0.1.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",
+    "directory": "packages/create"
+  },
+  "homepage": "https://github.com/fran0220/origin-engine#readme",
+  "bugs": {
+    "url": "https://github.com/fran0220/origin-engine/issues"
+  },
+  "publishConfig": {
+    "access": "public"
+  },
+  "type": "module",
+  "bin": {
+    "create-game": "bin/create.ts"
+  },
+  "files": [
+    "bin",
+    "template",
+    "archetypes",
+    "looks",
+    "README.md"
+  ],
+  "scripts": {
+    "prepack": "bun scripts/pack-template.ts",
+    "test": "bun test ${OG_BUN_TEST_TIMEOUT:+--timeout=$OG_BUN_TEST_TIMEOUT} tests/"
+  }
+}

package/template/.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/LICENSES.md

@@ -0,0 +1,23 @@
+# Template asset licences
+
+Every binary the template ships, with its licence; `@origingame/create-game`
+carries this file into each scaffolded project.
+
+| File | Licence | Origin |
+|---|---|---|
+| `assets/models/dropship.glb` | MIT (copyright 2026 Leichtbier) | the `core-business` example of OriginGame's `origingame-examples` repository (`examples/core-business/assets/dropship.glb`, generated by its `dropship.py`); its `LICENSE` is MIT. Also a test model of the engine (`crates/og-tests/assets/`) |
+| `assets/models/walker.glb` | CC0 1.0 | self-made by the Origin Engine authors: a 13-node skinned walker of boxes with two morph targets and six clips (LINEAR, STEP, CUBICSPLINE, weights; footstep markers in `extras."og.events"`), generated by `crates/og-anim/tools/make_rig.py` (deterministic). The scene's `trickster` and the guard are both instances of it |
+| `assets/textures/stone.png`, `assets/textures/stone_n.png` | CC0 1.0 | self-made by the Origin Engine authors: procedural value-noise tiles and the normal map of the same height field, generated by `templates/tools/make-template-assets.py` |
+| `assets/audio/blip.wav` | CC0 1.0 | self-made: a 0.5 s rising sine pickup sound, same script |
+| `assets/audio/click.ogt` | CC0 1.0 | og-cook's `click` sound preset (`og sfx click`), synthesised at cook time |
+| `assets/fonts/NotoSansSC-Regular-subset.ttf` | SIL Open Font License 1.1 (`assets/fonts/OFL.txt`) | the OriginGame platform's project-template font: Noto Sans SC Regular subset to Latin, punctuation, kana, full-width forms and GB2312 by the platform's `engine/scripts/subset-font.py` |
+
+## Provenance note
+
+Until 2026-10-22 the `trickster` entity was `trickster.glb`, a model copied
+from the `edg-king-match` example of `origingame-examples`, which declares
+no licence (that repository grants none for the collection); the public
+template ships nothing whose licence is not named (docs/release.md §4 R6),
+so the entity is the walker now. The engine's own test copy stays in
+`crates/og-tests/assets/` and in `templates/fx-showcase`, which no package
+ships.

package/template/README.md

@@ -0,0 +1,37 @@
+# The game template
+
+What `npm create @origingame/game` writes: the smallest whole Origin Engine
+project, and the hello of the engine's design grown into a scene. A menu's
+Start button (or S, or Enter) spins the trickster and drops a crate onto
+the ground; a guard patrols the yard, sees only inside its cone and not
+through the wall, raises the alarm, chases, searches and goes back.
+
+```sh
+og run .     # headless with the probe; og dev . reloads on save
+og test .    # tests/smoke.og.ts and tests/guard.og.ts
+og polish .  # the taste and feel scores of those playtests
+og build .   # the play page
+```
+
+## What it demonstrates, and the skills it exercises
+
+| Part | Where | Skill |
+|---|---|---|
+| The project: `project.ogt`, the entry's `og.game` default export, `cooked/` from `assets/` | `project.ogt`, `src/main.ts` | og-game §2, §5 |
+| Components, a resource, systems over archetype columns, one job each | `Health`, `Velocity`, `Spin`, `Run`; `Move`, `StartSpin`, `Drop`, `Rotate` | og-core §4, §5; og-game §3 |
+| The frame's art direction as data: a look extending a catalogue preset, applied by `GameDesc.look` | `assets/looks/origin-game.ogt` (a created game's is `<id>.ogt`), `og.game({ look })` | og-taste §1, §12 |
+| A text scene spawned before the first tick, a glTF model, a font, a box with a collider that falls | `assets/scenes/main.ogt`, `start` | og-game §4, §6, §13 |
+| A menu panel whose button answers with a look and a sound (og sfx's click preset) | `Menu`, `assets/audio/click.ogt` | og-ui §1, §3; og-taste §6; og-audio §2, §3 |
+| Every word the menu shows from a string table, the base one in the source language | `assets/strings/en.ogt`, `Menu` | og-i18n §1, §2 |
+| A guard as data: a state machine on og.ai, a navmesh cooked from the yard, sight cones against the wall | `assets/ai/guard.ogt`, `assets/nav/yard.ogt` | og-ai §1–§5 |
+| Commands with their usage in `help`, facts for playtests | `commands`, `commandHelp`, `facts` | og-game §3; og-build §1 |
+| Playtests that assert on dumps and facts, never on the code | `tests/` | og-build §3, §4 |
+
+`og polish .` (2026-10-19): taste 100, feel 87 (tests/evidence/E7/polish/
+in the engine repository). The feel row below 90 is idle frames: the guard
+playtest stages its scenario without pressing Start, so for half its ticks
+only the guard stands still at a corner of its search, and the smoke
+playtest waits half a second on the title before its press. A game made
+from the template should keep a playtest that plays it.
+
+Asset licences: `LICENSES.md`.

package/template/assets/ai/guard.ogt

@@ -0,0 +1,48 @@
+type behaviour
+version 1
+---
+# The guard's state machine (og.ai; every node is in the og-ai skill). It
+# patrols its post until it sees the trickster in its view cone, raises the
+# alarm (the game's `alarm` command) and chases; when it loses sight it
+# searches where it last saw it for 3 seconds, then goes back to its post.
+name "guard"
+route post {
+  point -6 0 -3
+  point -6 0 4
+  point -1 0 6
+}
+machine {
+  initial patrol
+  state patrol {
+    patrol post {
+      wait 1
+      speed 1.5
+    }
+    to alert {
+      check sees
+    }
+  }
+  state alert {
+    enter {
+      command alarm
+    }
+    chase {
+      speed 3
+      reach 1.5
+    }
+    to search {
+      check sees is false
+    }
+  }
+  state search {
+    move_to lastSeen {
+      speed 2
+    }
+    to alert {
+      check sees
+    }
+    to patrol {
+      after 3
+    }
+  }
+}

package/template/assets/audio/click.ogt

@@ -0,0 +1,9 @@
+type sfx
+version 1
+---
+# a tiny UI tick: og.load.sound(world, "<this file>") plays it.
+preset "click"
+seed 0
+pitch 1
+length 1
+volume 1

package/template/assets/fonts/NotoSansSC-Regular-subset.ttf.ogt

@@ -0,0 +1,12 @@
+type import
+version 1
+---
+# The atlas covers Latin-1, CJK punctuation and the strings the template shows.
+# `charset all` cooks every glyph of the platform subset (GB2312 + kana): see
+# crates/og-cook/README.md for its size and time.
+font {
+  charset latin cjk-punct
+  chars "开始游戏设置退出暂停继续分数最高关卡生命时间胜利失败加载中"
+  em_px 32
+  px_range 4
+}

package/template/assets/fonts/OFL.txt

@@ -0,0 +1,93 @@
+Copyright 2014-2021 Adobe (http://www.adobe.com/), with Reserved Font Name 'Source'
+
+This Font Software is licensed under the SIL Open Font License, Version 1.1.
+This license is copied below, and is also available with a FAQ at:
+https://scripts.sil.org/OFL
+
+
+-----------------------------------------------------------
+SIL OPEN FONT LICENSE Version 1.1 - 26 February 2007
+-----------------------------------------------------------
+
+PREAMBLE
+The goals of the Open Font License (OFL) are to stimulate worldwide
+development of collaborative font projects, to support the font creation
+efforts of academic and linguistic communities, and to provide a free and
+open framework in which fonts may be shared and improved in partnership
+with others.
+
+The OFL allows the licensed fonts to be used, studied, modified and
+redistributed freely as long as they are not sold by themselves. The
+fonts, including any derivative works, can be bundled, embedded, 
+redistributed and/or sold with any software provided that any reserved
+names are not used by derivative works. The fonts and derivatives,
+however, cannot be released under any other type of license. The
+requirement for fonts to remain under this license does not apply
+to any document created using the fonts or their derivatives.
+
+DEFINITIONS
+"Font Software" refers to the set of files released by the Copyright
+Holder(s) under this license and clearly marked as such. This may
+include source files, build scripts and documentation.
+
+"Reserved Font Name" refers to any names specified as such after the
+copyright statement(s).
+
+"Original Version" refers to the collection of Font Software components as
+distributed by the Copyright Holder(s).
+
+"Modified Version" refers to any derivative made by adding to, deleting,
+or substituting -- in part or in whole -- any of the components of the
+Original Version, by changing formats or by porting the Font Software to a
+new environment.
+
+"Author" refers to any designer, engineer, programmer, technical
+writer or other person who contributed to the Font Software.
+
+PERMISSION & CONDITIONS
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of the Font Software, to use, study, copy, merge, embed, modify,
+redistribute, and sell modified and unmodified copies of the Font
+Software, subject to the following conditions:
+
+1) Neither the Font Software nor any of its individual components,
+in Original or Modified Versions, may be sold by itself.
+
+2) Original or Modified Versions of the Font Software may be bundled,
+redistributed and/or sold with any software, provided that each copy
+contains the above copyright notice and this license. These can be
+included either as stand-alone text files, human-readable headers or
+in the appropriate machine-readable metadata fields within text or
+binary files as long as those fields can be easily viewed by the user.
+
+3) No Modified Version of the Font Software may use the Reserved Font
+Name(s) unless explicit written permission is granted by the corresponding
+Copyright Holder. This restriction only applies to the primary font name as
+presented to the users.
+
+4) The name(s) of the Copyright Holder(s) or the Author(s) of the Font
+Software shall not be used to promote, endorse or advertise any
+Modified Version, except to acknowledge the contribution(s) of the
+Copyright Holder(s) and the Author(s) or with their explicit written
+permission.
+
+5) The Font Software, modified or unmodified, in part or in whole,
+must be distributed entirely under this license, and must not be
+distributed under any other license. The requirement for fonts to
+remain under this license does not apply to any document created
+using the Font Software.
+
+TERMINATION
+This license becomes null and void if any of the above conditions are
+not met.
+
+DISCLAIMER
+THE FONT SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO ANY WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT
+OF COPYRIGHT, PATENT, TRADEMARK, OR OTHER RIGHT. IN NO EVENT SHALL THE
+COPYRIGHT HOLDER BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
+INCLUDING ANY GENERAL, SPECIAL, INDIRECT, INCIDENTAL, OR CONSEQUENTIAL
+DAMAGES, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
+FROM, OUT OF THE USE OR INABILITY TO USE THE FONT SOFTWARE OR FROM
+OTHER DEALINGS IN THE FONT SOFTWARE.

package/template/assets/looks/origin-game.ogt

@@ -0,0 +1,12 @@
+type look
+version 1
+---
+# The game's look (og-taste §12): the frame's art direction as data, named
+# by GameDesc.look in src/main.ts and applied before start runs. It starts
+# from the catalogue's faceted-low-poly preset (flat facets on every lit
+# material, a soft vignette, AgX tone mapping); a block written below wins
+# over the preset field by field, and `extends` takes any catalogue slug
+# (packages/knowledge/looks/catalogue.json). `npm create @origingame/game`
+# writes the game's own look from its premise, or from --look <slug>.
+name "Origin Game"
+extends "faceted-low-poly"

package/template/assets/nav/yard.ogt

@@ -0,0 +1,27 @@
+type navmesh
+version 1
+---
+# The yard's navmesh, baked by `og cook` (og.nav.load("nav/yard.ogt")): the
+# ground and the wall `start` builds in src/main.ts, voxelised for an agent
+# 0.4 m wide and 1.8 m tall. A `scene` or `model` entry bakes glTF geometry
+# instead of boxes.
+agent {
+  radius 0.4
+  height 1.8
+  climb 0.4
+  slope 45
+}
+cellSize 0.25
+tileSize 32
+bounds {
+  min -12 -1 -12
+  max 12 3 12
+}
+box {
+  center 0 -0.1 0
+  size 30 0.2 30
+}
+box {
+  center -3 1 -2
+  size 0.6 2 6
+}

package/template/assets/scenes/main.ogt

@@ -0,0 +1,34 @@
+type scene
+version 1
+---
+name "Main"
+entity "ground" {
+  Transform {
+    position 0 0 0
+    quaternion 0 0 0 1
+    scale 1 1 1
+  }
+}
+entity "dropship" {
+  model "models/dropship.glb"
+  Transform {
+    position 0 1.5 0
+    quaternion 0 0 0 1
+    scale 1 1 1
+  }
+}
+entity "trickster" {
+  model "models/walker.glb"
+  Transform {
+    position 2 0 0
+    quaternion 0 0.7071068 0 0.7071068
+    scale 1 1 1
+  }
+  entity "marker" {
+    Transform {
+      position 0 2.2 0
+      quaternion 0 0 0 1
+      scale 0.25 0.25 0.25
+    }
+  }
+}

package/template/assets/strings/en.ogt

@@ -0,0 +1,14 @@
+type strings
+version 1
+---
+# The template's strings (og.i18n, og-i18n §1): every word the menu shows
+# is a key here, never a literal in a system. This is the base table, in
+# the game's source language; a locale is its own file beside it
+# (`zh-CN.ogt`, with the same keys and its `fonts` line), loaded in `start`.
+locale "en"
+base true
+string "menu.title" "Origin Engine"
+string "menu.prompt" "Press Start to begin"
+string "menu.spinning" "Spinning  {speed} rad/s"
+string "menu.start" "Start"
+string "menu.started" "Started"

package/template/assets/textures/stone_n.png.ogt

@@ -0,0 +1,7 @@
+type import
+version 1
+---
+# A tangent-space normal map: UASTC, linear (colour textures default to ETC1S, sRGB).
+texture {
+  kind normal
+}

package/template/gitattributes

@@ -0,0 +1,22 @@
+# Media to Git LFS, as the platform's other scaffolds route them; text stays
+# diffable (.ogt scenes and settings are line-based text by design).
+*.glb filter=lfs diff=lfs merge=lfs -text
+*.gltf filter=lfs diff=lfs merge=lfs -text
+*.bin filter=lfs diff=lfs merge=lfs -text
+*.png filter=lfs diff=lfs merge=lfs -text
+*.jpg filter=lfs diff=lfs merge=lfs -text
+*.jpeg filter=lfs diff=lfs merge=lfs -text
+*.webp filter=lfs diff=lfs merge=lfs -text
+*.ktx2 filter=lfs diff=lfs merge=lfs -text
+*.hdr filter=lfs diff=lfs merge=lfs -text
+*.exr filter=lfs diff=lfs merge=lfs -text
+*.wav filter=lfs diff=lfs merge=lfs -text
+*.mp3 filter=lfs diff=lfs merge=lfs -text
+*.ogg filter=lfs diff=lfs merge=lfs -text
+*.flac filter=lfs diff=lfs merge=lfs -text
+*.mp4 filter=lfs diff=lfs merge=lfs -text
+*.ttf filter=lfs diff=lfs merge=lfs -text
+*.otf filter=lfs diff=lfs merge=lfs -text
+*.woff2 filter=lfs diff=lfs merge=lfs -text
+*.ogt text eol=lf
+*.ts text eol=lf

package/template/package.json

@@ -0,0 +1,18 @@
+{
+  "name": "origin-game",
+  "version": "0.1.0",
+  "private": true,
+  "type": "module",
+  "scripts": {
+    "dev": "og dev .",
+    "start": "og run .",
+    "build": "og build .",
+    "publish-build": "og build . --publish",
+    "cook": "og cook .",
+    "check": "og check .",
+    "test": "og test ."
+  },
+  "dependencies": {
+    "@origingame/engine": "0.1.0"
+  }
+}

package/template/project.ogt

@@ -0,0 +1,25 @@
+type project
+version 1
+---
+# The project manifest (docs/design.md §2.5): `og run`, `og build`, `og cook`,
+# `og dev` and `og test` read it. `npm create @origingame/game` fills in the
+# name and id.
+name "Origin Game"
+id "origin-game"
+# The engine this game is written against (design §9: upgrades are explicit).
+engine "0.1.0"
+entry "src/main.ts"
+# 2d (orthographic camera, sprites, 2D physics) or 3d.
+profile "3d"
+tick 60
+seed 1
+scenes {
+  main "scenes/main.ogt"
+}
+scene main
+publish {
+  # `og build --publish` keeps only the player-facing probe members
+  # (hello, tick, state, pick, entity, input, capture).
+  probe player
+  out "dist"
+}