aboutsummaryrefslogtreecommitdiff
path: root/documentation_fr.md
diff options
context:
space:
mode:
Diffstat (limited to 'documentation_fr.md')
-rw-r--r--documentation_fr.md113
1 files changed, 78 insertions, 35 deletions
diff --git a/documentation_fr.md b/documentation_fr.md
index 260f088..c5298a5 100644
--- a/documentation_fr.md
+++ b/documentation_fr.md
@@ -80,16 +80,16 @@ Cette section sert à décrire l'affichage à l'écran des touches : couleur et
80 - STOP ! 80 - STOP !
81 color: [255, 0, 0] 81 color: [255, 0, 0]
82 82
83La touche échap est de couleur rouge, et le texte "STOP !" est affiché sur la deuxième ligne 83La touche échap est de couleur rouge, et le texte "STOP !" est affiché sur la deuxième ligne.
84 84
85#### Liste des options possibles 85#### Liste des options possibles
86- `description` : le texte qui s'affiche, à côté du "nom" de la touche. Il faut mettre un tirer pour une ligne de texte (pas de retour à la ligne automatique). La première ligne correspond à celle de la lettre associée à la touche, aussi il n'est pas absurde de la laisser vide (voir l'exemple ci-dessus). Sur un écran de taille raisonnable, on peut compter 3 lignes (incluant la première) pour une touche "standard". 86- `description` : le texte qui s'affiche, à côté du "nom" de la touche. Il faut mettre un tiret pour une ligne de texte (pas de retour à la ligne automatique). La première ligne correspond à celle de la lettre associée à la touche, aussi il vaut mieux souvent la laisser vide, ou ne mettre que très peu de texte (voir l'exemple ci-dessus). Sur un écran de taille raisonnable, on peut compter 3 lignes (incluant la première) pour une touche "standard".
87- `color: [r,g,b]` : la couleur de la touche. r, g et b sont les proportions de rouge, vert et bleu, et doivent être des entiers entre 0 et 255. 87- `color: [r, g, b]` : la couleur de la touche. r, g et b sont les proportions de rouge, vert et bleu, et doivent être des entiers entre 0 et 255.
88 88
89 89
90### `keys` : actions sur les touches 90### `keys` : actions sur les touches
91 91
92Cette section sert à décrire, pour chaque touche, la liste des actions successives. Notez qu'à l'exception de `wait` (voir plus bas), les actions sont exécutées les unes à la suite des autres, sans attendre que la précédente soit terminée. 92Cette section sert à décrire, pour chaque touche, la liste des actions successives. Notez que la plupart des commandes (hors `wait` et quelques cas particuliers, voir plus bas), les actions sont exécutées les unes à la suite des autres, sans attendre que la précédente soit terminée.
93 93
94 94
95#### Exemples 95#### Exemples
@@ -103,53 +103,53 @@ Cette section sert à décrire, pour chaque touche, la liste des actions success
103 duration: 5 103 duration: 5
104 - stop: 104 - stop:
105 file: "music1.mp3" 105 file: "music1.mp3"
106 fade_out 2 106 fade_out: 2
107 107
108Lance la musique "music1.mp3" à 70% de son volume max, puis au bout de 5 secondes coupe la musique avec un fondu de 2 secondes. 108Lance la musique "music1.mp3" à 70% de son volume max, puis au bout de 5 secondes coupe la musique avec un fondu de 2 secondes.
109 109
110 :::yaml 110 :::yaml
111 'b': 111 'b':
112 - stop: 112 - stop:
113 file "music1.mp3" 113 file: "music1.mp3"
114 fade_out 5 114 fade_out: 5
115 wait: false 115 wait: false
116 - play: 116 - play:
117 file "music2.mp3" 117 file: "music2.mp3"
118 fade_in 5 118 fade_in: 5
119 119
120Effectue un fondu enchaîné de 5 secondes entre "music1.mp3" et "music2.mp3" 120Effectue un fondu enchaîné de 5 secondes entre "music1.mp3" et "music2.mp3"
121 121
122 :::yaml 122 :::yaml
123 'c': 123 'c':
124 - stop: 124 - stop:
125 file "music1.mp3" 125 file: "music1.mp3"
126 fade_out 5 126 fade_out: 5
127 wait: true 127 wait: true
128 - wait: 128 - wait:
129 duration: 2 129 duration: 2
130 - play: 130 - play:
131 file "music2.mp3" 131 file: "music2.mp3"
132 - seek: 132 - seek:
133 file "music2.mp3" 133 file: "music2.mp3"
134 delta: false 134 delta: false
135 value: 60 135 value: 60
136Coupe la musique "music1.mp3" avec un fondu de 5 secondes, attend la fin du fondu, puis attend deux secondes et lance la musique "music2.mp3", au temps d'une minute. 136Coupe la musique "music1.mp3" avec un fondu de 5 secondes, attend la fin du fondu, puis attend encore deux secondes et lance la musique "music2.mp3", au temps d'une minute.
137 137
138 :::yaml 138 :::yaml
139 'd': 139 'd':
140 - volume: 140 - volume:
141 file "music1.mp3" 141 file: "music1.mp3"
142 value: 50 142 value: 50
143 - play: 143 - play:
144 file "noise.mp3" 144 file: "noise.mp3"
145 loop: 1 145 loop: 1
146 - wait: 146 - wait:
147 duration 2 147 file: "noise.mp3"
148 - volume: 148 - volume:
149 file "music1.mp3" 149 file: "music1.mp3"
150 value: 100 150 value: 100
151 151
152Baisse temporairement (pour 2 secondes) le volume de "music1.mp3" pendant que le son "noise.mp3" est joué par dessus (joué deux fois). 152Baisse le volume de "music1.mp3" pendant que le son "noise.mp3" est joué par dessus (deux fois). Le volume revient à la normale une fois que le son "noise" est terminé.
153 153
154 :::yaml 154 :::yaml
155 'e': 155 'e':
@@ -169,35 +169,78 @@ Met en pause la musique "music1.mp3" pour 10 secondes et la relance après, en a
169#### Liste des actions possibles: 169#### Liste des actions possibles:
170- `play` : joue une musique. Paramètres : 170- `play` : joue une musique. Paramètres :
171 * `file: "music.mp3"` précise la musique jouée (chemin relatif). 171 * `file: "music.mp3"` précise la musique jouée (chemin relatif).
172 * `fade_in x` (facultatif) lance la musique avec un fade in de x secondes. 172 * `fade_in: x` (facultatif) lance la musique avec un fondu au départ de x secondes.
173 * `volume x` (facultatif) la musique doit être jouée à x% de son volume max (x doit être entre 0 et 100, 100 par défaut) 173 * `volume: x` (facultatif, défaut : 100) la musique doit être jouée à x% de son volume max (x doit être entre 0 et 100). Pour jouer une musique à plus de 100%, voir la section "file: properties".
174 * `loop: x` (facultatif) la musique doit être répétée x fois. Indiquer -1 pour la répéter indéfiniment. Attention, x est le nombre de répétitions, donc pour lire trois fois la musique, mettre `loop: 2` 174 * `loop: x` (facultatif, défaut : 0) la musique doit être répétée x fois. Indiquer -1 pour la répéter indéfiniment. Attention, x est le nombre de répétitions, donc pour lire trois fois la musique, mettre `loop: 2`.
175- `stop` : arrête une musique donnée. Paramètres : 175- `stop` : arrête une musique donnée. Paramètres :
176 * `file: "music.mp3"` (facultatif) précise la musique à stopper. Si aucune musique n'est précisée, le `stop` s'applique à toutes les musiques. 176 * `file: "music.mp3"` (facultatif) précise la musique à stopper. Si aucune musique n'est précisée, le `stop` s'applique à toutes les musiques.
177 * `fade_out x` (facultatif) stoppe la musique avec un fondu de x secondes. 177 * `fade_out: x` (facultatif) stoppe la musique avec un fondu de x secondes.
178 * `wait: true/false` (par défaut : false) dans le cas d'un fondu, attendre la durée du fondu pour faire les actions suivantes. Si la musique s'arrêtait naturellement avant la fin du fondu, l'attente se termine lorsque la musique se termine naturellement. FIXME 178 * `wait: true/false` (facultatif, par défaut : false) dans le cas d'un fondu, attendre la durée du fondu pour faire les actions suivantes. Si la musique s'arrêtait naturellement avant la fin du fondu, l'attente se termine lorsque la musique se termine naturellement. FIXME
179- `volume` : change le volume d'une musique donnée. Paramètres : 179- `volume` : change le volume d'une musique donnée. Paramètres :
180 * `file: "music.mp3"` précise la musique. Si aucune musique n'est précisée, la modification s'applique au volume global. 180 * `file: "music.mp3"` (facultatif) précise la musique. Si aucune musique n'est précisée, la modification s'applique au volume global.
181 * `delta: true/false` le volume doit il être précisé en absolu (false, option par défaut), ou en relatif (true), voir plus bas. 181 * `delta: true/false` (facultatif, par défaut : false) le volume doit il être précisé en absolu (false), ou en relatif (true), voir plus bas.
182 * `value: x` Si delta est à false, met le volume à x% du volume max (x doit être entre 0 et 100). 182 * `value: x` Si delta est à false, met le volume à x% du volume max (x doit être entre 0 et 100).
183Ce facteur est appliqué à la musique déjà chargée en mémoire (voir section "propriétés"), donc le 100% fait référence au volume de chargement. 183Ce facteur est appliqué à la musique déjà chargée en mémoire (voir section "propriétés"), donc le 100% fait référence au volume de chargement.
184Si delta est à true, applique un modificateur de x% au volume (x doit être un entier signé). 184Si delta est à true, applique un modificateur de x% au volume (x doit être un entier signé).
185Notez qu'une action "+10%" relative ne correspond pas à un pourcentage du volume actuel, mais du volume "de référence" 100%. Ainsi, effectuer +10% et -10% en relatif revient bien à 100%.
186 * `fade: x` (facultatif) le changement de volume est appliqué en fondu sur x secondes. Il n'y a pas d'attente de la fin du fondu pour lancer les actions suivantes : au besoin, rajouter un `wait` à la main.
185- `pause` : met en pause une musique. Paramètres : 187- `pause` : met en pause une musique. Paramètres :
186 * `file: "music.mp3"` précise la musique à mettre en pause. 188 * `file: "music.mp3"` (facultatif) précise la musique à mettre en pause. Si non précisé, s'applique à toutes les musiques.
187- `unpause` : relance une musique mise en pause (là où elle en était). Paramètres : 189- `unpause` : relance une musique mise en pause (là où elle en était). Paramètres :
188 * `file: "music.mp3"` précise la musique à relancer. 190 * `file: "music.mp3"` (facultatif) précise la musique à relancer. Si non précisé, s'applique à toutes les musiques.
189- `wait` : attend un temps donné. Paramètres : 191- `wait` : attend un temps donné. Paramètres :
190 * `duration: x` attend x secondes 192 * `file: "music.mp3"` (facultatif) attend la fin de la musique "music.mp3"
191Notez une fois enore que `wait` est la seule action qui attend d'avoir terminé pour lancer la commane suivante, toutes les autres sont lancées successivement mais sans attendre (donc quasiment simultanément). 193 * `duration: x` (facultatif) attend x secondes. Si `file` et `duration` sont précisés, l'attente dure jusqu'à la fin de la musique PUIS la durée donnée par `duration`.
194Notez une fois enore que `wait` est quasiment la seule action qui attend d'avoir terminé pour lancer la commane suivante, toutes les autres sont lancées successivement mais sans attendre (donc presque simultanément) : ne pas hésiter à rajouter des commandes d'attente partout où c'est nécessaire.
192- `seek` : permet d'aller à un endroit précis dans une musique. Paramètres : 195- `seek` : permet d'aller à un endroit précis dans une musique. Paramètres :
193 * `file: "music.mp3"` précise la musique. Si aucune musique n'est précisée, l'action s'applique à toutes les musiques. 196 * `file: "music.mp3"` (facultatif) précise la musique. Si aucune musique n'est précisée, l'action s'applique à toutes les musiques.
194 * `delta: true/false` Si delta est true, le temps est relatif. Si delta est false (par défaut ?), le temps est absolu, voir plus bas. 197 * `delta: true/false` (facultatif, défaut : false) Si delta est true, le temps est relatif. Si delta est false, le temps est absolu, voir plus bas.
195 * `value: x` Si delta est true, alors fait avancer de x secondes dans la musique (reculer si x est négatif). Si delta est false, alors la lecture se place à x secondes du début. Si la musique est en train de faire un fondu au départ, le fondu est oublié et la musique est jouée au volume normal. Si la musique est en train de se terminer en fondu, le "seek" est ignoré. 198 * `value: x` Si delta est true, alors fait avancer de x secondes dans la musique (reculer si x est négatif). Si delta est false, alors la lecture se place à x secondes à partir du début. Si la musique est en train de faire un fondu (au départ, ou changement de volume), le fondu se "termine automatiquement" : et la musique est immédiatement au volume final voulu. Si la musique est en train de se terminer en fondu, le "seek" est ignoré (un fondu de fin considère la musique comme déjà terminée).
199 * `stop_all_actions:` Interrompt toutes les actions en cours et à faire.
196 200
197### `aliases` : définir des alias 201### `aliases` : définir des alias
198 202
199Il est possible de définir des alias pour les différents objets du fichier yml. 203Il est possible de définir des alias pour les différents paramètres. Ces alias sont internes au fichier de configuration, pour afficher un "joli" nom d'une musique, voir plutôt "file: properties".
204
200 205
201#### Exemples 206#### Exemples
202 207
203`` 208 :::yaml
209 aliases:
210 music1:
211 file: "path/to/my/favourite/music.mp3"
212
213 keys:
214 'a':
215 play:
216 include: music1
217
218`music1` est désormais un alias pour `"path/to/my/favourite/music.mp3"`. À chaque fois qu'on veut écrire `file: "path/to/my/favourite/music.mp3"`, on peut écrire à la place `include: music1`. Attention, dans la section "file_properties", les alias ne fonctionnent pas, et il faut écrire le nom du fichier complet.
219
220 :::yaml
221 aliases:
222 blue:
223 color: [0, 0, 255]
224
225 keys_properties:
226 'a':
227 description:
228 -
229 - blue key
230 include: blue
231
232`blue` est un alias pour la couleur `[0, 0, 255]`. À chaque fois qu'on veut écrire `color: [0, 0, 255]`, on peut écrire `include: blue` à la place.
233
234 :::yaml
235 aliases:
236 long_time:
237 duration: 42
238
239 keys:
240 'b':
241 wait:
242 include: long_time
243 play:
244 file: "music1.mp3"
245
246`long_time` est un alias pour la durée 42 secondes. Au lieu d'écrire `duration: 42`, on peut écrire `include: long_time`.