Files
feuerwerk/README.md
T
adminandClaude Opus 5.5 c4a9280140 Preview inspector edits once per frame, not per input (#274)
Scrubbing a number in the inspector and dragging a colour stop of a
gradient told the editor about every input. Pixi repeats each pointer
move shortly after, so both gestures paid for two previews per move.
The issue asked to measure first and to build only from 10 % per
move. The measurement showed about 50 %.

- previewingHandlers still writes the model on every input but
  requests the preview through a FramePreview of its own. The commit
  cancels a waiting preview first.
- The preview handler of the GradientBar in shapeSection.ts does the
  same.
- Wider than the issue describes: the row handlers also serve typing,
  the arrow keys and the colour picker. All of them preview once per
  frame now.

Measured on stein2, fixture project with 120 extra objects, 120 moves
8 ms apart, three runs each:
- Scrub: 236 project events before, 51 to 61 after. 45 to 50 ms per
  move before, 22 to 27 after.
- Colour stop: 238 project events before, 50 to 51 after. 44 to 49 ms
  per move before, 22 after.
- One preview still costs 13 to 17 ms. That price per frame is what
  remains.

Finding, not fixed here: in the pixel art tab the palette colour and
the opacity of a layer still preview on every input
(PixelArtSide.ts), and so do the head fields of the curve tab.
Neither was measured.

Tests:
- Gate: 198 files, 2907 tests (2903 + 4), exit 0
- e2e, full run: 1616 checks passed (1615 + 1), exit 0
- Smokes: 24 / 19 / 21, exit 0
- Four new unit tests in tests/editor/frame-preview.test.ts, two for
  a row and two for a colour stop
- One new e2e check in module 02: a held scrub gave 10 project events
  in 12 frames, and the value is there before the release
- Four unit counter-probes fail, 1 to 2 tests each. They ran on
  stein2, not in the container.
- The browser counter-probe fails the new check with 50 events in 16
  frames

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
2026-10-01 11:25:37 +02:00

6.8 KiB
Raw Blame History

Game Maker

A browser-based tool "one step before a game engine": create assets (scenes, cameras, sprites), place them into scenes, tweak their properties in an inspector and press Play – all in one program, all drawn inside a single WebGL canvas.

Live: https://nockal.com/game-maker/ · Widget playground: https://nockal.com/game-maker/?playground

The documentation is the wiki: https://git.nockal.com/meleki/game-maker/wiki – every concept, node, tab and shortcut, plus the architecture and the development workflow. This file is the short way in.

In one screen

  • An asset is a named, typed thing (scene, camera, sprite, text, behavior, variables, struct, collider, rigidbody, container, clip area, texture, vector art, pixel art, palette, animation, curve, tile, tilemap, state machine, shader, font, sound, particles) with properties and no position.
  • A scene object places an asset: position, sparse overrides of its properties, an optional parent. Only what differs from the asset is stored; the inspector paints it gold and offers ↺ / ↑.
  • A container is a reusable group edited once and placed many times; its content is resolved from the template on every read. A screen is a container switched on and off.
  • A behavior is logic as a node graph, placed like anything else and parented to the object it acts on. Play has no built-in behaviour – everything that happens is a graph.
  • An account owns projects: the editor asks for a user name and a password first, and each account sees only its own projects. The Account menu at the far right of the toolbar changes the password and signs out.
  • Play runs a throwaway copy of the project; every panel stays usable and Stop brings back exactly what was saved. Release… shares a link that plays the saved game on its own, without the editor and without signing in.

Quick start

Node 22 is required.

npm install
npm run dev          # http://localhost:5175/game-maker/dist/ – API calls are proxied to production
npm run check        # typecheck + lint + format:check + unit tests – the gate CI runs too
npm run build        # writes dist/ and regenerates index.html; the folder is what nginx serves

The browser suite and the three example games need a machine with a GPU:

node tools/seed-e2e.mjs && node tools/e2e.mjs      # the editor, 1616 checks (GM_STEPS=20 for one step)
                                                   #   every tool signs in first – see the Accounts page
node tools/seed-jumprun.mjs && node tools/smoke-jumprun.mjs
node tools/seed-tetris.mjs && node tools/smoke-tetris.mjs
node tools/seed-actor.mjs && node tools/smoke-actor.mjs

Every push runs all of it on the Gitea runner – the gate as one job, build and suite as another beside it – so locally take the gate plus the step your change touches and leave the full run to CI. Details, the GPU requirement and the detached runner are in Development.

Documentation

Page What it covers
Concepts Assets, scene objects, overrides, play mode, the camera, the console
Accounts Signing in and out, the accounts, who a project belongs to, what the check tools need
Scenes The edited scene, the start scene, and switching scenes from a graph
Scene editing Placing, z-order, hierarchy, the editor offset
Behaviors Node graphs: variables, the node set, structs and lists, loops, nesting, editing
Structs Struct assets: a named shape that struct variables, fields and Pack/Expand follow
Colliders Shapes (box, circle, capsule, polygon), collision events, blocking movement, one-way colliders and raycasts
Physics Rigidbodies, the collider material, gravity, the fixed step
Textures Images, frames, nine-slice, the filter, upload limits
Vector art Pictures drawn from shapes: the pen, curves, gradients and texture fills, combining shapes
Pixel art Pictures painted pixel by pixel: the palette, the tools, layers and frames
Fonts Font assets, the picker, what a text falls back to
Sounds Sound assets and Play sound
Animations Animation assets and the Animation tab
Curves Easings drawn by hand, the Curve tab, using one on a key or a Lerp
Shaders Shader graphs a sprite wears, their node set, the properties they declare
Particles Particle graphs: a particle as a function of its age
State machines The asset, named transitions, State branch, Set state and State transition
Containers Templates, instances, screens
Tiles The tile asset, plain tiles and the two autotile kinds, the pictures as animation steps, the Tile tab
Tilemaps The tilemap asset, painting in the scene view, layers, what it looks like in the game
Plugins Extending the editor: the plugin file, how it is loaded, switching one on and off, API v1
Keyboard Every shortcut
Architecture Stack, source layout, the rules that keep it organised
Development Commands, the e2e suite, the example games, CI
API The PHP JSON API and the project document

Ideas, gaps and bugs

They live in the issue tracker: https://git.nockal.com/meleki/game-maker/issues. What is not there yet is listed on the wiki's Home page.