Files
aventuriers-des-mots/README.md
T
Denis Defolie 57182172a9 Produce version 0.1.0: single-file exports and make package
Re-read the specification (§12, §13, §15) before producing the game:
Linux and Windows are the target platforms for this version. Embed
the PCK for one executable per platform, add config/version, and add
`make package` which re-exports from scratch and builds
dist/*.tar.gz, dist/*.zip and SHA256SUMS (executable + LICENSE +
READMEs + CREDITS + a short notice). READMEs updated to the real
status. Known gaps against the spec are listed in decisions.md.

Co-Authored-By: Claude Sonnet 5.5 <noreply@anthropic.com>
2026-10-11 22:07:06 +02:00

48 lines
2.5 KiB
Markdown

# Les Aventuriers des mots
Jeu éducatif de français pour les CE1-CE2 (7-9 ans) : une aventure 2D hors ligne, avec une carte à explorer, un personnage guide, et des exercices de grammaire, d'orthographe et de dictées.
Projet open source, en développement. Statut actuel : version 0.1.0, jouable hors ligne sur Linux et Windows — profils, sauvegardes, trois types d'exercices (choix multiple, correction de phrase, dictée), chapitre CE1 « accords dans le groupe nominal » (3 règles) et chapitre CE2 « homophones grammaticaux » (a/à, et/est, son/sont, on/ont), 21 missions. Contenu pédagogique entièrement en brouillon (`draft`, à valider) et voix des dictées provisoires (voir `assets/CREDITS.md` ; voir `docs/specs/decisions.md` pour les décisions de cadrage et `docs/specs/cahier-des-charges.md` pour la spécification complète).
## Pile technique
- Godot 4.6 (GDScript typé)
- Exercices et contenu pédagogique en données JSON, validées au chargement
- Tests headless (GUT), lint/format GDScript (gdtoolkit)
## Démarrer
```sh
make setup # installe Godot (pinné), GUT et gdtoolkit en local, rien n'est commité
make run # lance le jeu
```
## Commandes
| Commande | Effet |
|---|---|
| `make setup` | installe l'outillage (lint, tests, modèles d'export) |
| `make run` | lance le jeu |
| `make lint` / `make format` | analyse statique et formatage GDScript |
| `make validate-data` | valide les JSON de `data/` |
| `make test` | tests headless |
| `make check` | lint + validate-data + test, à passer avant chaque commit |
| `make content-review` | régénère `docs/review/content-review.md` (document de validation du contenu) |
| `make generate-dictation-audio` | génère l'audio provisoire des dictées |
| `make export-linux` / `make export-windows` | exports dans `build/` |
| `make package` | produit les archives distribuables dans `dist/` (exécutable unique + licence + crédits) |
## Structure
- `autoload/` : modules globaux (gestion du jeu, profils, progression, exercices, sauvegardes, audio, réglages)
- `scenes/` : scènes Godot, autonomes et communiquant par signaux
- `scripts/` : logique pure (correction, pédagogie) et chargement des données
- `data/` : contenu pédagogique en JSON, validé contre des schémas
- `assets/` : graphismes et audio (provisoires à ce stade, voir `assets/CREDITS.md`)
- `tests/` : tests headless (GUT)
- `docs/specs/` : cahier des charges et décisions de cadrage
## Licence
Code et contenu sous [GNU Affero General Public License v3](LICENSE).