Merge pull request #170: Issue 155: Implement a Quiz Game

README.md

@@ -41,9 +41,21 @@ Allgemeine Anleitungen zum Einrichten der IDE findet man hier [www.tonuino.de/TN
     - makuna/DFPlayer Mini Mp3 by Makuna: 1.2.3
     - adafruit/Adafruit NeoPixel: 1.11.0 (optional, nur bei Feature NEO_RING notwendig)
 
+## platform.io
 
+- Es werden die gleichen HW Varianten angeboten wie beim Online Upload ohne die Datei constants.hpp editieren zu müssen
 
-## platform.io
+```
+  Classic 
+    3 Buttons
+    5 Buttons
+    3x3 Button Board
+  AiO und AiOplus
+    5 Buttons
+    3x3 Button Board
+```
+
+- wenn man die AiO oder AiOplus mit 3 Buttons hat, muss man in der Datei constants.hpp den Kommentar bei `#define THREEBUTTONS` entfernen. 
 
 **Verwendung zusammen mit Visual Code**
 
@@ -76,23 +88,22 @@ Eine Anleitung dafür findet man [hier](https://discourse.voss.earth/t/tonuino-s
 
 # Installation
 
-Die SD Karte (Ordner mp3 und advert) hat sich gegenüber der Version 3.1.2 geändert. Hier kann man die Dateien downloaden: [tonuino.github.io/TonUINO-TNG/sd-card.zip](https://tonuino.github.io/TonUINO-TNG/sd-card.zip)
+Die SD Karte (Ordner mp3 und advert) hat sich gegenüber der Version 3.1.5 geändert. Hier kann man die Dateien downloaden: [tonuino.github.io/TonUINO-TNG/sd-card.zip](https://tonuino.github.io/TonUINO-TNG/sd-card.zip)
 
 # Change Log
 
+## Version 3.1.6 (31.01.2024)
+- [Issue 155](https://github.com/tonuino/TonUINO-TNG/issues/155): Implement a Quiz Game
+
 ## Version 3.1.5 (30.01.2024)
 - [Issue 166](https://github.com/tonuino/TonUINO-TNG/issues/166): Issue_166: generateRamdomSeed() does not generate a random value
 - [Issue 165](https://github.com/tonuino/TonUINO-TNG/issues/165): 'Play last card' does not work as ShortCut
-
-## Version 3.1.5 (21.01.2024)
 - [Issue 162](https://github.com/tonuino/TonUINO-TNG/issues/162): Prepare optional feature ROTARY_ENCODER for Nano Every
 - [Issue 160](https://github.com/tonuino/TonUINO-TNG/issues/160): Improve the description for platform.io in the Readme
 - [Issue 153](https://github.com/tonuino/TonUINO-TNG/issues/153): Some improvements of the DF Player handling
 - [Issue 149](https://github.com/tonuino/TonUINO-TNG/issues/149): Add possibility to reset the current track on hoerbuch mode
 - [Issue 148](https://github.com/tonuino/TonUINO-TNG/issues/148): New handling of prev and next button on first and last track
 - [Issue 147](https://github.com/tonuino/TonUINO-TNG/issues/147): No or bad saving of current track in hoerbuch mode when using prev, prev10 or next10 button
-
-## Version 3.1.5 (07.12.2023)
 - [Issue 143](https://github.com/tonuino/TonUINO-TNG/issues/143): With some players the start of a track stutters or goes into pause
 - [Issue 142](https://github.com/tonuino/TonUINO-TNG/issues/142): Restart last playback if Play/Pause pressed
 - [Issue 141](https://github.com/tonuino/TonUINO-TNG/issues/141): Enhance Features for Neo Pixel Ring

TonUINO-TNG.ino

@@ -35,7 +35,7 @@ void setup()
   LOG(init_log, s_error, F("TonUINO Version 3.1 - refactored by Boerge1\n"));
   LOG(init_log, s_error, F("created by Thorsten Voß and licensed under GNU/GPL."));
   LOG(init_log, s_error, F("Information and contribution at https://tonuino.de.\n"));
-  LOG(init_log, s_error, F("V3.1.5 30.01.24\n"));
+  LOG(init_log, s_error, F("V3.1.6 31.01.24\n"));
 
   Tonuino::getTonuino().setup();
 }

audio_messages_de.txt

@@ -20,15 +20,33 @@ mp3/0318_special_album.mp3|Spezialmodus Von-Bis, Album: Alle Dateien zwischen de
 mp3/0319_special_party.mp3|Spezialmodus Von-Bis, Party: Alle Dateien zwischen der Start und Enddatei zufällig wiedergeben.
 mp3/0320_mode_audio_book_single.mp3|Hörbuch Modus einzeln: Den nächsten Titel im Ordner wiedergeben und den Fortschritt speichern.
 mp3/0321_mode_repeat_last_card.mp3|Wiederhole Karte Modus: Die letzte Karte oder der letzte Shortcut wird wiederholt.
+mp3/0322_mode_quiz_game.mp3|Quiz Spiel Modus: Spiele ein Quiz.
 mp3/0327_select_file.mp3|OK, wähle nun bitte die Datei mit den Lautstärketasten aus.
 mp3/0328_select_first_file.mp3|OK, wähle nun bitte die Startdatei mit den Lautstärketasten aus.
 mp3/0329_select_last_file.mp3|Wähle nun bitte die Enddatei mit den Lautstärketasten aus.
 mp3/0330.mp3|Soll ich vor einer Datei jeweils die Nummer ansagen? Du kannst jederzeit durch einen langen Druck auf die Pausetaste die aktuelle Nummer abfragen.
 mp3/0331.mp3|Nein, Nummer nicht ansagen.
 mp3/0332.mp3|Ja, Nummer ansagen.
+mp3/0333_num_answer.mp3|Wieviel verschiedene Antworten hat das Quiz für eine Frage.
+mp3/0334_num_answer_2.mp3|2 Antworten.
+mp3/0335_num_answer_4.mp3|4 Antworten.
+mp3/0336_num_answer_2_1.mp3|2 Antworten und eine Lösung.
+mp3/0337_num_answer_4_1.mp3|4 Antworten und eine Lösung.
+mp3/0338_num_answer_0_1.mp3|Nur eine Lösung mit Buzzer.
 mp3/0400_ok.mp3|OK. Ich habe die Karte konfiguriert.
 mp3/0401_error.mp3|Oh weh! Das hat leider nicht geklappt!
 mp3/0402_ok_settings.mp3|Ok, ich habe die Einstellungen gespeichert
+mp3/0500_quiz_game_intro.mp3|Du spielst jetzt ein Quiz. Drücke die Pause Taste, um eine neue Frage zu erhalten. Danach drücke die Vor, Zurück oder die Lautstärke Tasten, um die verschiedenen Antworten zu hören. Wenn du denkst, dass du die richtige Antwort gehört hast, kannst du die Pause Taste drücken um zu erfahren, ob das die richtige Antwort ist. Wiederhole das Ganze so oft du willst. Du kannst das Quiz mit dem langen Druck auf die Vor- und Zurück Taste beenden.
+mp3/0501_quiz_game_ok.mp3|Ja, das ist die richtige Antwort. Gut gemacht. Weiter mit der Pause Taste. 
+mp3/0502_quiz_game_bad.mp3|Oh nein, das ist nicht die richtige Antwort. Versuche die nächste Frage. Weiter mit der Pause Taste. 
+mp3/0503_quiz_game_ok_with_solution.mp3|Ja, das ist die richtige Antwort. Gut gemacht. Hier ist die Erklärung für die Lösung. 
+mp3/0504_quiz_game_bad_with_solution.mp3|Oh nein, das ist nicht die richtige Antwort. Hier ist die Lösung. 
+mp3/0505_quiz_game_buzzer_down.mp3|Spieler zurück war der erste! Wie lautet die Lösung? Spiele dann die Lösung mit der Pause Taste. 
+mp3/0506_quiz_game_buzzer_up.mp3|Spieler vor war der erste! Wie lautet die Lösung? Spiele dann die Lösung mit der Pause Taste. 
+mp3/0507_quiz_game_buzzer_vol-.mp3|Spieler leiser war der erste! Wie lautet die Lösung? Spiele dann die Lösung mit der Pause Taste. 
+mp3/0508_quiz_game_buzzer_vol+.mp3|Spieler lauter war der erste! Wie lautet die Lösung? Spiele dann die Lösung mit der Pause Taste. 
+mp3/0509_quiz_game_buzzer_intro.mp3|Du spielst jetzt ein Quiz mit Buzzer. Drücke die Pause Taste, um eine neue Frage zu erhalten. Danach drückt die Zurück, Vor, Leiser und Lauter Taste als Buzzer. Wenn der schnellste Spieler die Antwort gesagt hat, kannst du die Pause Taste drücken um zu erfahren, ob das die richtige Antwort ist. Wiederhole das Ganze so oft du willst. Du kannst das Quiz mit dem langen Druck auf die Vor- und Zurück Taste beenden.
+mp3/0510_quiz_game_continue.mp3|Weiter mit der Pause Taste. 
 mp3/0800_waiting_for_card.mp3|Bitte lege nun die Karte auf!
 mp3/0801_remove_card.mp3|Bitte die Karte vom Leser entfernen!
 mp3/0802_reset_aborted.mp3|OK, ich habe den Vorgang abgebrochen.

src/chip_card.hpp

@@ -22,6 +22,7 @@ enum class pmode_t: uint8_t {
   party_vb      =   9,
   hoerbuch_1    =  10,
   repeat_last   =  11,
+  quiz_game     =  12,
 
   // modifier modes
   sleep_timer   =   1,

src/constants.hpp

@@ -112,6 +112,11 @@ inline constexpr uint8_t neoPixelNumber  = 24; // Total Number of Pixels
  */
 //#define REPLAY_ON_PLAY_BUTTON
 
+/* uncomment the below line to enable the quiz game
+ * um das Quiz Spile zu aktivieren, in der nächste Zeile den Kommentar entfernen
+ */
+//#define QUIZ_GAME
+
 /* #################################################################################################
  * ##### normally, you don't have to edit lines below                   ############################
  * ##### mormalerweise müssen die folgende Zeilen nicht editiert werden ############################

src/mp3.hpp

@@ -52,15 +52,33 @@ enum class mp3Tracks: uint16_t {
   t_319_special_party          = 319,
   t_320_mode_audio_book_single = 320,
   t_321_mode_repeat_last_card  = 321,
+  t_322_mode_quiz_game         = 322,
   t_327_select_file            = 327,
   t_328_select_first_file      = 328,
   t_329_select_last_file       = 329,
   t_330_select_say_number      = 330,
   t_331_do_not_say_number      = 331,
   t_332_say_number             = 332,
+  t_333_num_answer             = 333,
+  t_334_num_answer_2           = 334,
+  t_335_num_answer_4           = 335,
+  t_336_num_answer_2_1         = 336,
+  t_337_num_answer_4_1         = 337,
+  t_338_num_answer_0_1         = 338,
   t_400_ok                     = 400,
   t_401_error                  = 401,
   t_402_ok_settings            = 402,
+  t_500_quiz_game_intro        = 500,
+  t_501_quiz_game_ok           = 501,
+  t_502_quiz_game_bad          = 502,
+  t_503_quiz_game_ok_with_sol  = 503,
+  t_504_quiz_game_bad_with_sol = 504,
+  t_505_quiz_game_buzzer_down  = 505,
+  t_506_quiz_game_buzzer_up    = 506,
+  t_507_quiz_game_buzzer_vold  = 507,
+  t_508_quiz_game_buzzer_volu  = 508,
+  t_509_quiz_game_buzzer_intro = 509,
+  t_510_quiz_game_continue     = 510,
   t_800_waiting_for_card       = 800,
   t_801_remove_card            = 801,
   t_802_reset_aborted          = 802,

src/ring.hpp

@@ -39,6 +39,7 @@ class Ring {
   void call_on_idle     () { pulse    (green); }
   void call_on_startPlay() { pulse    (red  ); }
   void call_on_play     () { rainbow  (5    ); }
+  void call_on_quiz     () { rainbow  (10   ); }
   void call_on_pause    () { rainbow  (0    ); }
   void call_on_admin    () { pulse    (blue ); }
   void call_on_sleep    () { setAll   (black); }