From 50198a49a20555c40023143d7452d18a3101dc21 Mon Sep 17 00:00:00 2001 From: Denis Defolie Date: Sun, 11 Oct 2026 16:06:51 +0200 Subject: [PATCH] Add project specs, stage-0 decisions, and AGPL-3.0 license Co-Authored-By: Claude Sonnet 5 --- CLAUDE.md | 62 +++ LICENSE | 661 +++++++++++++++++++++++++++++++ docs/specs/cahier-des-charges.md | 433 ++++++++++++++++++++ docs/specs/decisions.md | 90 +++++ docs/specs/exercise-lifecycle.md | 58 +++ prompt-lancement.md | 75 ++++ 6 files changed, 1379 insertions(+) create mode 100644 CLAUDE.md create mode 100644 LICENSE create mode 100644 docs/specs/cahier-des-charges.md create mode 100644 docs/specs/decisions.md create mode 100644 docs/specs/exercise-lifecycle.md create mode 100644 prompt-lancement.md diff --git a/CLAUDE.md b/CLAUDE.md new file mode 100644 index 0000000..aba031a --- /dev/null +++ b/CLAUDE.md @@ -0,0 +1,62 @@ +# Les Aventuriers des mots + +Jeu éducatif de français CE1–CE2 (7–9 ans), aventure 2D, hors ligne, Godot 4 / GDScript typé. Projet open source. + +- Spécification de référence : `docs/specs/cahier-des-charges.md`. Elle fait foi. En cas de contradiction ou d'ambiguïté, poser la question au lieu de trancher seul. +- Cycle de vie d'un exercice : `docs/specs/exercise-lifecycle.md`. +- Décisions validées en cours de projet : `docs/specs/decisions.md` (à tenir à jour). + +## Commandes + +Le `Makefile` est le seul point d'entrée pour les opérations système. Tenir cette liste à jour. + +- `make setup` : installe l'outillage (lint, tests, modèles d'export) +- `make run` : lance le jeu +- `make lint` / `make format` : analyse statique et formatage +- `make validate-data` : valide tous les JSON de `data/` contre leurs schémas +- `make test` : tests en mode headless +- `make check` : lint + validate-data + test (à passer avant chaque commit) +- `make export-linux` / `make export-windows` : exports dans `build/` + +## Conventions de code + +- Identifiants, noms de fichiers et messages de commit en anglais. +- Commentaires et docstrings en français. +- Aucun texte destiné à l'enfant en dur dans les scripts : il vit dans `data/` ou dans les fichiers de traduction. +- Indentation : 4 espaces, dans tous les langages, GDScript compris. Jamais de tabulation. `.editorconfig` et le formateur sont configurés en conséquence ; dans l'éditeur Godot, régler Editor Settings → Text Editor → Behavior → Indent → Type sur Spaces. +- GDScript : typage statique partout (variables, paramètres, retours, tableaux typés). Les déclarations non typées sont traitées comme des erreurs. +- Outils Python éventuels (`tools/`) : annotations de type, zéro erreur pyright. +- `README.md` (français) et `README-EN.md` (anglais) restent synchronisés. + +## Git + +- `.gitattributes` tenu à jour : fins de ligne LF pour le texte, assets marqués binaires. +- `.gitignore` exclut `.godot/`, `build/`, et tout secret : keystores, identifiants d'export, `.env`, mots de passe, adresses e-mail personnelles. +- Vérifier qu'`export_presets.cfg` ne contient aucun secret avant de le commiter. +- Un commit par unité de travail cohérente, `make check` au vert avant chaque commit. + +## Invariants d'architecture + +- Trois couches strictement séparées : moteur du jeu, données pédagogiques, progression par enfant. +- Les exercices sont des données JSON, validées au chargement. La liste des types d'exercices est fermée et définie dans le moteur. +- Une donnée ne peut jamais exécuter du code : pas d'`Expression`, pas de `str_to_var`, pas de chargement de script ou de scène depuis les données. +- Les fichiers référencés par les données (audio, images) le sont par identifiant, résolu par le moteur dans un répertoire fixe. Jamais de chemin libre. +- Les scènes sont autonomes et communiquent par signaux. Une scène d'exercice ne touche ni à la sauvegarde ni à la progression. +- Correction, difficulté et planification des révisions sont du code pur, sans dépendance à l'arbre de scènes, testable en headless. Horloge et hasard y sont injectés, jamais lus directement. +- Les explications viennent des données validées, jamais d'une génération à l'exécution. +- Aucun accès réseau. +- Sauvegardes dans `user://` : un fichier par profil, `schema_version`, écriture atomique (fichier temporaire puis remplacement), copie de secours, migration entre versions. +- Interface en conteneurs et ancres, sans positions fixes. Clavier, souris et tactile. Réussite et erreur ne sont jamais signalées par la seule couleur. +- Ne pas créer de module ou d'autoload sans responsabilité réelle. + +## Invariants pédagogiques + +- Une erreur déclenche une explication, jamais une punition. Aucune récompense liée à la vitesse. +- Contenu original uniquement : ne jamais reproduire le texte, les exemples ou les exercices du BLED ni d'aucun manuel. Le nom « BLED » n'apparaît ni dans le jeu ni dans les données. +- Tout exercice a une réponse attendue, un `rule_id`, un indice et une explication. +- Tout contenu rédigé par Claude porte `"review_status": "draft"` jusqu'à validation humaine. +- Une réponse ambiguë n'est pas déclarée fausse automatiquement. + +## Vérification + +Tests headless obligatoires pour la correction, la progression et les sauvegardes. Ce qui ne peut pas être vérifié sans écran (rendu, animations, audio, tactile, clavier virtuel) est signalé explicitement comme non vérifié, avec la marche à suivre pour le tester à la main. diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..be3f7b2 --- /dev/null +++ b/LICENSE @@ -0,0 +1,661 @@ + GNU AFFERO GENERAL PUBLIC LICENSE + Version 3, 19 November 2007 + + Copyright (C) 2007 Free Software Foundation, Inc. + Everyone is permitted to copy and distribute verbatim copies + of this license document, but changing it is not allowed. + + Preamble + + The GNU Affero General Public License is a free, copyleft license for +software and other kinds of works, specifically designed to ensure +cooperation with the community in the case of network server software. + + The licenses for most software and other practical works are designed +to take away your freedom to share and change the works. By contrast, +our General Public Licenses are intended to guarantee your freedom to +share and change all versions of a program--to make sure it remains free +software for all its users. + + When we speak of free software, we are referring to freedom, not +price. Our General Public Licenses are designed to make sure that you +have the freedom to distribute copies of free software (and charge for +them if you wish), that you receive source code or can get it if you +want it, that you can change the software or use pieces of it in new +free programs, and that you know you can do these things. + + Developers that use our General Public Licenses protect your rights +with two steps: (1) assert copyright on the software, and (2) offer +you this License which gives you legal permission to copy, distribute +and/or modify the software. + + A secondary benefit of defending all users' freedom is that +improvements made in alternate versions of the program, if they +receive widespread use, become available for other developers to +incorporate. Many developers of free software are heartened and +encouraged by the resulting cooperation. However, in the case of +software used on network servers, this result may fail to come about. +The GNU General Public License permits making a modified version and +letting the public access it on a server without ever releasing its +source code to the public. + + The GNU Affero General Public License is designed specifically to +ensure that, in such cases, the modified source code becomes available +to the community. It requires the operator of a network server to +provide the source code of the modified version running there to the +users of that server. Therefore, public use of a modified version, on +a publicly accessible server, gives the public access to the source +code of the modified version. + + An older license, called the Affero General Public License and +published by Affero, was designed to accomplish similar goals. This is +a different license, not a version of the Affero GPL, but Affero has +released a new version of the Affero GPL which permits relicensing under +this license. + + The precise terms and conditions for copying, distribution and +modification follow. + + TERMS AND CONDITIONS + + 0. Definitions. + + "This License" refers to version 3 of the GNU Affero General Public License. + + "Copyright" also means copyright-like laws that apply to other kinds of +works, such as semiconductor masks. + + "The Program" refers to any copyrightable work licensed under this +License. Each licensee is addressed as "you". "Licensees" and +"recipients" may be individuals or organizations. + + To "modify" a work means to copy from or adapt all or part of the work +in a fashion requiring copyright permission, other than the making of an +exact copy. The resulting work is called a "modified version" of the +earlier work or a work "based on" the earlier work. + + A "covered work" means either the unmodified Program or a work based +on the Program. + + To "propagate" a work means to do anything with it that, without +permission, would make you directly or secondarily liable for +infringement under applicable copyright law, except executing it on a +computer or modifying a private copy. Propagation includes copying, +distribution (with or without modification), making available to the +public, and in some countries other activities as well. + + To "convey" a work means any kind of propagation that enables other +parties to make or receive copies. Mere interaction with a user through +a computer network, with no transfer of a copy, is not conveying. + + An interactive user interface displays "Appropriate Legal Notices" +to the extent that it includes a convenient and prominently visible +feature that (1) displays an appropriate copyright notice, and (2) +tells the user that there is no warranty for the work (except to the +extent that warranties are provided), that licensees may convey the +work under this License, and how to view a copy of this License. If +the interface presents a list of user commands or options, such as a +menu, a prominent item in the list meets this criterion. + + 1. Source Code. + + The "source code" for a work means the preferred form of the work +for making modifications to it. "Object code" means any non-source +form of a work. + + A "Standard Interface" means an interface that either is an official +standard defined by a recognized standards body, or, in the case of +interfaces specified for a particular programming language, one that +is widely used among developers working in that language. + + The "System Libraries" of an executable work include anything, other +than the work as a whole, that (a) is included in the normal form of +packaging a Major Component, but which is not part of that Major +Component, and (b) serves only to enable use of the work with that +Major Component, or to implement a Standard Interface for which an +implementation is available to the public in source code form. A +"Major Component", in this context, means a major essential component +(kernel, window system, and so on) of the specific operating system +(if any) on which the executable work runs, or a compiler used to +produce the work, or an object code interpreter used to run it. + + The "Corresponding Source" for a work in object code form means all +the source code needed to generate, install, and (for an executable +work) run the object code and to modify the work, including scripts to +control those activities. However, it does not include the work's +System Libraries, or general-purpose tools or generally available free +programs which are used unmodified in performing those activities but +which are not part of the work. For example, Corresponding Source +includes interface definition files associated with source files for +the work, and the source code for shared libraries and dynamically +linked subprograms that the work is specifically designed to require, +such as by intimate data communication or control flow between those +subprograms and other parts of the work. + + The Corresponding Source need not include anything that users +can regenerate automatically from other parts of the Corresponding +Source. + + The Corresponding Source for a work in source code form is that +same work. + + 2. Basic Permissions. + + All rights granted under this License are granted for the term of +copyright on the Program, and are irrevocable provided the stated +conditions are met. This License explicitly affirms your unlimited +permission to run the unmodified Program. The output from running a +covered work is covered by this License only if the output, given its +content, constitutes a covered work. This License acknowledges your +rights of fair use or other equivalent, as provided by copyright law. + + You may make, run and propagate covered works that you do not +convey, without conditions so long as your license otherwise remains +in force. You may convey covered works to others for the sole purpose +of having them make modifications exclusively for you, or provide you +with facilities for running those works, provided that you comply with +the terms of this License in conveying all material for which you do +not control copyright. Those thus making or running the covered works +for you must do so exclusively on your behalf, under your direction +and control, on terms that prohibit them from making any copies of +your copyrighted material outside their relationship with you. + + Conveying under any other circumstances is permitted solely under +the conditions stated below. Sublicensing is not allowed; section 10 +makes it unnecessary. + + 3. Protecting Users' Legal Rights From Anti-Circumvention Law. + + No covered work shall be deemed part of an effective technological +measure under any applicable law fulfilling obligations under article +11 of the WIPO copyright treaty adopted on 20 December 1996, or +similar laws prohibiting or restricting circumvention of such +measures. + + When you convey a covered work, you waive any legal power to forbid +circumvention of technological measures to the extent such circumvention +is effected by exercising rights under this License with respect to +the covered work, and you disclaim any intention to limit operation or +modification of the work as a means of enforcing, against the work's +users, your or third parties' legal rights to forbid circumvention of +technological measures. + + 4. Conveying Verbatim Copies. + + You may convey verbatim copies of the Program's source code as you +receive it, in any medium, provided that you conspicuously and +appropriately publish on each copy an appropriate copyright notice; +keep intact all notices stating that this License and any +non-permissive terms added in accord with section 7 apply to the code; +keep intact all notices of the absence of any warranty; and give all +recipients a copy of this License along with the Program. + + You may charge any price or no price for each copy that you convey, +and you may offer support or warranty protection for a fee. + + 5. Conveying Modified Source Versions. + + You may convey a work based on the Program, or the modifications to +produce it from the Program, in the form of source code under the +terms of section 4, provided that you also meet all of these conditions: + + a) The work must carry prominent notices stating that you modified + it, and giving a relevant date. + + b) The work must carry prominent notices stating that it is + released under this License and any conditions added under section + 7. This requirement modifies the requirement in section 4 to + "keep intact all notices". + + c) You must license the entire work, as a whole, under this + License to anyone who comes into possession of a copy. This + License will therefore apply, along with any applicable section 7 + additional terms, to the whole of the work, and all its parts, + regardless of how they are packaged. This License gives no + permission to license the work in any other way, but it does not + invalidate such permission if you have separately received it. + + d) If the work has interactive user interfaces, each must display + Appropriate Legal Notices; however, if the Program has interactive + interfaces that do not display Appropriate Legal Notices, your + work need not make them do so. + + A compilation of a covered work with other separate and independent +works, which are not by their nature extensions of the covered work, +and which are not combined with it such as to form a larger program, +in or on a volume of a storage or distribution medium, is called an +"aggregate" if the compilation and its resulting copyright are not +used to limit the access or legal rights of the compilation's users +beyond what the individual works permit. Inclusion of a covered work +in an aggregate does not cause this License to apply to the other +parts of the aggregate. + + 6. Conveying Non-Source Forms. + + You may convey a covered work in object code form under the terms +of sections 4 and 5, provided that you also convey the +machine-readable Corresponding Source under the terms of this License, +in one of these ways: + + a) Convey the object code in, or embodied in, a physical product + (including a physical distribution medium), accompanied by the + Corresponding Source fixed on a durable physical medium + customarily used for software interchange. + + b) Convey the object code in, or embodied in, a physical product + (including a physical distribution medium), accompanied by a + written offer, valid for at least three years and valid for as + long as you offer spare parts or customer support for that product + model, to give anyone who possesses the object code either (1) a + copy of the Corresponding Source for all the software in the + product that is covered by this License, on a durable physical + medium customarily used for software interchange, for a price no + more than your reasonable cost of physically performing this + conveying of source, or (2) access to copy the + Corresponding Source from a network server at no charge. + + c) Convey individual copies of the object code with a copy of the + written offer to provide the Corresponding Source. This + alternative is allowed only occasionally and noncommercially, and + only if you received the object code with such an offer, in accord + with subsection 6b. + + d) Convey the object code by offering access from a designated + place (gratis or for a charge), and offer equivalent access to the + Corresponding Source in the same way through the same place at no + further charge. You need not require recipients to copy the + Corresponding Source along with the object code. If the place to + copy the object code is a network server, the Corresponding Source + may be on a different server (operated by you or a third party) + that supports equivalent copying facilities, provided you maintain + clear directions next to the object code saying where to find the + Corresponding Source. Regardless of what server hosts the + Corresponding Source, you remain obligated to ensure that it is + available for as long as needed to satisfy these requirements. + + e) Convey the object code using peer-to-peer transmission, provided + you inform other peers where the object code and Corresponding + Source of the work are being offered to the general public at no + charge under subsection 6d. + + A separable portion of the object code, whose source code is excluded +from the Corresponding Source as a System Library, need not be +included in conveying the object code work. + + A "User Product" is either (1) a "consumer product", which means any +tangible personal property which is normally used for personal, family, +or household purposes, or (2) anything designed or sold for incorporation +into a dwelling. In determining whether a product is a consumer product, +doubtful cases shall be resolved in favor of coverage. For a particular +product received by a particular user, "normally used" refers to a +typical or common use of that class of product, regardless of the status +of the particular user or of the way in which the particular user +actually uses, or expects or is expected to use, the product. A product +is a consumer product regardless of whether the product has substantial +commercial, industrial or non-consumer uses, unless such uses represent +the only significant mode of use of the product. + + "Installation Information" for a User Product means any methods, +procedures, authorization keys, or other information required to install +and execute modified versions of a covered work in that User Product from +a modified version of its Corresponding Source. The information must +suffice to ensure that the continued functioning of the modified object +code is in no case prevented or interfered with solely because +modification has been made. + + If you convey an object code work under this section in, or with, or +specifically for use in, a User Product, and the conveying occurs as +part of a transaction in which the right of possession and use of the +User Product is transferred to the recipient in perpetuity or for a +fixed term (regardless of how the transaction is characterized), the +Corresponding Source conveyed under this section must be accompanied +by the Installation Information. But this requirement does not apply +if neither you nor any third party retains the ability to install +modified object code on the User Product (for example, the work has +been installed in ROM). + + The requirement to provide Installation Information does not include a +requirement to continue to provide support service, warranty, or updates +for a work that has been modified or installed by the recipient, or for +the User Product in which it has been modified or installed. Access to a +network may be denied when the modification itself materially and +adversely affects the operation of the network or violates the rules and +protocols for communication across the network. + + Corresponding Source conveyed, and Installation Information provided, +in accord with this section must be in a format that is publicly +documented (and with an implementation available to the public in +source code form), and must require no special password or key for +unpacking, reading or copying. + + 7. Additional Terms. + + "Additional permissions" are terms that supplement the terms of this +License by making exceptions from one or more of its conditions. +Additional permissions that are applicable to the entire Program shall +be treated as though they were included in this License, to the extent +that they are valid under applicable law. If additional permissions +apply only to part of the Program, that part may be used separately +under those permissions, but the entire Program remains governed by +this License without regard to the additional permissions. + + When you convey a copy of a covered work, you may at your option +remove any additional permissions from that copy, or from any part of +it. (Additional permissions may be written to require their own +removal in certain cases when you modify the work.) You may place +additional permissions on material, added by you to a covered work, +for which you have or can give appropriate copyright permission. + + Notwithstanding any other provision of this License, for material you +add to a covered work, you may (if authorized by the copyright holders of +that material) supplement the terms of this License with terms: + + a) Disclaiming warranty or limiting liability differently from the + terms of sections 15 and 16 of this License; or + + b) Requiring preservation of specified reasonable legal notices or + author attributions in that material or in the Appropriate Legal + Notices displayed by works containing it; or + + c) Prohibiting misrepresentation of the origin of that material, or + requiring that modified versions of such material be marked in + reasonable ways as different from the original version; or + + d) Limiting the use for publicity purposes of names of licensors or + authors of the material; or + + e) Declining to grant rights under trademark law for use of some + trade names, trademarks, or service marks; or + + f) Requiring indemnification of licensors and authors of that + material by anyone who conveys the material (or modified versions of + it) with contractual assumptions of liability to the recipient, for + any liability that these contractual assumptions directly impose on + those licensors and authors. + + All other non-permissive additional terms are considered "further +restrictions" within the meaning of section 10. If the Program as you +received it, or any part of it, contains a notice stating that it is +governed by this License along with a term that is a further +restriction, you may remove that term. If a license document contains +a further restriction but permits relicensing or conveying under this +License, you may add to a covered work material governed by the terms +of that license document, provided that the further restriction does +not survive such relicensing or conveying. + + If you add terms to a covered work in accord with this section, you +must place, in the relevant source files, a statement of the +additional terms that apply to those files, or a notice indicating +where to find the applicable terms. + + Additional terms, permissive or non-permissive, may be stated in the +form of a separately written license, or stated as exceptions; +the above requirements apply either way. + + 8. Termination. + + You may not propagate or modify a covered work except as expressly +provided under this License. Any attempt otherwise to propagate or +modify it is void, and will automatically terminate your rights under +this License (including any patent licenses granted under the third +paragraph of section 11). + + However, if you cease all violation of this License, then your +license from a particular copyright holder is reinstated (a) +provisionally, unless and until the copyright holder explicitly and +finally terminates your license, and (b) permanently, if the copyright +holder fails to notify you of the violation by some reasonable means +prior to 60 days after the cessation. + + Moreover, your license from a particular copyright holder is +reinstated permanently if the copyright holder notifies you of the +violation by some reasonable means, this is the first time you have +received notice of violation of this License (for any work) from that +copyright holder, and you cure the violation prior to 30 days after +your receipt of the notice. + + Termination of your rights under this section does not terminate the +licenses of parties who have received copies or rights from you under +this License. If your rights have been terminated and not permanently +reinstated, you do not qualify to receive new licenses for the same +material under section 10. + + 9. Acceptance Not Required for Having Copies. + + You are not required to accept this License in order to receive or +run a copy of the Program. Ancillary propagation of a covered work +occurring solely as a consequence of using peer-to-peer transmission +to receive a copy likewise does not require acceptance. However, +nothing other than this License grants you permission to propagate or +modify any covered work. These actions infringe copyright if you do +not accept this License. Therefore, by modifying or propagating a +covered work, you indicate your acceptance of this License to do so. + + 10. Automatic Licensing of Downstream Recipients. + + Each time you convey a covered work, the recipient automatically +receives a license from the original licensors, to run, modify and +propagate that work, subject to this License. You are not responsible +for enforcing compliance by third parties with this License. + + An "entity transaction" is a transaction transferring control of an +organization, or substantially all assets of one, or subdividing an +organization, or merging organizations. If propagation of a covered +work results from an entity transaction, each party to that +transaction who receives a copy of the work also receives whatever +licenses to the work the party's predecessor in interest had or could +give under the previous paragraph, plus a right to possession of the +Corresponding Source of the work from the predecessor in interest, if +the predecessor has it or can get it with reasonable efforts. + + You may not impose any further restrictions on the exercise of the +rights granted or affirmed under this License. For example, you may +not impose a license fee, royalty, or other charge for exercise of +rights granted under this License, and you may not initiate litigation +(including a cross-claim or counterclaim in a lawsuit) alleging that +any patent claim is infringed by making, using, selling, offering for +sale, or importing the Program or any portion of it. + + 11. Patents. + + A "contributor" is a copyright holder who authorizes use under this +License of the Program or a work on which the Program is based. The +work thus licensed is called the contributor's "contributor version". + + A contributor's "essential patent claims" are all patent claims +owned or controlled by the contributor, whether already acquired or +hereafter acquired, that would be infringed by some manner, permitted +by this License, of making, using, or selling its contributor version, +but do not include claims that would be infringed only as a +consequence of further modification of the contributor version. For +purposes of this definition, "control" includes the right to grant +patent sublicenses in a manner consistent with the requirements of +this License. + + Each contributor grants you a non-exclusive, worldwide, royalty-free +patent license under the contributor's essential patent claims, to +make, use, sell, offer for sale, import and otherwise run, modify and +propagate the contents of its contributor version. + + In the following three paragraphs, a "patent license" is any express +agreement or commitment, however denominated, not to enforce a patent +(such as an express permission to practice a patent or covenant not to +sue for patent infringement). To "grant" such a patent license to a +party means to make such an agreement or commitment not to enforce a +patent against the party. + + If you convey a covered work, knowingly relying on a patent license, +and the Corresponding Source of the work is not available for anyone +to copy, free of charge and under the terms of this License, through a +publicly available network server or other readily accessible means, +then you must either (1) cause the Corresponding Source to be so +available, or (2) arrange to deprive yourself of the benefit of the +patent license for this particular work, or (3) arrange, in a manner +consistent with the requirements of this License, to extend the patent +license to downstream recipients. "Knowingly relying" means you have +actual knowledge that, but for the patent license, your conveying the +covered work in a country, or your recipient's use of the covered work +in a country, would infringe one or more identifiable patents in that +country that you have reason to believe are valid. + + If, pursuant to or in connection with a single transaction or +arrangement, you convey, or propagate by procuring conveyance of, a +covered work, and grant a patent license to some of the parties +receiving the covered work authorizing them to use, propagate, modify +or convey a specific copy of the covered work, then the patent license +you grant is automatically extended to all recipients of the covered +work and works based on it. + + A patent license is "discriminatory" if it does not include within +the scope of its coverage, prohibits the exercise of, or is +conditioned on the non-exercise of one or more of the rights that are +specifically granted under this License. You may not convey a covered +work if you are a party to an arrangement with a third party that is +in the business of distributing software, under which you make payment +to the third party based on the extent of your activity of conveying +the work, and under which the third party grants, to any of the +parties who would receive the covered work from you, a discriminatory +patent license (a) in connection with copies of the covered work +conveyed by you (or copies made from those copies), or (b) primarily +for and in connection with specific products or compilations that +contain the covered work, unless you entered into that arrangement, +or that patent license was granted, prior to 28 March 2007. + + Nothing in this License shall be construed as excluding or limiting +any implied license or other defenses to infringement that may +otherwise be available to you under applicable patent law. + + 12. No Surrender of Others' Freedom. + + If conditions are imposed on you (whether by court order, agreement or +otherwise) that contradict the conditions of this License, they do not +excuse you from the conditions of this License. If you cannot convey a +covered work so as to satisfy simultaneously your obligations under this +License and any other pertinent obligations, then as a consequence you may +not convey it at all. For example, if you agree to terms that obligate you +to collect a royalty for further conveying from those to whom you convey +the Program, the only way you could satisfy both those terms and this +License would be to refrain entirely from conveying the Program. + + 13. Remote Network Interaction; Use with the GNU General Public License. + + Notwithstanding any other provision of this License, if you modify the +Program, your modified version must prominently offer all users +interacting with it remotely through a computer network (if your version +supports such interaction) an opportunity to receive the Corresponding +Source of your version by providing access to the Corresponding Source +from a network server at no charge, through some standard or customary +means of facilitating copying of software. This Corresponding Source +shall include the Corresponding Source for any work covered by version 3 +of the GNU General Public License that is incorporated pursuant to the +following paragraph. + + Notwithstanding any other provision of this License, you have +permission to link or combine any covered work with a work licensed +under version 3 of the GNU General Public License into a single +combined work, and to convey the resulting work. The terms of this +License will continue to apply to the part which is the covered work, +but the work with which it is combined will remain governed by version +3 of the GNU General Public License. + + 14. Revised Versions of this License. + + The Free Software Foundation may publish revised and/or new versions of +the GNU Affero General Public License from time to time. Such new versions +will be similar in spirit to the present version, but may differ in detail to +address new problems or concerns. + + Each version is given a distinguishing version number. If the +Program specifies that a certain numbered version of the GNU Affero General +Public License "or any later version" applies to it, you have the +option of following the terms and conditions either of that numbered +version or of any later version published by the Free Software +Foundation. If the Program does not specify a version number of the +GNU Affero General Public License, you may choose any version ever published +by the Free Software Foundation. + + If the Program specifies that a proxy can decide which future +versions of the GNU Affero General Public License can be used, that proxy's +public statement of acceptance of a version permanently authorizes you +to choose that version for the Program. + + Later license versions may give you additional or different +permissions. However, no additional obligations are imposed on any +author or copyright holder as a result of your choosing to follow a +later version. + + 15. Disclaimer of Warranty. + + THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY +APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT +HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY +OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, +THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR +PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM +IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF +ALL NECESSARY SERVICING, REPAIR OR CORRECTION. + + 16. Limitation of Liability. + + IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING +WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS +THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY +GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE +USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF +DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD +PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), +EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF +SUCH DAMAGES. + + 17. Interpretation of Sections 15 and 16. + + If the disclaimer of warranty and limitation of liability provided +above cannot be given local legal effect according to their terms, +reviewing courts shall apply local law that most closely approximates +an absolute waiver of all civil liability in connection with the +Program, unless a warranty or assumption of liability accompanies a +copy of the Program in return for a fee. + + END OF TERMS AND CONDITIONS + + How to Apply These Terms to Your New Programs + + If you develop a new program, and you want it to be of the greatest +possible use to the public, the best way to achieve this is to make it +free software which everyone can redistribute and change under these terms. + + To do so, attach the following notices to the program. It is safest +to attach them to the start of each source file to most effectively +state the exclusion of warranty; and each file should have at least +the "copyright" line and a pointer to where the full notice is found. + + + Copyright (C) + + This program is free software: you can redistribute it and/or modify + it under the terms of the GNU Affero General Public License as published by + the Free Software Foundation, either version 3 of the License, or + (at your option) any later version. + + This program is distributed in the hope that it will be useful, + but WITHOUT ANY WARRANTY; without even the implied warranty of + MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + GNU Affero General Public License for more details. + + You should have received a copy of the GNU Affero General Public License + along with this program. If not, see . + +Also add information on how to contact you by electronic and paper mail. + + If your software can interact with users remotely through a computer +network, you should also make sure that it provides a way for users to +get its source. For example, if your program is a web application, its +interface could display a "Source" link that leads users to an archive +of the code. There are many ways you could offer source, and different +solutions will be better for different programs; see section 13 for the +specific requirements. + + You should also get your employer (if you work as a programmer) or school, +if any, to sign a "copyright disclaimer" for the program, if necessary. +For more information on this, and how to apply and follow the GNU AGPL, see +. diff --git a/docs/specs/cahier-des-charges.md b/docs/specs/cahier-des-charges.md new file mode 100644 index 0000000..ddb1aa6 --- /dev/null +++ b/docs/specs/cahier-des-charges.md @@ -0,0 +1,433 @@ +Cahier des charges fonctionnel et technique +Jeu éducatif de français CE1–CE2 — Godot 4 / GDScript +Jeu éducatif CE1-CE2 sous Godot 4 et GDScript, fondé sur les règles du BLED. Style : aventure 2D avec carte, personnages et missions. Exercices : grammaire, orthographe et dictées. Public : plusieurs profils d'enfants sur appareil familial. Fonctionnement hors ligne : oui. Prévoir architecture modulaire, progression pédagogique CE1/CE2, système de correction explicative, sauvegarde et export Linux, Windows, macOS, Android et iOS. + +Direction artistique indicative : un monde de mots, des personnages attachants et une aventure adaptée aux enfants de 7 à 9 ans. + +1. Présentation du projet +Nom de travail : Les Aventuriers des mots +L'objectif est de développer un jeu éducatif en 2D permettant aux enfants de CE1 et CE2 d'acquérir, de consolider et d'approfondir les règles de grammaire et d'orthographe françaises, à travers une aventure interactive inspirée de la progression pédagogique du BLED. +Le jeu doit combiner trois dimensions : +- Pédagogique : des règles clairement expliquées, des exercices progressifs, des dictées et des corrections détaillées. +- Ludique : une carte à explorer, des personnages, des missions, des objets à collectionner et des récompenses. +- Technique : une application autonome, modulaire, fonctionnant sans connexion Internet et disponible sur ordinateurs et appareils mobiles. +Le jeu ne doit pas être un simple questionnaire habillé d'un décor. La progression dans l'aventure doit donner du sens aux apprentissages, tandis que les mécanismes pédagogiques doivent garantir que l'enfant progresse réellement. +Fiche d'identité +Élément Spécification +Public cible CE1 et CE2, environ 7–9 ans +Moteur Godot 4.x, version stable retenue au démarrage +Langage GDScript typé +Graphismes 2D, illustrations originales, animations +Plateformes Linux, Windows, macOS, Android, iOS +Connexion Aucune nécessaire en fonctionnement normal +Utilisateurs Plusieurs profils enfants sur un même appareil +Sauvegarde Locale, persistante, par profil +Contenu Grammaire, orthographe, conjugaison, dictées +Référence pédagogique Règles et progression inspirées du BLED, à valider +Réseau Non requis pour jouer, progresser ou sauvegarder +2. Vision pédagogique +Le jeu s'appuie sur un cycle d'apprentissage commun à chaque notion : +1. Découvrir la règle +Explication courte, exemple illustré, lecture audio facultative. + +2. S'entraîner avec de l'aide +Exercices guidés, indices et démonstrations. + +3. Réussir une mission +Application de la règle dans un défi ludique. + +4. Consolider les acquis +Révisions différées, exercices variés et dictées ciblées. + + +Principes pédagogiques obligatoires +1. Une erreur déclenche une explication, pas une punition. +2. Les consignes sont courtes, adaptées à l'âge et accompagnées d'exemples. +3. La difficulté évolue en fonction des résultats, sans bloquer durablement l'enfant. +4. Une règle n'est pas considérée comme acquise sur la seule base d'une réussite isolée. +5. Les exercices alternent reconnaissance, manipulation, application et production écrite. +6. Les récompenses valorisent les efforts, la compréhension et la progression, pas uniquement la rapidité. +3. Univers du jeu et direction artistique +Le monde est divisé en régions pédagogiques. Chaque région possède son identité graphique, ses personnages et ses objectifs. + +Région 1 — Le village des phrases +Découverte du nom, du déterminant, du verbe, de l'adjectif et de la construction des phrases. Niveau d'entrée CE1. + +Région 2 — La forêt des accords +Genre, nombre, pluriels, accords dans le groupe nominal et accords entre le sujet et le verbe. + +Région 3 — Le château des verbes +Présent, futur, imparfait et autres formes travaillées dans la progression retenue, avec des défis de conjugaison. + +Région 4 — Les grottes de l'orthographe +Homophones grammaticaux, graphies difficiles, mots fréquents et dictées thématiques. + +Les régions pourront être débloquées progressivement. Le contenu CE2 approfondira les mêmes notions ou ouvrira des zones spécifiques, plutôt que de simplement augmenter le nombre de questions. +Personnages principaux +- Plume, le hibou : explique les règles et fournit des indices. +- Milo, le jeune explorateur : accompagne l'enfant dans les missions. +- Les gardiens des mots : proposent les défis de chaque région. +- Les personnages des missions : donnent un contexte narratif aux exercices. +L'enfant pourra choisir un avatar et personnaliser certains éléments cosmétiques. Ces éléments ne doivent pas donner d'avantage pédagogique. +4. Progression pédagogique CE1 et CE2 +Le contenu sera organisé en chapitres, notions, règles, exercices et évaluations. La progression ci-dessous est une proposition initiale à confronter aux programmes en vigueur et aux éditions du BLED retenues. +Parcours CE1 — Acquérir les bases +1. Les mots et leur nature : nom, déterminant, verbe, adjectif et pronoms usuels. +2. Le groupe nominal : genre, nombre, déterminants, accords simples et marques du pluriel. +3. La phrase : majuscule, ponctuation, ordre des mots, phrase déclarative et interrogative. +4. Le sujet et le verbe : identification et accords simples dans les phrases étudiées. +5. La conjugaison : formes et personnes des verbes usuels, aux temps retenus dans la progression. +6. L'orthographe : mots fréquents, sons et graphies, lettres muettes, pluriels et difficultés lexicales adaptées. +7. Les premières dictées : mots, groupes de mots et phrases courtes. + +Parcours CE2 — Approfondir et réinvestir +1. Les classes grammaticales : approfondissement des catégories et de leur rôle dans la phrase. +2. Les accords : groupe nominal, sujet-verbe et cas plus variés. +3. La conjugaison : régularités, verbes usuels, personnes et temps du programme retenu. +4. Les homophones : notamment a/à, et/est, son/sont, on/ont, avec des tests de substitution simples. +5. L'orthographe lexicale : mots fréquents, familles de mots et graphies à mémoriser. +6. La correction de textes : repérage et correction de plusieurs erreurs dans un contexte. +7. Les dictées : dictées préparées, dictées ciblées et courtes dictées de synthèse. + +Chaque notion devra être reliée à une règle explicite, à des prérequis et à des exercices de difficultés différentes. Un enfant de CE2 qui rencontre une difficulté sur une notion de CE1 pourra revenir à un entraînement adapté sans perdre sa progression dans l'aventure. + +5. Catalogue des types d'exercices +Le moteur d'exercices sera indépendant des décors. Une même mécanique pourra donc être utilisée dans plusieurs régions avec des contenus différents. +Type d'exercice Interaction Compétence +Choix multiple Sélectionner une réponse Reconnaissance d'une règle +Mot à compléter Choisir ou saisir les lettres manquantes Orthographe lexicale +Tri de mots Déplacer les mots vers des catégories Classes grammaticales +Phrase à reconstruire Ordonner les éléments Syntaxe +Correction de phrase Repérer et corriger les erreurs Grammaire et orthographe +Conjugaison Choisir ou saisir une forme verbale Morphologie verbale +Dictée Écouter puis écrire Orthographe et accords +Défi mixte Résoudre plusieurs questions liées Réinvestissement +Dictées : exigences particulières +Les dictées ne doivent pas être traitées comme de simples questions à choix multiple. +Le système devra proposer : +- une lecture audio de la consigne et du texte, avec commandes de lecture et de répétition ; +- une zone de saisie adaptée au clavier et aux écrans tactiles ; +- une comparaison de la production avec le texte cible ; +- une analyse des erreurs orthographiques, des accents et des accords ; +- une correction qui explique chaque erreur en fonction de la règle travaillée ; +- une nouvelle tentative, sans sanction excessive ; +- des dictées courtes, puis des dictées de synthèse. +La correction devra distinguer une erreur lexicale d'une erreur grammaticale lorsqu'une classification fiable est possible. Les réponses ambiguës ne devront pas être déclarées fausses automatiquement sans vérification. +Pour les dictées, il faudra définir les règles de tolérance : accents, apostrophes, majuscules, ponctuation, variantes admises et erreurs multiples dans un même mot. Les caractères français, dont é, è, ê, ç et œ, devront être gérés correctement. + +6. Système de correction explicative +C'est l'un des composants les plus importants du projet. +Exemple : l'enfant écrit « Les petit chiens courent ». +Retour pédagogique + +Phrase proposée par l'enfant +Les petit chiens courent. +Correction proposée +Les petits chiens courent. + +Pourquoi ? +Le déterminant « les » indique un pluriel. L'adjectif « petit » s'accorde avec le nom « chiens » et prend donc la marque du pluriel : « petits ». + +Pour t'aider à retenir +« Quand un adjectif accompagne un nom, il s'accorde généralement avec ce nom en genre et en nombre. » +Prochain défi : retrouver les marques du pluriel dans trois autres groupes nominaux. + +Fonctionnement interne +Le moteur de correction devra retourner une structure exploitable par l'interface, comprenant : +- le résultat global ; +- les erreurs identifiées et leur position ; +- la règle concernée ; +- l'explication adaptée au niveau ; +- un indice facultatif ; +- une ou plusieurs propositions de remédiation. +Les explications seront préparées et validées dans les données pédagogiques, plutôt que générées automatiquement au moment de chaque erreur. Cela garantit un fonctionnement hors ligne, une cohérence des règles et un contrôle de la qualité pédagogique. + +7. Architecture technique Godot 4 +Je recommande une architecture modulaire, avec une séparation stricte entre le moteur du jeu, les données pédagogiques et la progression de chaque enfant. +Arborescence proposée + +aventuriers_des_mots/ +├── project.godot +├── autoload/ +│ ├── game_manager.gd +│ ├── profile_manager.gd +│ ├── progress_manager.gd +│ ├── exercise_engine.gd +│ ├── save_manager.gd +│ ├── audio_manager.gd +│ └── settings_manager.gd +├── scenes/ +│ ├── boot/ +│ │ └── boot.tscn +│ ├── profiles/ +│ │ ├── profile_select.tscn +│ │ └── profile_create.tscn +│ ├── world/ +│ │ ├── world_map.tscn +│ │ ├── region.tscn +│ │ └── mission_intro.tscn +│ ├── exercises/ +│ │ ├── exercise_host.tscn +│ │ ├── multiple_choice.tscn +│ │ ├── word_sort.tscn +│ │ ├── sentence_builder.tscn +│ │ ├── sentence_correction.tscn +│ │ ├── conjugation.tscn +│ │ └── dictation.tscn +│ ├── ui/ +│ │ ├── hud.tscn +│ │ ├── rule_panel.tscn +│ │ ├── feedback_panel.tscn +│ │ ├── reward_screen.tscn +│ │ └── pause_menu.tscn +│ └── characters/ +│ ├── avatar.tscn +│ └── guide_owl.tscn +├── scripts/ +│ ├── models/ +│ │ ├── exercise_data.gd +│ │ ├── rule_data.gd +│ │ └── player_progress.gd +│ ├── correction/ +│ │ ├── answer_validator.gd +│ │ └── dictation_analyzer.gd +│ └── pedagogy/ +│ ├── difficulty_manager.gd +│ └── review_scheduler.gd +├── data/ +│ ├── curriculum/ +│ ├── rules/ +│ ├── exercises/ +│ │ ├── ce1/ +│ │ └── ce2/ +│ ├── dictations/ +│ └── localization/ +├── assets/ +│ ├── characters/ +│ ├── environments/ +│ ├── interface/ +│ ├── audio/ +│ ├── fonts/ +│ └── animations/ +└── tests/ + ├── test_corrections.gd + ├── test_progression.gd + ├── test_saves.gd + └── test_exercise_data.gd + + +Cette arborescence est un point de départ : il faudra ajuster les fichiers selon les responsabilités réelles et éviter de multiplier les modules sans nécessité. +Autoloads : responsabilités +Module Rôle +GameManager Cycle de vie, navigation et état général +ProfileManager Création, sélection et suppression des profils +ProgressManager Compétences, missions et révisions +ExerciseEngine Chargement et déroulement des exercices +SaveManager Sérialisation et sauvegardes +AudioManager Voix, dictées, musiques et effets sonores +SettingsManager Volume, taille du texte et préférences +Les scènes doivent rester autonomes et communiquer par des signaux Godot ou par des interfaces clairement définies. Une scène de dictée ne doit pas gérer elle-même les sauvegardes ou la progression générale. + +Cycle de vie d'un exercice +mermaid-diagram.png joint + +8. Format des données pédagogiques +Les exercices doivent être des données, et non du code spécifique à chaque question. Un fichier JSON permet de modifier, vérifier et enrichir le contenu sans toucher aux scènes Godot. +Exemple illustratif d'un exercice de CE1 : + +{ + "id": "ce1_accord_001", + "level": "CE1", + "domain": "grammaire", + "skill": "accord_groupe_nominal", + "rule_id": "regle_accord_adjectif", + "difficulty": 1, + "type": "multiple_choice", + "instruction": "Choisis le bon groupe de mots.", + "question": "Les ... chiens jouent.", + "answers": [ + "petit", + "petits", + "petite" + ], + "correct_answer": 1, + "hint": "Observe le déterminant « les » et le nom « chiens ».", + "explanation": "Le groupe nominal est au pluriel. L'adjectif prend ici la marque du pluriel.", + "review_tags": [ + "pluriel", + "accord_adjectif" + ] +} + +Le schéma définitif devra préciser les champs obligatoires, les formats de réponse, les règles de validation et les références aux fichiers audio. +Pour les dictées, il faudra un modèle de données distinct : texte cible, enregistrement audio, segments éventuels, règles évaluées, variantes acceptées et critères de correction. +Règle d'architecture : le contenu ne doit jamais pouvoir exécuter du code arbitraire. Les données JSON sont validées au chargement et les types d'exercices autorisés sont définis dans le moteur. + + +9. Progression et personnalisation +Le jeu devra mémoriser séparément les résultats de chaque enfant. La progression pédagogique et la progression narrative seront liées, mais distinctes. +Indicateurs par compétence +- nombre de tentatives ; +- taux de réussite récent ; +- erreurs fréquentes ; +- niveau d'aide utilisé ; +- dernière date de pratique ; +- maîtrise estimée ; +- prochaine révision conseillée. +Une première version peut employer un système simple et transparent : +1. Découverte : présentation de la règle. +2. En cours d'acquisition : réussite avec des indices. +3. En consolidation : réussite répétée sans aide. +4. Acquise : réussite confirmée sur plusieurs séances et dans plusieurs formats. +5. À réviser : difficulté réapparue après un délai. +Ces états sont pédagogiques, pas des notes scolaires officielles. +Le système de révision devra faire revenir les notions fragiles après un délai adapté. Il ne doit pas se limiter à répéter immédiatement la même question : il faut varier les exemples et les contextes. +Profils familiaux +Chaque profil comprendra : +- un identifiant interne ; +- un pseudonyme et un avatar ; +- le niveau scolaire et les préférences ; +- la progression CE1/CE2 ; +- les résultats et révisions ; +- les récompenses ; +- les paramètres personnels utiles. +L'écran de sélection devra être simple et lisible. La suppression d'un profil nécessitera une confirmation explicite. Les données seront conservées localement, sans compte obligatoire ni collecte réseau. +Une zone réservée à l'adulte pourra présenter les progrès, les difficultés récurrentes et les notions à retravailler. Elle devra être accessible sans complexifier l'expérience de l'enfant. + + +10. Sauvegarde locale et fonctionnement hors ligne +Godot fournit user://, un emplacement adapté aux données persistantes de l'application. Les sauvegardes devront être séparées du dossier du projet et ne pas dépendre du répertoire de lancement. +Je recommande : +- un fichier de données par profil ; +- un format versionné, par exemple JSON dans la première version ; +- une sauvegarde après chaque mission ou changement important ; +- une écriture atomique ou un mécanisme de fichier temporaire et remplacement ; +- une sauvegarde de secours en cas de corruption ; +- une migration des données si le format change entre deux versions ; +- un bouton d'export et de restauration de sauvegarde, au minimum dans l'espace adulte. +Le chiffrement n'est pas indispensable pour des données pédagogiques ordinaires, mais les fichiers ne doivent pas être présentés comme inviolables. L'objectif est la robustesse et la confidentialité locale, pas la protection contre un attaquant disposant d'un accès complet à l'appareil. +Exemple de structure de sauvegarde + +{ + "schema_version": 1, + "profile_id": "profile_001", + "display_name": "Explorateur", + "school_level": "CE1", + "unlocked_regions": [ + "village_des_phrases" + ], + "skills": { + "accord_groupe_nominal": { + "status": "consolidation", + "attempts": 12, + "recent_success_rate": 0.83, + "last_practiced": "2026-10-11" + } + }, + "rewards": { + "stars": 18, + "items": [] + } +} + +Les données de date et de progression ci-dessus sont des exemples de format, pas des résultats réels. + + +11. Interface utilisateur et accessibilité +L'interface doit être conçue pour des enfants qui maîtrisent encore progressivement la lecture et l'écriture. +Exigences visuelles +- Typographie très lisible, avec une police adaptée aux jeunes lecteurs. +- Contrastes suffisants et taille de texte réglable. +- Boutons larges, adaptés au tactile et à la souris. +- Consignes courtes, accompagnées si nécessaire d'une lecture audio. +- Animations fluides, sans surcharge visuelle. +- Indications de réussite ou d'erreur qui ne reposent pas uniquement sur la couleur. +- Interface adaptée au format portrait ou paysage selon la plateforme. +- Possibilité de désactiver les animations et de régler les volumes sonores. +Je choisirais une direction artistique cohérente, avec des illustrations originales et une palette de couleurs limitée par région. Le jeu doit être attrayant sans distraire l'enfant de la règle étudiée. +Résolutions et formats +L'interface sera conçue avec les conteneurs et ancres de Godot, plutôt qu'avec des positions fixes. Cela permettra de gérer les écrans d'ordinateurs, les tablettes et les smartphones. +Les interactions devront fonctionner au clavier, à la souris et au tactile. Pour les dictées, l'interface mobile devra gérer correctement l'ouverture du clavier virtuel, les accents et le retour au jeu. + + +12. Exigences de qualité et tests +Le projet sera considéré comme exploitable lorsque les critères suivants seront validés. +Domaine Critère d'acceptation +Pédagogie Chaque exercice possède une réponse attendue, une règle associée et une explication validée +Corrections Les réponses justes et fausses sont correctement évaluées selon les règles définies +Progression Les notions, niveaux et missions débloqués sont cohérents +Profils Deux enfants peuvent jouer sans mélanger leurs résultats +Sauvegarde Les progrès sont conservés après fermeture et redémarrage +Résilience Une sauvegarde interrompue ne détruit pas automatiquement la dernière version valide +Hors ligne Les parcours, exercices, dictées et sauvegardes fonctionnent sans Internet +Interface Les menus et exercices restent utilisables sur petits et grands écrans +Performance Les transitions et animations restent fluides sur les appareils cibles retenus +Export Chaque plateforme possède une version installable et testée +Confidentialité Aucune collecte ou transmission réseau n'est nécessaire au fonctionnement normal +Il faudra automatiser en priorité les tests des règles de correction, de la progression et des sauvegardes. Un corpus de tests linguistiques permettra de vérifier les pluriels, les accords, les homophones, les accents et les cas particuliers. + +13. Export multiplateforme +Godot permet de préparer des exports pour les cinq plateformes visées, mais chaque cible demande une validation spécifique. +Plateforme Points de vigilance +Linux Tester sur les distributions cibles et leurs dépendances graphiques +Windows Vérifier l'installation, les chemins de sauvegarde et les polices +macOS Vérifier la signature, la distribution et les restrictions de sécurité +Android Tester le tactile, les formats d'écran, l'audio et le clavier virtuel +iOS Prévoir la chaîne d'export Apple, Xcode et un environnement macOS compatible +Les versions mobiles nécessitent des tests sur appareils réels. Pour iOS, un Mac et les outils Apple seront nécessaires à la préparation et à la signature de la version distribuable. L'export ne garantit pas, à lui seul, l'acceptation dans les boutiques d'applications. +Je recommande de commencer les validations techniques sur Linux et Windows, puis Android, tout en vérifiant assez tôt la faisabilité de la chaîne macOS/iOS pour éviter une mauvaise surprise en fin de projet. + +14. Plan de réalisation + +Phase 1 — Cadrage pédagogique et technique +Livrables : cahier des règles, schéma des données, architecture du projet, maquettes d'interface. +Définir les notions, les prérequis, les règles de correction et les premiers exercices validés. + +Phase 2 — Prototype jouable +Livrable : une région, une mission complète et un profil. +Créer la carte, le personnage guide, le moteur d'exercices, la correction explicative et la sauvegarde. + +Phase 3 — Contenu pédagogique +Livrable : premiers chapitres CE1 et CE2. +Ajouter les règles, exercices variés, dictées, tests de correction et mécanismes de révision. + +Phase 4 — Profils et expérience familiale +Livrable : version familiale complète en local. +Finaliser les profils multiples, les sauvegardes, les réglages et le tableau de progression. + +Phase 5 — Tests et distribution +Livrable : versions candidates pour les plateformes retenues. +Tester les appareils réels, la restauration des sauvegardes, l'accessibilité, les performances et les procédures d'installation. + + +15. Périmètre de la première version jouable +Pour maîtriser le risque et obtenir rapidement un résultat concret, je limiterais le premier prototype à : +- une carte avec trois lieux accessibles ; +- un personnage guide animé ; +- deux profils enfants ; +- un chapitre CE1 sur les accords dans le groupe nominal ; +- un chapitre CE2 sur les homophones grammaticaux ; +- trois types d'exercices : choix multiple, correction de phrase et dictée ; +- une correction explicative et un système d'indices ; +- une progression par compétence et des révisions ; +- une sauvegarde locale ; +- un premier export Linux et Windows. +Ce périmètre suffit à valider l'architecture sans devoir produire immédiatement toutes les régions, animations et centaines d'exercices. + +16. Décisions à prendre avant de commencer le code + +Trois décisions auront une influence importante sur la conception : + +1. Direction graphique +Dessin animé 2D, personnages et décors illustrés + + +2. Voix des dictées et consignes +Voix préenregistrées, naturelles et constantes + + +3. Gestion du contenu pédagogique +Fichiers JSON édités hors de Godot + +4. Référence au BLED +S'inspirer des règles et rédiger des exercices originaux diff --git a/docs/specs/decisions.md b/docs/specs/decisions.md new file mode 100644 index 0000000..f34293a --- /dev/null +++ b/docs/specs/decisions.md @@ -0,0 +1,90 @@ +# Décisions validées en cours de projet + +Ce document consigne les décisions prises à l'étape 0 (cadrage) et celles qui suivront. Il fait foi au même titre que le cahier des charges pour les points qu'il tranche ; en cas de contradiction avec `cahier-des-charges.md`, ce fichier a priorité car il représente la décision la plus récente. À tenir à jour à chaque décision significative. + +## 0. Gouvernance du dépôt + +- **Licence** : GNU Affero General Public License v3 (AGPL-3.0) pour le code. Fichier `LICENSE` à la racine. +- **Hébergement** : dépôt GitHub privé, `deunix-educ/aventuriers-des-mots`. +- **Identité des commits** : Denis Defolie , configurée localement pour ce dépôt (pas dans la config git globale de la machine). + +## 1. Version de Godot + +Godot **4.6** (branche stable la plus récente au démarrage du projet, sortie janvier 2026). Figée via un fichier `.godot-version` à la racine. Binaire officiel précompilé téléchargé manuellement, jamais committé. + +## 2. Outillage + +- Tests headless : addon **GUT** (`addons/gut`), exécuté par `godot --headless -s addons/gut/gut_cmdln.gd`. +- Lint / format GDScript : **gdtoolkit** (`gdlint`, `gdformat`), installé via `make setup`, configuré en 4 espaces d'indentation. +- Validation des données JSON : pas de bibliothèque GDScript mûre pour JSON Schema. Le validateur est écrit en GDScript et constitue la seule source de vérité : c'est le même code qui valide au chargement dans le jeu et que `make validate-data` invoque en headless. Aucun second validateur Python qui dupliquerait la logique. +- Outils Python éventuels dans `tools/` : annotations de type, zéro erreur `pyright`, usage limité à des scripts de support (pas de revalidation parallèle des données). + +## 3. Schémas JSON + +Schémas distincts : `rule`, `exercise` (un schéma par valeur de `type`, discriminé sur ce champ), `dictation` (modèle séparé, §8 du cahier des charges), `curriculum`, `save`. + +**Interaction de correction de phrase** : l'enfant touche (ou clique) le mot fautif, puis saisit sa correction — pas de ressaisie complète de la phrase. Justification : plus adapté au tactile et à l'âge visé (7–9 ans), et la donnée devient une liste de tokens dont chacun des fautifs porte sa correction attendue et son `rule_id`, ce qui répond directement à l'exigence du §6 (« les erreurs identifiées et leur position »). + +## 4. Structure de correction (§6) + +Objet `CorrectionResult` retourné par `answer_validator` / `dictation_analyzer` : + +- `is_correct: bool` +- `errors: Array[ErrorDetail]`, chaque `ErrorDetail` portant `position` (index du token), `error_type` (`lexical` | `grammatical` | `unclassified`), `rule_id`, `found`, `expected` +- `explanation: String` +- `hint: String` (facultatif) +- `remediation: Array[String]` + +Les dictées produisent les mêmes `errors[]`, après l'alignement mot-à-mot décrit au point « Points durs » du prompt de lancement. + +## 5. États de maîtrise (§9) et révisions + +Constantes nommées (pas de valeurs en dur dispersées) : + +| Transition | Seuil | +|---|---| +| Découverte → En acquisition | première réussite, aidée ou non | +| En acquisition → En consolidation | ≥2 réussites sans indice sur les 5 dernières tentatives, taux de réussite récent ≥0,6 | +| En consolidation → Acquise | taux de réussite ≥0,85 sur les 8 dernières tentatives, 0 indice sur les 4 dernières réussites, réussites réparties sur **≥3 séances distinctes** et **≥2 formats d'exercice différents** | +| → À réviser | un échec sur une compétence consolidée ou acquise, ou délai de révision atteint | + +Révision planifiée en **séances comptées**, pas en jours calendaires seuls (l'horloge d'un appareil familial n'est pas fiable) : paliers à 1, 3, 6, 12 séances après la dernière réussite à ce palier (doublement façon répétition espacée). La date (`last_practiced`) reste enregistrée et affichée (espace adulte) mais n'est pas le déclencheur principal. + +## 6. Tolérance des dictées (§5) + +- **Accents** : exigés, comparés après alignement mot-à-mot (pour ne pas décaler les erreurs suivantes). +- **Apostrophes** : droite et typographique normalisées, traitées comme identiques. +- **Espaces** (y compris insécables) : normalisés avant comparaison, jamais une source d'erreur. +- **Majuscules** : comparaison insensible à la casse pour l'identité lexicale ; une majuscule attendue (début de phrase, nom propre) est vérifiée comme erreur à part, pilotée par une annotation de la donnée cible. +- **Ponctuation finale** : erreur distincte, non cascadée sur les mots qui suivent. +- **Variantes admises** : liste explicite par dictée dans les données. +- **Erreurs multiples dans un mot** : comptées comme une seule erreur sur ce mot, classée par la règle annotée dominante. + +## 7. Écarts de `exercise-lifecycle.md` + +Les deux propositions du document sont retenues telles que rédigées : + +1. Chaque validation, juste ou fausse, produit un enregistrement de tentative transmis à `ProgressManager` ; l'écriture sur disque reste groupée en fin de mission. +2. Aide graduée sur 3 essais (indice, puis explication, puis réponse montrée + explication + marquage pour révision), le nombre d'essais étant un paramètre configurable, pas une constante en dur. + +## 8. Audio provisoire des dictées + +Synthèse vocale française générée hors ligne **au moment de la rédaction du contenu** (outil type eSpeak-ng), rendue une fois en fichiers `.ogg` versionnés dans `assets/audio/`. Jamais de génération à l'exécution, jamais de moteur TTS embarqué, aucun accès réseau. Chaque entrée audio provisoire porte `audio_provisional: true` dans la donnée, affiché comme badge « voix provisoire » par l'UI. Remplacement fichier par fichier, sans toucher au code. Source notée dans `assets/CREDITS.md`. + +## 9. Écarts par rapport à l'arborescence du §7 + +Les 7 autoloads du cahier des charges sont conservés tels quels : chacun a une responsabilité réelle dès le périmètre §15 (y compris `AudioManager` pour les dictées et `SettingsManager` pour les réglages de volume). + +Ajouts à l'arborescence proposée : + +- `data/schemas/` : les schémas JSON eux-mêmes. +- `scripts/data/` : chargeurs de données et validateur GDScript. +- `addons/gut/` : framework de tests headless. +- `tests/` organisé en sous-dossiers miroir (`tests/correction/`, `tests/pedagogy/`, `tests/data/`, `tests/saves/`) plutôt qu'à plat. +- `docs/review/` (`content-review.md`) et `docs/testing/` (`manual-checklist.md`), déjà prévus par le prompt de lancement. + +## 10. Questions restées ouvertes + +- Licence et hébergement : tranchés ci-dessus (point 0). +- Validation du contenu CE1/CE2 par un enseignant avant diffusion : à organiser, pas de date fixée. +- Spécification minimale de performance pour « appareil familial » : non définie, à préciser avant les exports. diff --git a/docs/specs/exercise-lifecycle.md b/docs/specs/exercise-lifecycle.md new file mode 100644 index 0000000..1af4a9e --- /dev/null +++ b/docs/specs/exercise-lifecycle.md @@ -0,0 +1,58 @@ +# Cycle de vie d'un exercice + +Transcription du diagramme joint au cahier des charges (§7), suivie de la répartition des responsabilités et de deux écarts à trancher avant de coder. + +## Diagramme d'origine + +```mermaid +flowchart TD + A["Carte du monde"] --> B["Choisir une mission"] + B --> C["Charger les données"] + C --> D["Afficher la règle et les exemples"] + D --> E["Lancer l'exercice"] + E --> F["Saisir la réponse"] + F --> G["Valider la réponse"] + G --> H{"Réponse correcte ?"} + H -- Non --> I["Identifier l'erreur"] + I --> J["Donner un indice ou une explication"] + J --> E + H -- Oui --> K["Expliquer et valoriser"] + K --> L["Enregistrer les résultats"] + L --> M["Mettre à jour la progression"] + M --> N["Réviser ou poursuivre la mission"] +``` + +## Qui fait quoi + +| Étape | Responsable | Remarque | +|---|---|---| +| Carte du monde, choisir une mission | scène `world_map`, navigation par `GameManager` | | +| Charger les données | `ExerciseEngine` | JSON validé contre le schéma avant usage | +| Afficher la règle et les exemples | `rule_panel` | contenu issu de `data/rules/` | +| Lancer l'exercice, saisir la réponse | `exercise_host` et la scène du type d'exercice | la scène émet la réponse par signal, rien d'autre | +| Valider la réponse, identifier l'erreur | `answer_validator`, `dictation_analyzer` | code pur, renvoie la structure de correction du §6 | +| Indice, explication, valorisation | `feedback_panel` | affiche la structure de correction, ne calcule rien | +| Enregistrer, mettre à jour la progression | `ProgressManager`, puis `SaveManager` | | +| Réviser ou poursuivre | `review_scheduler`, `difficulty_manager` | code pur | + +## Écarts avec le cahier des charges + +Les résolutions ci-dessous sont des propositions. Elles sont à confirmer à l'étape de plan, puis à consigner dans `decisions.md`. + +### 1. La branche « Non » n'enregistre rien + +Dans le diagramme, seul un succès mène à « Enregistrer les résultats ». Or le §9 demande, par compétence, le nombre de tentatives, les erreurs fréquentes et le niveau d'aide utilisé : ces indicateurs ne peuvent pas être calculés si les échecs ne laissent aucune trace. + +Proposition : chaque validation, juste ou fausse, produit un enregistrement de tentative (exercice, règle, résultat, erreurs identifiées, aide utilisée) transmis à `ProgressManager`. L'écriture sur disque reste groupée en fin de mission, conformément au §10. + +### 2. La boucle d'erreur n'a pas de sortie + +« Donner un indice ou une explication » renvoie à « Lancer l'exercice » sans limite. Un enfant qui ne trouve pas reste bloqué sur la même question, ce qui contredit le principe 3 du §2 (ne pas bloquer durablement). + +Proposition : aide graduée, puis sortie. + +1. Première erreur : indice (`hint`), nouvelle tentative. +2. Deuxième erreur : explication de la règle, nouvelle tentative. +3. Troisième erreur : la réponse corrigée est montrée avec son explication, l'exercice se termine sans sanction et la compétence est marquée pour une révision avec d'autres exemples. + +Le nombre de tentatives est un paramètre, pas une constante en dur. diff --git a/prompt-lancement.md b/prompt-lancement.md new file mode 100644 index 0000000..773fd0d --- /dev/null +++ b/prompt-lancement.md @@ -0,0 +1,75 @@ +Tu démarres le développement des « Aventuriers des mots », un jeu éducatif de français pour des enfants de CE1 et CE2 (7–9 ans), en Godot 4 et GDScript typé. Le dépôt ne contient pour l'instant que `CLAUDE.md` et `docs/specs/`. + +Lis d'abord en entier, dans cet ordre : + +1. `CLAUDE.md` : conventions et invariants du projet. +2. `docs/specs/cahier-des-charges.md` : la spécification. Elle fait foi. +3. `docs/specs/exercise-lifecycle.md` : le cycle de vie d'un exercice et deux écarts à trancher. + +## Objectif + +Livrer la première version jouable décrite au §15 du cahier des charges. Elle existe pour valider l'architecture avant de produire le reste du contenu : un moteur d'exercices piloté par des données JSON, une correction explicative, une progression par compétence avec révisions, et des sauvegardes par profil. + +Tout ce qui sort du §15 est hors périmètre : autres régions, autres types d'exercices, macOS, Android, iOS, espace adulte, éléments cosmétiques. Ne l'implémente pas, mais ne ferme aucune porte : une nouvelle région ne doit demander que des données, un nouveau type d'exercice qu'une scène et un validateur de plus. + +## Étape 0 : plan, puis arrêt + +N'écris aucun code avant que j'aie validé le plan. Inspecte l'environnement (`godot --version`, outils présents), puis propose-moi dans un message court : + +1. La version stable de Godot 4 retenue et la façon de la figer. Si Godot n'est pas installé, dis-le avant d'installer quoi que ce soit. +2. L'outillage : cadre de tests headless, lint et formatage GDScript compatibles avec l'indentation à 4 espaces. +3. Les schémas JSON : règle, exercice (un format de réponse par type), dictée (modèle distinct, §8), curriculum, sauvegarde. Précise l'interaction retenue pour la correction de phrase : retaper la phrase, ou toucher le mot fautif puis le corriger. +4. La structure renvoyée par le moteur de correction (§6). +5. Les règles de passage entre les cinq états de maîtrise (§9) et les délais de révision, avec des seuils chiffrés. +6. Les règles de tolérance des dictées (§5) : accents, apostrophes, majuscules, ponctuation, espaces, variantes admises. +7. Ta position sur les deux écarts signalés dans `exercise-lifecycle.md`. +8. La solution pour l'audio provisoire des dictées. +9. Les écarts que tu proposes par rapport à l'arborescence du §7. +10. Les questions restées ouvertes, dont la licence du projet. + +Une fois le plan validé, consigne les décisions dans `docs/specs/decisions.md`. + +## Ordre de construction + +La logique passe avant l'interface : une correction fausse ou une progression incohérente ne se voit pas à l'écran, alors qu'un test la détecte. Chaque étape se termine par `make check` au vert et un commit. + +1. Squelette : projet Godot, `Makefile`, lint, tests, `.editorconfig`, `.gitignore`, `.gitattributes`, `README.md` et `README-EN.md`. +2. Données : schémas, validateur, `make validate-data`, premier contenu. +3. Logique pure, avec ses tests : validation des réponses, analyse des dictées, difficulté, planification des révisions. +4. Profils et sauvegardes. +5. Scènes : démarrage, sélection et création de profil, carte à trois lieux, introduction de mission, panneau de règle, hôte d'exercice et les trois types (choix multiple, correction de phrase, dictée), panneau de retour, écran de récompense, personnage guide. +6. Exports Linux et Windows. + +Après l'étape 0, avance sans attendre mon accord entre les étapes. Arrête-toi seulement si la spécification se contredit ou si une décision engage le format des données ou des sauvegardes. + +## Points durs + +**Analyse des dictées.** C'est le composant le plus risqué. Aligne la production de l'enfant sur le texte cible mot par mot avant de comparer les caractères, sinon un mot oublié décale tout et chaque mot suivant devient une erreur. Normalise avant de comparer (formes Unicode composées et décomposées, apostrophe droite et typographique, espaces insécables, œ) : vérifie ce que GDScript offre réellement pour cela et, à défaut, utilise une table explicite pour les caractères français. La distinction entre erreur lexicale et erreur grammaticale vient des annotations du texte cible dans les données (quel mot évalue quelle règle), pas d'une analyse linguistique devinée à l'exécution. Sans annotation, l'erreur reste non classée. + +**Maîtrise.** Une compétence ne devient « acquise » qu'après des réussites sur plusieurs séances et dans plusieurs formats d'exercice (§9). Une révision tire un autre exercice de la même règle, jamais celui qui vient d'être raté. L'horloge d'un appareil familial n'est pas fiable : ne fais pas reposer la progression sur elle seule, et compte aussi les séances. + +**Sauvegardes.** Teste les cas de panne, pas seulement le cas nominal : fichier temporaire tronqué, fichier principal corrompu avec retour à la copie de secours, version de schéma plus ancienne à migrer, deux profils qui ne se mélangent pas. + +**Sens de l'aventure.** Le jeu ne doit pas être un questionnaire habillé d'un décor. Chaque lieu de la carte porte une mission avec un court contexte narratif, issu des données, qui justifie les exercices. + +## Contenu pédagogique + +Tu rédiges le contenu, je le valide. Il est entièrement original et porte `"review_status": "draft"`. + +- CE1, accords dans le groupe nominal : trois règles (pluriel du nom, accord du déterminant, accord de l'adjectif). +- CE2, homophones grammaticaux : a/à, et/est, son/sont, on/ont, chacun avec son test de substitution. +- Par règle, au moins 8 choix multiples et 4 corrections de phrase, répartis sur les niveaux de difficulté. Par chapitre, 3 dictées courtes. Ce volume est le minimum pour que les révisions puissent varier les exemples. + +Écris pour un enfant de 7 à 9 ans : phrases courtes, vocabulaire courant, une seule réponse juste possible. Relis chaque exercice en te demandant si une autre réponse serait défendable. Si oui, reformule la phrase ou déclare la variante dans les données. + +Comme du JSON se relit mal, génère `docs/review/content-review.md` à partir des données : pour chaque règle, son énoncé, puis chaque exercice avec sa réponse attendue, son indice et son explication. C'est ce document que je validerai. + +## Graphismes et audio provisoires + +Tout est provisoire et créé par toi : formes simples, pas d'asset tiers sans licence libre compatible, chaque source notée dans `assets/CREDITS.md`. La cible reste des voix préenregistrées (§16) : l'audio provisoire doit fonctionner hors ligne à l'exécution, être identifiable comme provisoire et se remplacer fichier par fichier sans toucher au code. + +## Vérification et compte rendu + +Les tests headless couvrent la correction, la progression et les sauvegardes, avec un corpus linguistique pour les pluriels, les accords, les homophones et les accents (§12). Pour ce que tu ne peux pas observer (rendu, animations, audio, tactile), écris `docs/testing/manual-checklist.md` avec les manipulations à faire. + +À la fin de chaque étape, indique en quelques lignes ce qui est fait, ce que les tests couvrent, ce qui n'a pas été vérifié et pourquoi, et les décisions prises sans moi. Si un export ne peut pas être produit ou lancé dans ton environnement, dis-le tel quel.