winzik/docs/ide/resource-editors.md
David Nurdin 7de153fc14 IDE documentation: one page per feature (docs/ide/, French in docs/ide/fr/) and a Doc browser inside the IDE
- docs/ide/: 49 user pages grouped in toc.json (editing, languages, run / test / debug, Git, web sites and Symfony, databases,
  Docker and SSH, games, AI, team, settings); pages of features still being built are "coming soon" stubs with a TODO list;
  15 pages translated into French; docs/ide.md and docs/ide.fr.md link to them.
- The Doc button at the top right of the IDE, Help > Documentation, Search Everywhere "Documentation" and a "?" in each tool
  window's header open the Doc browser (ide/ui/js/docs-browser.js): table of contents, rendered pages (pictures, code, tables,
  links between pages and to headings), full-text search, back / forward, the IDE's language with English as the fallback.
- ide/src/Docs/DocsLibrary.php (docs.index, docs.image): reads only the documentation folder (strict names, real path checked);
  the packaged copy ui/docs first, else the repository's docs/ide.
- Packaging: tools/stage-game.sh copies docs/ide into the exported IDE (its *.md exclusion would drop them), overlay-build.php
  puts them in code updates, bin/jumphp ide syncs them.
- Tests: docs-model.test.mjs (TOC, links, anchors, pictures, search; every page and picture of docs/ide exists), DocsLibraryTest
  (path traversal refused), the i18n test covers the new texts in 14 languages.

Co-Authored-By: Claude Opus 5.5 <[email protected]>
Claude-Session: https://claude.ai/code/session_01JkYTqsvYu6AYr9yQ3Q4Nt6
2026-11-16 00:08:42 +01:00

990 B
Raw Permalink Blame History

Resource editors

Game assets open in editors of their own (the text of the file stays available with Code).

File Editor
a PNG of assets/ sprite editor: pixels drawn frame by frame (frames of W×H, as Sprite reads them), palette, pencil, eraser, fill, picker, zoom, grid, frames added / removed, the animation played; saved as PNG with alpha
*.sfx.json sound effects: a generator's settings from a preset or at random, heard and drawn at each change; saving also writes the WAV
*.music.json tunes: a piano roll, 4 voices (2 squares, triangle bass, noise drums), 16 steps a bar; saving also writes the WAV the game loops
*.tsj tileset (Tiled's format): the tiles and their collision (full, one-way, none)
*.tmj level (Tiled's format): layers painted with the tileset's tiles, objects

Generate…

Each editor has Generate…: describe what you want and an AI makes it (AI in the editors).