Files
feuerwerk/README.md
T
adminandClaude Opus 5.5 3f12a77aea Preview a sprite at the end of its inspector, placed or as an asset
A sprite's inspector listed its rows but never showed what they add up
to. The picture, its frame, nine-slice, tint and shader could only be
judged in the scene, often far from the object being edited.

- SpritePreview draws the sprite through syncSpriteMesh, the function
  the scene draws it with. Slices, padding, tint and shader come out
  the same without a second path. syncSpriteMesh now takes only the
  three fields of a DrawItem it reads.
- The subject is resolved by previewPicture from the Shader tab, so a
  placed sprite shows its own overrides.
- previewFit is the rule for size and place: whole device pixels per
  unit from 1 on, at most 8, and the corner on a whole device pixel.
  Pixel art stays sharp. A sprite larger than the group shrinks freely.
- A shader with a Time node keeps the preview redrawing once a frame
  while it is on screen. A folded group or a hidden panel stops it.
- New test hook __gm.inspectorSpritePreview().

Finding: the preview redrew on a model change in a microtask at first.
A drawn picture whose revision moved on is retried once, in a
microtask queued by the scene's synchronous redraw. That retry ran
before the preview had let go, and the old pixel art sheet stayed
waiting (e2e 48l-iii read waiting [1,1,1]). The preview now redraws
at once on a model change, as the scene does.

Tests:
- unit: 238 files, 3592 tests (+5 in preview-fit.test.ts), and the
  group list of a placed sprite in sections.test.ts ends in PREVIEW
- e2e 48: ALL PASSED, 47 checks (+2: 48l-i asset preview with
  the frame, 48l-iii placed preview with its shader values)
- counter-checks: without whole-pixel zoom 2 unit tests fail; with
  the microtask redraw 48l-iii fails with waiting [1,1,1]

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
2026-10-04 14:27:35 +02:00

7.0 KiB
Raw Blame History

Game Maker

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, joint, container, clip area, texture, vector art, pixel art, palette, animation, curve, tile, tilemap, state machine, shader, shader function, 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, 1744 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 runners – 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, joints
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 that sprites, texts, particle fields and cameras wear, their node set, passes, shader functions
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.