Add example config.yml

1 files changed, 309 insertions, 345 deletions

diff --git a/config.yml b/config.yml
index c6efff3..e543b04 100644
--- a/config.yml
+++ b/config.yml
@@ -1,430 +1,394 @@
+###################
+##### Aliases #####
+
 aliases:
-  intro_jonglacro:
-    file: "PIRATE_01-1-intro_jonglacro.mp3"
-  jonglacro_suite:
-    file: "PIRATE_01-2-jonglacro_suite.mp3"
-  lancer_prisonniere:
-    file: "PIRATE_02-lancers_de_prisonniere.mp3"
-  quete:
-    file: "PIRATE_03-1-quete.mp3"
-  monstre:
-    file: "PIRATE_03-2-monstre.mp3"
-  entree_ondine:
-    file: "PIRATE_04-entree_ondine.mp3"
-  cour_ondine:
-    file: "PIRATE_05-cour_a_londine.mp3"
-  fouille_jonglage:
-    file: "PIRATE_07-fouille_jonglage.mp3"
-    gain: 0.9
-  liberation_prisonniere:
-    file: "PIRATE_08-1-liberation_prisonniere.mp3"
-  paf:
-    file: "PIRATE_08-2-paf_tombe.mp3"
-  duo_pirate_ondine:
-    file: "PIRATE_09-duo_pirate_ondine.mp3"
-    gain: 115
-  trio_jalousie:
-    file: "PIRATE_10-1-trios_jalousie.mp3"
-  coup:
-    file: "PIRATE_10-2-coup.mp3"
-  piquage_2_4:
-    file: "PIRATE_11-piquage_2_4.mp3"
-    gain: 110
-  baston:
-    file: "PIRATE_12-1-baston.mp3"
-  baston_ascension:
-    file: "PIRATE_12-3-baston_ascension.mp3"
-  ralenti:
-    file: "PIRATE_12-2-ralenti.mp3"
-  saluts:
-    file: "PIRATE_13-saluts.mp3"
-  wait_fade:
-    duration: 0.6
-  couleur_chloe:
-    color: [73, 221, 226]
-  couleur_denise:
+# for files
+  music1:
+    file: "short_blues.mp3"
+  music2:
+    file: "to_the_Fantasy_war.mp3"
+  noise:
+    file: "croco.mp3"
+# aliases for colors
+  blue:
+    color: [50, 50, 255]
+  orange:
+    color: [255, 126, 0]
+  yellow: 
+    color: [250, 250, 0]
+  red:
+    color: [255, 20, 20]
+  light_blue:
+    color: [100, 150, 255]
+  green:
+    color: [50, 180, 50]
+  light_green:
+    color: [150, 255, 100]
+  purple:
     color: [190, 110, 236]
-  couleur_jerome:
-    color: [240, 158, 0]
-  couleur_chris:
-    color: [255, 255, 0]
-  couleur_aure:
-    color: [0, 190, 27]
+  pink:
+    color: [255, 50, 255]
 
+####################################################
+##### Music properties: name and general gain ######
 
 music_properties:
-  "PIRATE_01-1-intro_jonglacro.mp3":
-    name: Intro Jonglacro
-  "PIRATE_01-2-jonglacro_suite.mp3":
-    name: Jonglacro suite
-  "PIRATE_02-lancers_de_prisonniere.mp3":
-    name: Lancer prisonnière
-  "PIRATE_03-1-quete.mp3":
-    name: Quête
-    gain: 1.2
-  "PIRATE_03-2-monstre.mp3":
-    name: Monstre
-  "PIRATE_04-entree_ondine.mp3":
-    name: Entrée Ondine
-  "PIRATE_05-cour_a_londine.mp3":
-    name: Cour à l'Ondine
-  "PIRATE_07-fouille_jonglage.mp3":
-    name: Fouille jonglage
-  "PIRATE_08-1-liberation_prisonniere.mp3":
-    name: Libération prisonnière
+  "short_blues.mp3":
+    name: Short Blues (music 1)
+  "to_the_Fantasy_war.mp3":
+    name: To the Fantasy War (music 2)
+  "croco.mp3":
+    name: Crocodile noise
     gain: 1.2
-  "PIRATE_08-2-paf_tombe.mp3":
-    name: Paf tombe
-  "PIRATE_09-duo_pirate_ondine.mp3":
-    name: Duo pirate Ondine
-  "PIRATE_10-1-trios_jalousie.mp3":
-    name: Trio Jalousie
-  "PIRATE_10-2-coup.mp3":
-    name: Coup
-  "PIRATE_11-piquage_2_4.mp3":
-    name: Piquage 2-4
-  "PIRATE_12-1-baston.mp3":
-    name: Baston
-  "PIRATE_12-3-baston_ascension.mp3":
-    name: Baston ascension
-    gain: 1.4
-  "PIRATE_12-2-ralenti.mp3":
-    name: Ralenti
-  "PIRATE_13-saluts.mp3":
-    name: Saluts
-    gain: 0.7
+
+####################################################
+##### Key properties: how do the key look like #####
 
 key_properties:
   'a':
     description:
       -  
-      - Jonglacro
-    include: couleur_chloe
+      - Music 1
+    include: light_blue
   'z':
     description:
-      -  #Chloé
-      - Jonglacro
-      - 2
-    include: couleur_chloe
+      -  
+      - Music 2
+    include: light_blue
   'e':
     description:
-      -   #Chloé
-      - Fin
-      - jonglacro
-    include: couleur_chloe
-  'r':
-    description:
-      -   #Chloé
-      - Lancer 
-      - prisonnière
-    include: couleur_chloe
+      - 
+      - Noise
+    include: light_blue
   't':
     description:
-      -  #Chloé
-      - Fin
-      - lancer
-    include: couleur_chloe
+      - 
+      - Crossfade
+      - music 2
+    include: green
+    repeat_delay: 5
   'y':
     description:
-      -  #Chloé
-      - Quête
-    include: couleur_chloe
+      - 
+      - Stop wait
+      - music 2
+    include: green
   'u':
     description:
-      -  #Chloé
-      - Monstre
-    include: couleur_chloe
-  'i':
-    description:
-      -  #Chloé
-      - Fin quête
-      - Grotte
-    include: couleur_chloe
-  'o':
+      - 
+      - Noise
+      - + Music 2
+    include: green
+
+  'g':
     description:
-      -   #Denise
-      - Fin ondine
-      - Cour ondine
-    include: couleur_denise
-  'p':
+      - 
+      - Music 1
+      - Seek 30/60
+    include: purple
+
+  'i':
     description:
-      -   #Denise
-      - Fin 
-      - Cour ondine
-    include: couleur_denise
-  'q':
+      -
+      - Noise
+      - +low vol
+    include: green
+
+  'h':
     description:
-      -  #Chloé
-      - Fouille 
-      - Jonglage
-    include: couleur_chloe
-  's':
+      -
+      - Noise
+      - 3 times
+    include: purple
+    repeat_delay: 2
+
+  'm':
     description:
-      -   #Denise
-      - Fin
-      - Jonglage
-    include: couleur_denise
-  'd':
+      - 
+      - Musics
+      - 1 & 2
+    include: purple
+
+  'n':
     description:
-      -   #Denise
-      - Libération 
-      - Prisonnière
-    include: couleur_denise
-  'f':
+      -
+      - Low vol
+      - Up vol
+    include: green
+
+  'home':
     description:
-      -   #Denise
-      - Paf
-      - Baisser musique
-    include: couleur_denise
-  'g':
+      - 
+      - vlc
+    include: orange
+
+
+## Some general useful keys
+
+  'ESC':
     description:
-      -   #Denise
-      - Stop 
-      - libération
-    include: couleur_denise
-  'h':
+      - "!"
+      - STOP!
+    include: red
+
+  'F5':
     description:
-      -   #Denise
-      - Duo
-    include: couleur_denise
-  'j':
+      - "||"
+      - PAUSE
+    include: light_green
+
+  'F6':
     description:
-      -   #Jérôme
-      - Trio
-    include: couleur_jerome
-  'k':
+      - ">"
+      - UNPAUSE
+    include: light_green
+
+  'F1':
     description:
       -   
-      - Fin trio
-    include: couleur_jerome
-  'l':
+      - Stop
+      - fade
+    include: orange
+
+  'F2':
     description:
       - 
-      - Jeu à 
-      - 2 et 4
-    include: couleur_jerome
-  'm':
-    description:
-      -  
-      - Fin jeu
-      - Baston
-    include: couleur_chloe
-  'w':
-    description:
-      -  
-      - Fin baston
-      - Ralenti
-    include: couleur_chris
-  'x':
-    description:
-      -  
-      - Fin ralenti
-    include: couleur_chris
-  'c':
-    description:
-      -  
-      - Baston 2
-    include: couleur_chris
-  'v':
+      - Stop
+      - actions
+    include: orange
+
+  'F4':
     description:
-      -  
-      - Fin baston 2
-      - Saluts
-    include: couleur_aure
-  'ESC':
+      -   
+      - Skip
+      - wait
+    include: pink
+
+  'F12':
     description:
       - 
-      - STOP !
-    color: [255, 0, 0]
+      - vol+
+    include: yellow
 
-  'F1':
+  'F11':
     description:
-      -  
-      - PAUSE
+      - 
+      - "vol-"
+    include: yellow
 
-  'F2':
+  'right':
     description:
-      -  
-      - REPRENDRE
+      - 
+      - +10s
+    include: blue
 
-  'F5':
+  'left':
     description:
-      -   
-      - STOP
-      - FADE
+      - 
+      - -10s
+    include: blue
 
+#################################################################
+##### Keys: what do the key actually do when you press them #####
 
 keys:
+# Play the songs
   'a':
-    - stop:
-        fade_out: 0.5
     - play:
-        include: intro_jonglacro
+        include: music1
   'z': 
-    - stop:
-        fade_out: 5
-    - wait:
-        duration: 7
     - play:
-        include: jonglacro_suite
+        include: music2
   'e':
-    - stop:
-        fade_out: 3
-  'r':
-    - stop:
-        fade_out: 0.5
     - play:
-        include: lancer_prisonniere
+        include: noise
+
+# Crossfade from any music to music 2
   't':
     - stop:
-        fade_out: 3
-  'y':
-    - stop:
-        fade_out: 0.5
-    - play:
-        include: quete
-  'u':
-    - volume:
-        include: quete
-        value: 50
-    - play:
-        include: monstre
-    - wait:
-        duration: 2
-    - volume:
-        include: quete
-        value: 100
-  'i':
-    - stop:
         fade_out: 5
-    - wait:
-        duration: 18
     - play:
-        include: entree_ondine
-  'o':
-    - stop:
-        fade_out: 4
-    - wait:
-        duration: 7
-    - play:
-        include: cour_ondine
-  'p':
-    - stop:
-        fade_out: 5
-  'q':
-    - stop:
-        fade_out: 0.5
-    - play:
-        include: fouille_jonglage
-  's':
-    - stop:
-        fade_out: 2
-  'd':
-    - stop:
-        fade_out: 0.5
-    - play:
-        include: liberation_prisonniere
-        fade_in: 1
-  'f':
-    - play:
-        include: paf
-    - wait:
-        duration: 0.25
-    - volume:
-        include: liberation_prisonniere
-        value: 30
+        include: music2
+        fade_in: 5
 
-  'g':
-    - stop:
+# Fade out, then wait and start music 2
+  'y':
+    - stop: 
         fade_out: 3
-  'h':
-    - stop:
-        fade_out: 0.5
-    - play:
-        include: duo_pirate_ondine
-  'j':
-    - stop:
-        fade_out: 2
+        wait: true
+        set_wait_id: y1
     - wait:
-        duration: 1.5
-    - play:
-        include: trio_jalousie
-  'k':
+        duration: 3
+        set_wait_id: y2
+    - play: 
+        include: music2
+
+# Play the noise, stop music 1, wait a bit then start music 2
+  'u':
     - play:
-        include: coup
+        include: noise
     - wait:
-        duration: 0.1
+        duration: 0.2
     - stop:
-        include: trio_jalousie
+        include: music1
+    - wait:
+        duration: 3
+        set_wait_id: u
+    - play: 
+        include: music2
 
-  'l':
-    - stop:
-        fade_out: 0.5
-    - play:
-        include: piquage_2_4
+# Play music 1, starting at 30 seconds then seeks at 60 after 5 seconds
+  'g':
+    - play: 
+        include: music1
+        start_at: 30
+    - wait: 
+        duration: 5
+        set_wait_id: g
+    - seek:
+        include: music1
+        delta: false
+        value: 60
+
+# Play music 1 and 2, after stopping all musics with a fade_out (and wait for this fade out)
   'm':
     - stop:
-        fade_out: 4
-    - wait:
-        duration: 6
+        fade_out: 2
+        wait: true
     - play:
-        include: baston
-  'w':
-    - stop:
-        fade_out: 0.5
+        include: music1
     - wait:
-        duration: 0.5
+        include: music1
+        set_wait_id: m
     - play:
-        include: ralenti
-  'x':
-    - stop:
-        fade_out: 1.5
-  'c':
-    - stop:
-        fade_out: 0.5
-    - play:
-        include: baston_ascension
-  'v':
-    - stop:
-        fade_out: 2
-    - wait:
-        duration: 7
+        include: music2
+
+# Lowers the volume of music 1 and 2 (if playing), during the duration of noise + 1 second
+  'i':
+    - volume:
+        include: music1
+        value: 50
+    - volume:
+        include: music2
+        value: 50
     - play:
-        include: saluts
+        include: noise
     - wait:
-        duration: 5
+        include: noise
+        duration: 1
+        set_wait_id: i
     - volume:
-        include: saluts
-        value: 90
-    - wait:
-        include: wait_fade
+        include: music1
+        value: 100
+        fade: 1
     - volume:
-        include: saluts
-        value: 80
-    - wait:
-        include: wait_fade
+        include: music2
+        value: 100
+        fade: 1
+
+# Lowers the volume of music 1 and 2 (if playing) down to 10% with a 5 seconds fade, then back to 100% 
+  'n' :
     - volume:
-        include: saluts
-        value: 70
+        include: music1
+        value: 10
+        fade: 5
+    - volume:
+        include: music2
+        value: 10
+        fade: 5
     - wait:
-        include: wait_fade
+        duration: 5
+        set_wait_id: n
     - volume:
-        include: saluts
-        value: 60
+        include: music1
+        value: 100
+        fade: 5
+    - volume:
+        include: music2
+        value: 100
+        fade: 5
 
+# Stops all musics, then plays noise repeated twice (3 times)
+  'h':
+    - stop:
+        fade_out: 0.5
+    - play:
+        include: noise
+        loop: 2
+
+  'home':
+    - run_command:
+        command: vlc *.mp3
+        wait: true
 
 
+##### Useful keys (good to have them all the time)
+
+# Emergency stop!
   'ESC':
-    - stop: ~
-    - stop_all_actions: ~
+    - stop_all_actions:
+        other_only: true
+    - stop:
 
-  'F1': 
-    - pause: ~
 
-  'F2':
-    - unpause: ~
 
-  'F5':
+# Pause and unpause
+  'F5': 
+    - pause:
+
+  'F6':
+    - unpause:
+
+# Stopping all musics, with a short fade (sounds natural)
+  'F1':
     - stop:
         fade_out: 1
 
+# Stopping all actions
+  'F2':
+    - stop_all_actions:
+
+# Skip wait
+  'F4':
+    - interrupt_wait:
+        wait_id: n
+    - interrupt_wait:
+        wait_id: m
+    - interrupt_wait:
+        wait_id: i
+    - interrupt_wait:
+        wait_id: y1
+    - interrupt_wait:
+        wait_id: y2
+    - interrupt_wait:
+        wait_id: u
+    - interrupt_wait:
+        wait_id: g
+
+
+# Changing volume
+  'F12':
+    - volume:
+        delta: true
+        value: +10
+        fade: 0.5
+
+  'F11':
+    - volume:
+        delta: true
+        value: -10
+        fade: 0.5
+  
+
+# Seek +- 10 seconds
+  'right':
+    - seek:
+        value: 10
+        delta: true
+
+  'left':
+    - seek:
+        value: -10
+        delta: true
+
+