adminandClaude Opus 5.5
043c224cc3
The editor gets a name of its own that fits beside Brandmauer, Glutspeicher and Feuerwehr. This is stage 1, 2 and 4 of #422: the name, the URL and the stored state in the browser. Repository, CI runners, containers and the GAME_MAKER_* variables follow in stage 3. - All paths come from SITE_PATH in src/core/site.ts: the API endpoint, the data folders, the play page and the base in vite.config.ts. A later move is one line instead of fifteen. - The window title, the sign-in screen, the playground and the README say Feuerwerk. The package, __feuerwerkPlay, the take worklet and the writing app in Ogg and Matroska follow. - The session cookie is now feuerwerk_session, so everyone signs in once more. - localStorage keys are now feuerwerk.*. moveOldStoredKeys copies the old game-maker.* keys over on the first start, so settings, panel sizes and save games survive. - tools/ci/serve.sh serves the build under /feuerwerk/. The variable GAME_MAKER_BASE_URL keeps its name until stage 3. Outside the repository, nockal.com/feuerwerk/ is a second symlink to the same tree. nginx sends the bare /game-maker/ folder there with a 301. Everything else under /game-maker/ is still served directly, so shared play links and the API keep working. Finding: when nginx redirects a path without a trailing slash or with a query, the Brandmauer answers with its own 307 to the same URL plus a slash, placed after the query. A play link would lose its token that way, which is why only the bare folder is redirected. Tests: - Gate on melektaus-atx: CHECK EXIT 0, 307 files, 4756 tests (4 new in site.test.ts). - Counter-check: when the migration misses the old prefix, 3 of the 4 new tests fail. - e2e 60 under /feuerwerk/: ALL PASSED, 20 checks. - From outside: /feuerwerk/ 200, /game-maker/ 301, an old play link 200. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
7.6 KiB
7.6 KiB
Feuerwerk
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/feuerwerk/ · Widget playground: https://nockal.com/feuerwerk/?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, sound FX, instrument, pattern, song, bus, 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/feuerwerk/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, 2065 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 clips, Play sound, buses and the Master routing, sound FX |
| Instruments | Instruments as node graphs, Chips and presets, the keys of the Instrument tab, Play note |
| Patterns | Patterns and the piano roll, playing one in a loop or from a game |
| Songs | Songs, their tracks and items, routing, recording, playing one from a game |
| 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.