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

20 lines
1.1 KiB
Markdown

# AI in the editors
**Generate…** in the [resource editors](resource-editors.md) (sprites, sound effects, tunes, levels, tilesets) asks one of:
| Provider | Needs | Runs |
|---|---|---|
| Claude | the `claude` command, your login | Anthropic |
| OpenCode | the `opencode` command; a model `provider/model` | the model OpenCode uses |
| OpenAI, Mistral, Groq, OpenRouter, Google Gemini | your API key | online |
| **Ollama, LM Studio, llama.cpp**, any OpenAI-compatible server | nothing | **your computer: nothing leaves it** |
| OpenAI Images | your API key | online (sprites, tilesets made pixel art) |
| ElevenLabs | your API key | online: real sound effects and music (mp3) |
Keys are kept in the IDE's settings on this computer, never in the project. The IDE checks every answer before an editor gets it, and
sends a wrong one back once with what is wrong (small local models often need it).
A tileset comes back as a sheet of tiles that fit together with their collision; a real sound is saved as an mp3 next to the resource
(`assets/sfx/…`), which a game plays as it is.
For code, see [Claude and OpenCode](claude.md).