thrunium 1.2.0-rc.2 → 1.2.0-rc.4

package/README.md

@@ -34,7 +34,7 @@ with a `/*! THRUNIUM v<version> | (c) Infobits ApS | MIT License */` banner and
 The engine is also on npm as `thrunium` (Node 24 or newer):
 
 ```bash
-npx thrunium init my-game   # new TypeScript project; add --js for JavaScript
+npx thrunium init my-game   # new TypeScript project in src/game.ts; add --js for JavaScript
 cd my-game && npm run dev   # init installs for you; use pnpm dev, yarn dev or bun run dev
 ```
 
@@ -57,14 +57,25 @@ Commands (`thrunium --help`, `--version`):
 |---|---|
 | `thrunium dev` | `--port <n>` (default 3000, tries the next 10 ports if busy), `--host <name>` (default `localhost`), `--no-open` |
 | `thrunium build` | `--out <dir>` (default `dist`), `--engine cdn\|bundle` |
-| `thrunium init [dir]` | `--js` (TypeScript by default), `--pm npm\|pnpm\|yarn\|bun` (default: the one that ran it, else npm), `--no-install`; the folder must be empty. Installs by default; if that fails the project is kept and the command is printed |
+| `thrunium init [dir]` | `--js` (TypeScript by default), `--no-src` (game file in the root instead of `src/`), `--pm npm\|pnpm\|yarn\|bun` (default: the one that ran it, else npm), `--no-install`; the folder must be empty. Installs by default; if that fails the project is kept and the command is printed |
 
 A project needs no `index.html`: without one, `dev` and `build` generate the page
 from `game.json` (`entry`, else the first of `game.ts`, `game.js`, `src/game.ts`,
 `src/game.js`; the title is `name`, else the folder name). A hand-written
 `index.html` is used as written, and having both it and `entry` is an error.
 `import './style.css'` from game code is bundled and linked, with `url()` fonts and
-images; remote `@import` stays remote.
+images; remote `@import` stays remote. A generated page takes a title, description,
+favicon, link-preview image, address and language from `page` in `game.json`, and
+the contents of an optional `head.html` and `body.html` (see the "Dev server and
+builds" guide). None of these mix with a hand-written `index.html`.
+
+Games get keys and mouse state (`game.keys`, `game.mouse`), asset getters
+(`game.image`, `game.sound`, `game.sprite`), declared fonts (`game.fonts`),
+scenes with `game.paused`, timers (`game.after`, `game.every`), buttons
+(`game.button`) and a debug menu (`game.debug`). `thrunium build` downloads
+Google Fonts into the build, so players make no request to Google. See the
+"Making games easier" guide. The debug menu is on under `thrunium dev` and off
+in builds.
 
 `dev` never uses the CDN. For a project with a module entry
 (a generated page, or `<script type="module" src=...>` importing `thrunium`), `build` has two engine