winzik/docs/ide/games.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

30 lines
1.4 KiB
Markdown

# Games
JumPHP games and apps get their own tools.
## Play
- **Play the Game** (the game button of the tool bar, `Shift+F10` on a game configuration): on the desktop the game opens in its
window; on the web it plays in the **Game** window (`Alt+5`, right or bottom).
- The green ▶ of a `src/Scene/*.php` starts the game in that scene; of a test file runs its tests.
- **⚡ Live** (web): each file saved goes into the running game without reloading (pictures and sounds in place, code by restarting PHP
in the scene that was playing). **Restart**. The game's PHP output in its console.
## Run configurations
`run`, `test`, `shot` (a screenshot, opened in a tab), `build` (browser), `webshot`, `serve`, `export` (executables), `lint`
([Run](run.md)). **Run > Create an Installer…**: installers for Windows, Linux and macOS ([Publishing](publish.md)).
## Assets
Sprites, sound effects, tunes, tilesets and levels open in the [resource editors](resource-editors.md); forms of graphic apps in the
[form designer](form-designer.md). Configuration files are completed ([PHP](php.md), [YAML](yaml.md)).
## Engine extensions
**Tools > Extensions**: the extensions of the marketplace, added to a game (`bin/jumphp extension:add`), their documentation and
samples (▶ Play a sample).
## Memory and speed
[Profiler](profiler.md), [Cryo](cryo.md) (save points, hot patches), [Debugger](debugger.md).