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

17 lines
1.3 KiB
Markdown

# Cryo: memory, save points, hot patches
The **Cryo** window (right, the snowflake) uses ext-cryo, without changing your code.
![The Cryo window](images/cryo.png)
| Tab | What it does |
|---|---|
| **Live** | tick "Run with memory metrics" and run: memory over time, live objects, GC; **Snapshot** of the running program |
| **Files** | the `.cryo` snapshots: what retains memory per class, allocation sites, biggest retainers, duplicates, cycles, leak hints; two ticked: what grew and the line that keeps it; **why is it alive** (paths from a root) |
| **Save points** | **Freeze here** saves the whole running program (game loop, level, player…); **Resume here** runs it again exactly there, even after the code changed (then the scene alone) |
| **Hot patch / console** | the method under the cursor replaces the running one, constants set live, a PHP console inside the running game (`$engine`, `$scene`) |
| **Sandbox** | PHP run in an isolated sandbox (timeout, memory limit) |
| **A/B** | your change against the code before, the same run profiled for both, compared per changed function; Claude or OpenCode can propose the change |
**Reset** deletes `var/cryo` and `var/ab`. Needs the project's JumPHP 0.5.68 or newer. Claude has the same tools (`cryo_*`,
`ab_*`). More: [docs/cryo.md](../cryo.md).