docs: ajouter dossiers et fichiers d'exemple transverses

2026-02-13 15:57:18 +01:00
parent 112cbe909b
commit 53b38ed19f
7 changed files with 94 additions and 1 deletions
@@ -67,3 +67,7 @@ Voir `CONTRIBUTING.md`.
 Voir `CHANGELOG.md`.
 ## Mainteneur
 L’électron rare
+
+
+## Exemples transverses
+- Index exemples: `examples/README.md`
@@ -0,0 +1,7 @@
+# Exemples du dépôt
+
+Ce dossier centralise des **points d'entrée d'exemples** pour démarrer rapidement.
+
+- Kit MJ: `../kit-maitre-du-jeu/exemples/`
+- Printables: `../printables/src/exemples/` et `../printables/export/pdf/exemples/`
+- Firmware ESP32 STORY V2: `../hardware/firmware/esp32/story_specs/scenarios/`
@@ -25,13 +25,14 @@ Crée un nouveau fichier dans `story_specs/scenarios/`, par exemple:
 Exemple prêt à l'emploi dans le repo:

 - `story_specs/scenarios/example_unlock_express.yaml`
+- `story_specs/scenarios/example_unlock_express_done.yaml`

 ## 2) Définir la structure minimale

 Dans le YAML, renseigne au minimum:

 - `id` (identifiant unique)
- `version: 1`
+- `version` (utiliser la version supportée par le générateur; dans ce repo les exemples sont en `2`)
 - `initial_step`
 - `app_bindings`
 - `steps`
@@ -0,0 +1,50 @@
+id: EXEMPLE_UNLOCK_EXPRESS_DONE
+version: 2
+initial_step: STEP_WAIT_UNLOCK
+
+app_bindings:
+  - id: APP_LA
+    app: LA_DETECTOR
+  - id: APP_AUDIO
+    app: AUDIO_PACK
+  - id: APP_SCREEN
+    app: SCREEN_SCENE
+  - id: APP_GATE
+    app: MP3_GATE
+
+steps:
+  - step_id: STEP_WAIT_UNLOCK
+    screen_scene_id: SCENE_LOCKED
+    audio_pack_id: ""
+    actions: [ACTION_TRACE_STEP]
+    apps: [APP_LA, APP_SCREEN, APP_GATE]
+    mp3_gate_open: false
+    transitions:
+      - trigger: on_event
+        event_type: unlock
+        event_name: UNLOCK
+        target_step_id: STEP_WIN
+        after_ms: 0
+        priority: 100
+
+  - step_id: STEP_WIN
+    screen_scene_id: SCENE_REWARD
+    audio_pack_id: PACK_WIN
+    actions: [ACTION_TRACE_STEP]
+    apps: [APP_AUDIO, APP_SCREEN, APP_GATE]
+    mp3_gate_open: false
+    transitions:
+      - trigger: on_event
+        event_type: audio_done
+        event_name: AUDIO_DONE
+        target_step_id: STEP_DONE
+        after_ms: 0
+        priority: 100
+
+  - step_id: STEP_DONE
+    screen_scene_id: SCENE_READY
+    audio_pack_id: ""
+    actions: [ACTION_TRACE_STEP, ACTION_REFRESH_SD]
+    apps: [APP_SCREEN, APP_GATE]
+    mp3_gate_open: true
+    transitions: []
@@ -0,0 +1,13 @@
+# Exemple — scénario express (45–60 min)
+
+- Mystère: sabotage d'un module radio.
+- Coupable: Dr Sacha Néon.
+- Mobile: cacher une erreur de calibration.
+- Méthode: faux message de maintenance + déplacement d'un composant.
+
+Indices (exemple):
+1. journal de labo annoté,
+2. badge d'accès horodaté,
+3. schéma de câblage modifié,
+4. témoignage contradictoire,
+5. relevé de fréquence signé.
@@ -0,0 +1,8 @@
+# Exemples de livrables PDF
+
+Exemples de noms de PDF prêts à imprimer:
+
+- `invite-a6-recto-v1.pdf`
+- `invite-a6-verso-v1.pdf`
+- `carte-indice-a6-v2.pdf`
+- `regles-1-page-a4-v1.pdf`
@@ -0,0 +1,10 @@
+# Exemples de sources éditables
+
+Exemples de noms de fichiers source:
+
+- `regles-1-page-a4-v1.svg`
+- `carte-personnage-dr-neon-a6-v1.svg`
+- `fiche-enquete-acte-1-a4-v1.odg`
+- `badge-detective-a7-v1.svg`
+
+But: servir de modèle de nommage/versionnage.