]> git.immae.eu Git - perso/Immae/Projets/Python/MusicSampler.git/blobdiff - documentation_fr.md
Change code blocs to indent
[perso/Immae/Projets/Python/MusicSampler.git] / documentation_fr.md
index 83b50c6bdd15b7c99f6bae128887ce0d533c3d4d..ef3896bf7583fa3c835d6f2e5af69d6cceef4c44 100644 (file)
@@ -10,9 +10,7 @@ Music Sampler permet de pré-programmer des transitions musicales, qui peuvent e
 
 Il faut avoir ffmpeg d'installé. Pour cela, il faut installer le paquet `libav-tools` :
 
-```
-sudo apt-get install libav-tools
-```
+    sudo apt-get install libav-tools
 
 Si vous utilisez la version compilée de Music Sampler, il n'y a pas d'installation nécessaire.
 
@@ -30,21 +28,18 @@ Le fichier config.yml utilise la syntaxe yaml. Les catégories et sous-catégori
 le `#` est un symbole de commentaire : tout ce qui suit ce symbole sur une ligne est ignoré.
 
 Le fichier contient plusieurs sections :
-```
-aliases:
-...
 
-music_properties:
-...
+    aliases:
+      ...
 
+    music_properties:
+      ...
 
-key_properties:
-...
+    key_properties:
+      ...
 
-
-keys:
-...
-```
+    keys:
+      ...
 
 
 ### `music_properties` : propriétés des musiques
@@ -53,17 +48,14 @@ Cette section sert à définir des propriétés globales des musiques.
 
 #### Exemples
 
-```
-  "music1.mp3":
-    name: My favorite music
-    gain: 1.4
-```
+      "music1.mp3":
+        name: My favorite music
+        gain: 1.4
 La musique "music1.mp3" est désignée par le nom "My favorite music". Elle est chargée à 140% de son volume normal.
 
-```
-  "music2.mp3":
-    gain: 0.7
-```
+      "music2.mp3":
+        gain: 0.7
+
 La musique "music2.mp3" est chargée à 70% de son volume normal.
 
 #### Liste des options possibles
@@ -76,13 +68,12 @@ Cette section sert à décrire l'affichage à l'écran des touches : couleur et
 
 #### Exemples
 
-```
-  'ESC':
-    description:
-      - 
-      - STOP !
-    color: [255, 0, 0]
-```
+      'ESC':
+        description:
+          - 
+          - STOP !
+        color: [255, 0, 0]
+
 La touche échap est de couleur rouge, et le texte "STOP !" est affiché sur la deuxième ligne
 
 #### Liste des options possibles
@@ -97,77 +88,70 @@ Cette section sert à décrire, pour chaque touche, la liste des actions success
 
 #### Exemples
 
-```
-'a':
-  - play: 
-      file: "music1.mp3"
-      volume: 70
-  - wait:
-      duration: 5
-  - stop:
-      file: "music1.mp3"
-      fade_out 2
-```
+    'a':
+      - play: 
+          file: "music1.mp3"
+          volume: 70
+      - wait:
+          duration: 5
+      - stop:
+          file: "music1.mp3"
+          fade_out 2
 Lance la musique "music1.mp3" à 70% de son volume max, puis au bout de 5 secondes coupe la musique avec un fondu de 2 secondes.
 
-```
-'b':
-  - stop: 
-      file "music1.mp3"
-      fade_out 5
-      wait: false
-  - play:
-      file "music2.mp3"
-      fade_in 5
-```
+    'b':
+      - stop: 
+          file "music1.mp3"
+          fade_out 5
+          wait: false
+      - play:
+          file "music2.mp3"
+          fade_in 5
+
 Effectue un fondu enchaîné de 5 secondes entre "music1.mp3" et "music2.mp3"
 
-```
-'c':
-  - stop: 
-      file "music1.mp3"
-      fade_out 5
-      wait: true
-  - wait:
-      duration: 2
-  - play:
-      file "music2.mp3"
-  - seek:
-      file "music2.mp3"
-      delta: false
-      value: 60
-```
+    'c':
+      - stop: 
+          file "music1.mp3"
+          fade_out 5
+          wait: true
+      - wait:
+          duration: 2
+      - play:
+          file "music2.mp3"
+      - seek:
+          file "music2.mp3"
+          delta: false
+          value: 60
 Coupe 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.
 
-```
-'d':
-  - volume: 
-      file "music1.mp3"
-      value: 50
-  - play:
-      file "noise.mp3"
-      loop: 1
-  - wait:
-      duration 2
-  - volume:
-      file "music1.mp3"
-      value: 100
-```
+    'd':
+      - volume: 
+          file "music1.mp3"
+          value: 50
+      - play:
+          file "noise.mp3"
+          loop: 1
+      - wait:
+          duration 2
+      - volume:
+          file "music1.mp3"
+          value: 100
+
 Baisse temporairement (pour 2 secondes) le volume de "music1.mp3" pendant que le son "noise.mp3" est joué par dessus (joué deux fois).
 
-```
-'e':
-  - pause:
-      file: "music1.mp3"
-  - wait: 
-      duration: 10
-  - unpause:
-      file: "music1.mp3"
-  - seek:
-      file: "music1.mp3"
-      delta: true
-      value: 5
-```
+    'e':
+      - pause:
+          file: "music1.mp3"
+      - wait: 
+          duration: 10
+      - unpause:
+          file: "music1.mp3"
+      - seek:
+          file: "music1.mp3"
+          delta: true
+          value: 5
+
 Met en pause la musique "music1.mp3" pour 10 secondes et la relance après, en avançant de 5 secondes dans la musique.
 
 #### Liste des actions possibles: