Sokobokobanaban Instructions

main/CMakeLists.txt

@@ -37,6 +37,16 @@ idf_component_register(SRCS "asset_loaders/common/heatshrink_encoder.c"
                             "modes/games/bigbug/soundManager_bigbug.c"
                             "modes/games/bigbug/tilemap_bigbug.c"
                             "modes/games/bigbug/worldGen_bigbug.c"
+                            "modes/games/cGrove/cg_Chowa.c"
+                            "modes/games/cGrove/cg_Items.c"
+                            "modes/games/cGrove/Garden/cg_GroveAI.c"
+                            "modes/games/cGrove/Garden/cg_Grove.c"
+                            "modes/games/cGrove/Garden/cg_GroveDraw.c"
+                            "modes/games/cGrove/Garden/cg_GroveItems.c"
+                            "modes/games/cGrove/mode_cGrove.c"
+                            "modes/games/cGrove/Sparring/cg_Match.c"
+                            "modes/games/cGrove/Sparring/cg_Spar.c"
+                            "modes/games/cGrove/Sparring/cg_SparDraw.c"
                             "modes/games/pango/paEntity.c"
                             "modes/games/pango/paEntityManager.c"
                             "modes/games/pango/paGameData.c"
@@ -47,6 +57,7 @@ idf_component_register(SRCS "asset_loaders/common/heatshrink_encoder.c"
                             "modes/games/soko/soko.c"
                             "modes/games/soko/soko_game.c"
                             "modes/games/soko/soko_gamerules.c"
+                            "modes/games/soko/sokoHelp.c"
                             "modes/games/soko/soko_input.c"
                             "modes/games/soko/soko_save.c"
                             "modes/games/soko/soko_undo.c"
@@ -61,21 +72,11 @@ idf_component_register(SRCS "asset_loaders/common/heatshrink_encoder.c"
                             "modes/games/ultimateTTT/ultimateTTTmarkerSelect.c"
                             "modes/games/ultimateTTT/ultimateTTTp2p.c"
                             "modes/games/ultimateTTT/ultimateTTTresult.c"
-                            "modes/games/cGrove/mode_cGrove.c"
-                            "modes/games/cGrove/cg_Chowa.c"
-                            "modes/games/cGrove/cg_Items.c"
-                            "modes/games/cGrove/Garden/cg_Grove.c"
-                            "modes/games/cGrove/Garden/cg_GroveAI.c"
-                            "modes/games/cGrove/Garden/cg_GroveDraw.c"
-                            "modes/games/cGrove/Garden/cg_GroveItems.c"
-                            "modes/games/cGrove/Sparring/cg_Match.c"
-                            "modes/games/cGrove/Sparring/cg_Spar.c"
-                            "modes/games/cGrove/Sparring/cg_SparDraw.c"
                             "modes/music/colorchord/colorchord.c"
                             "modes/music/jukebox/jukebox.c"
+                            "modes/music/sequencer/sequencerGrid.c"
                             "modes/music/sequencer/sequencerHelp.c"
                             "modes/music/sequencer/sequencerMode.c"
-                            "modes/music/sequencer/sequencerGrid.c"
                             "modes/music/tunernome/tunernome.c"
                             "modes/music/usbsynth/mode_synth.c"
                             "modes/system/credits/credits_utils.c"

main/modes/games/soko/soko.c

@@ -4,6 +4,8 @@
 #include "soko_game.h"
 #include "soko_gamerules.h"
 #include "soko_save.h"
+#include "sokoHelp.h"
+#include "mainMenu.h"
 
 static void sokoMainLoop(int64_t elapsedUs);
 static void sokoEnterMode(void);
@@ -15,7 +17,10 @@ static void sokoExtractLevelNamesAndIndices(soko_abs_t* self);
 // strings
 const char sokoModeName[]             = "Hunter's Puzzles";
 static const char sokoPlayGameLabel[] = "Play";
-const char SOKO_TAG[]                 = "SB";
+static const char sokoHelpLabel[]     = "Instructions";
+static const char sokoExitLabel[]     = "Exit";
+
+const char SOKO_TAG[] = "SB";
 
 extern const char key_sk_overworldPos[];
 
@@ -44,7 +49,13 @@ static void sokoEnterMode(void)
 {
     soko = heap_caps_calloc(1, sizeof(soko_abs_t), MALLOC_CAP_SPIRAM);
     // Load a font
-    loadFont("ibm_vga8.font", &soko->ibm, false);
+    loadFont("ibm_vga8.font", &soko->ibm, true);
+    loadFont("rodin_eb.font", &soko->font_rodin, true);
+    makeOutlineFont(&soko->font_rodin, &soko->font_rodin_outline, true);
+    loadFont("righteous_150.font", &soko->font_righteous, true);
+    makeOutlineFont(&soko->font_righteous, &soko->font_righteous_outline, true);
+
+    soko->allSolved = false;
 
     soko->allSolved = false;
 
@@ -106,11 +117,15 @@ static void sokoEnterMode(void)
     soko->eulerTheme.altFloorColor        = c433; // painted tiles color.
 
     // Initialize the menu
-    soko->menu              = initMenu(sokoModeName, sokoMenuCb);
-    soko->menuManiaRenderer = initMenuManiaRenderer(NULL, NULL, NULL);
+    soko->menu   = initMenu(sokoModeName, sokoMenuCb);
+    soko->bgMenu = initMenu(sokoModeName, NULL);
+    soko->menuManiaRenderer
+        = initMenuManiaRenderer(&soko->font_righteous, &soko->font_righteous_outline, &soko->font_rodin);
 
     // addSingleItemToMenu(soko->menu, sokoResumeGameLabel);
     addSingleItemToMenu(soko->menu, sokoPlayGameLabel);
+    addSingleItemToMenu(soko->menu, sokoHelpLabel);
+    addSingleItemToMenu(soko->menu, sokoExitLabel);
 
     // Set the mode to menu mode
     soko->screen = SOKO_MENU;
@@ -135,10 +150,15 @@ static void sokoExitMode(void)
     }
     // Deinitialize the menu
     deinitMenu(soko->menu);
+    deinitMenu(soko->bgMenu);
     deinitMenuManiaRenderer(soko->menuManiaRenderer);
 
     // Free the font
     freeFont(&soko->ibm);
+    freeFont(&soko->font_rodin);
+    freeFont(&soko->font_rodin_outline);
+    freeFont(&soko->font_righteous);
+    freeFont(&soko->font_righteous_outline);
 
     // free the level name file
     freeTxt(soko->levelFileText);
@@ -193,6 +213,15 @@ static void sokoMenuCb(const char* label, bool selected, uint32_t settingVal)
             sokoInitGameBin(soko);
             soko->screen = SOKO_LEVELPLAY;
         }
+        else if (sokoHelpLabel == label)
+        {
+            soko->helpIdx = 0;
+            soko->screen  = SOKO_HELP;
+        }
+        else if (sokoExitLabel == label)
+        {
+            switchToSwadgeMode(&mainMenuMode);
+        }
     }
 }
 
@@ -241,6 +270,16 @@ static void sokoMainLoop(int64_t elapsedUs)
             ESP_LOGD(SOKO_TAG, "Go to gameplay");
             soko->loadNewLevelFlag = false; // reset flag.
             soko->screen           = SOKO_LEVELPLAY;
+            break;
+        }
+        case SOKO_HELP:
+        {
+            buttonEvt_t evt = {0};
+            while (checkButtonQueueWrapper(&evt))
+            {
+                buttonSokoHelp(soko, &evt);
+            }
+            drawSokoHelp(soko, elapsedUs);
         }
     }
 }

main/modes/games/soko/soko.h

@@ -20,7 +20,8 @@ typedef enum
 {
     SOKO_MENU,
     SOKO_LEVELPLAY,
-    SOKO_LOADNEWLEVEL
+    SOKO_LOADNEWLEVEL,
+    SOKO_HELP,
 } sokoScreen_t;
 
 typedef enum
@@ -181,9 +182,14 @@ typedef struct soko_abs_s
 {
     // meta
     menu_t* menu;                           ///< The menu structure
+    menu_t* bgMenu;                         ///< The menu structure
     menuManiaRenderer_t* menuManiaRenderer; ///< Renderer for the menu
     font_t ibm;                             ///< The font used in the menu and game
-    sokoScreen_t screen;                    ///< The screen being displayed
+    font_t font_rodin;
+    font_t font_rodin_outline;
+    font_t font_righteous;
+    font_t font_righteous_outline;
+    sokoScreen_t screen; ///< The screen being displayed
 
     char* levelFileText;
     char* levelNames[SOKO_LEVEL_COUNT];
@@ -261,6 +267,10 @@ typedef struct soko_abs_s
     soko_var_t loadNewLevelVariant;
 
     int chosen_victory_message;
+
+    // Help page
+    uint32_t helpIdx;
+    uint32_t arrowBlinkTimer;
 } soko_abs_t;
 
 extern const char SOKO_TAG[];

main/modes/games/soko/sokoHelp.c

@@ -0,0 +1,183 @@
+//==============================================================================
+// Includes
+//==============================================================================
+
+#include "hdw-tft.h"
+#include "sokoHelp.h"
+
+//==============================================================================
+// Defines
+//==============================================================================
+
+#define TEXT_MARGIN_L 18
+#define TEXT_MARGIN_R 13
+
+#define ARROW_BLINK_PERIOD 1000000
+
+//==============================================================================
+// Structs
+//==============================================================================
+
+typedef struct
+{
+    const char* title;
+    const char* text;
+} sokoHelpPage_t;
+
+//==============================================================================
+// Const data
+//==============================================================================
+
+static const char controlTitle[] = "Controls";
+static const char boxTitle[]     = "Boxes";
+
+static const sokoHelpPage_t helpPages[] = {
+    {
+        .title = sokoModeName,
+        .text  = "You are an Eye and your job is to paint the floors in twenty two rooms. Don't ask questions.",
+    },
+    {
+        .title = controlTitle,
+        .text  = "Use the D-Pad to walk around the main hallway, enter rooms, and paint the floors.",
+    },
+    {
+        .title = controlTitle,
+        .text  = "When painting a floor, you absolutely MUST NOT step on wet paint. If you do, you won't get paid.",
+    },
+    {
+        .title = controlTitle,
+        .text  = "If you make a small mistake, you can press A to undo one step before anyone notices.",
+    },
+    {
+        .title = controlTitle,
+        .text
+        = "If you make a big mistake, you can press B to reset the entire room. Your boss will probably notice though.",
+    },
+    {
+        .title = controlTitle,
+        .text = "If you're frustrated and need a break from a room, you can press Start to return to the main hallway.",
+    },
+    {
+        .title = boxTitle,
+        .text  = "Some jerk left orange boxes are on some floors. You can push them around to make sure all the floor "
+                 "is painted.",
+    },
+    {
+        .title = boxTitle,
+        .text  = "Purple boxes are like orange boxes, but sticky and gross. In the unlikely event that one is stuck to "
+                 "you, try scraping it off.",
+    },
+    {
+        .title = boxTitle,
+        .text  = "Red & purple boxes are highly toxic to touch. You can't push them directly, but maybe you can with "
+                 "something else. Safety first.",
+    },
+    {
+        .title = sokoModeName,
+        .text  = "Good luck and get painting!",
+    },
+};
+
+//==============================================================================
+// Functions
+//==============================================================================
+
+/**
+ * @brief Draw the help menu
+ *
+ * @param soko The entire soko state
+ * @param elapsedUs The time elapsed since the last function call
+ */
+void drawSokoHelp(soko_abs_t* soko, int32_t elapsedUs)
+{
+    // Set the title
+    soko->bgMenu->title = helpPages[soko->helpIdx].title;
+
+    // Draw background, without animation
+    drawMenuMania(soko->bgMenu, soko->menuManiaRenderer, 0);
+
+    // Draw text
+    paletteColor_t textColor = c000;
+    int16_t xOff             = TEXT_MARGIN_L;
+    int16_t yOff             = MANIA_TITLE_HEIGHT + 8;
+    drawTextWordWrap(&soko->font_rodin, textColor, helpPages[soko->helpIdx].text, &xOff, &yOff,
+                     TFT_WIDTH - TEXT_MARGIN_R, TFT_HEIGHT);
+    xOff = TEXT_MARGIN_L;
+    yOff = MANIA_TITLE_HEIGHT + 8;
+
+    // Draw page numbers
+    char pageText[32];
+    snprintf(pageText, sizeof(pageText) - 1, "%" PRId32 "/%" PRId32 "", 1 + soko->helpIdx,
+             (int32_t)ARRAY_SIZE(helpPages));
+
+    int16_t tWidth = textWidth(&soko->font_rodin, pageText);
+    drawText(&soko->font_rodin, textColor, pageText, TFT_WIDTH - 30 - tWidth, TFT_HEIGHT - soko->font_rodin.height + 2);
+
+    // Blink the arrows
+    soko->arrowBlinkTimer += elapsedUs;
+    while (soko->arrowBlinkTimer >= ARROW_BLINK_PERIOD)
+    {
+        soko->arrowBlinkTimer -= ARROW_BLINK_PERIOD;
+    }
+
+    if (soko->arrowBlinkTimer < (ARROW_BLINK_PERIOD / 2))
+    {
+        // Draw arrows to indicate this can be scrolled
+        if (0 != soko->helpIdx)
+        {
+            // Draw left arrow if not on the first page
+            drawText(&soko->font_rodin, textColor, "<", 0, (TFT_HEIGHT - soko->font_rodin.height) / 2);
+        }
+
+        if ((ARRAY_SIZE(helpPages) - 1) != soko->helpIdx)
+        {
+            // Draw right arrow if not on the last page
+            drawText(&soko->font_rodin, textColor, ">", TFT_WIDTH - textWidth(&soko->font_rodin, ">"),
+                     (TFT_HEIGHT - soko->font_rodin.height) / 2);
+        }
+    }
+}
+
+/**
+ * @brief Handle a button event on the help screen
+ *
+ * @param soko The entire soko state
+ * @param evt The button event to handle
+ */
+void buttonSokoHelp(soko_abs_t* soko, buttonEvt_t* evt)
+{
+    if (evt->down)
+    {
+        switch (evt->button)
+        {
+            case PB_LEFT:
+            {
+                if (soko->helpIdx > 0)
+                {
+                    soko->helpIdx--;
+                }
+                else
+                {
+                    soko->screen = SOKO_MENU;
+                }
+                break;
+            }
+            case PB_RIGHT:
+            {
+                if (soko->helpIdx < ARRAY_SIZE(helpPages) - 1)
+                {
+                    soko->helpIdx++;
+                }
+                else
+                {
+                    soko->screen = SOKO_MENU;
+                }
+                break;
+            }
+            default:
+            {
+                break;
+            }
+        }
+    }
+}

main/modes/games/soko/sokoHelp.h

@@ -0,0 +1,6 @@
+#pragma once
+
+#include "soko.h"
+
+void buttonSokoHelp(soko_abs_t* sv, buttonEvt_t* evt);
+void drawSokoHelp(soko_abs_t* sv, int32_t elapsedUs);