Add more UI sound effects (not final).

Assets/compress_assets.py

@@ -0,0 +1,55 @@
+#!/usr/bin/env python3
+# coding: utf-8
+
+import zlib
+import os
+import sys
+import shutil
+
+def ensure_fresh_dir(path: str):
+
+    if os.path.exists(path):
+        shutil.rmtree(path)
+
+    os.mkdir(path)
+
+
+def compress_to_romfs(input: str, output: str):
+
+    print(f"Compressing {input} -> {output}")
+    inputSize: int =os.path.getsize(input)
+    with open(file=input, mode="rb") as inputFile:
+
+        inputBuffer: bytes = inputFile.read()
+        outputBuffer: bytes = zlib.compress(inputBuffer, 9)
+
+        with open(file=output, mode="wb") as outputFile:
+
+            inputSizeBytes: bytes = inputSize.to_bytes(length=4, byteorder="little")
+            outputSizeBytes: bytes = len(outputBuffer).to_bytes(length=4, byteorder="little")
+
+            outputFile.write(inputSizeBytes)
+            outputFile.write(outputSizeBytes)
+            outputFile.write(outputBuffer)
+
+
+
+def main() -> int:
+
+    # This is run from the makefile. All paths must be relative to it, not the script.
+    textInput:  str  = "./Assets/Text"
+    textOutput: str  = "./romfs/Text"
+
+    ensure_fresh_dir(textOutput)
+
+    for entry in os.listdir(textInput):
+
+        inputPath: str    = f"{textInput}/{entry}"
+        outputPath: str   = f"{textOutput}/{entry}.z"
+
+        compress_to_romfs(inputPath, outputPath)
+
+    return 0
+
+if __name__ == "__main__":
+    sys.exit(main())

Libraries/SDLLib

@@ -1 +1 @@
-Subproject commit 7fdd7dc872270ebd375e7571dbb83a3e9b16de82
+Subproject commit 07b5658c0056d2ebd65d51a97d4fb994aaee6fe1

Makefile

@@ -146,12 +146,12 @@ ifneq ($(ROMFS),)
 	export NROFLAGS += --romfsdir=$(CURDIR)/$(ROMFS)
 endif
 
-.PHONY: $(BUILD) FsLib SDLLib clean all
+.PHONY: $(BUILD) FsLib SDLLib Assets clean all
 
 #---------------------------------------------------------------------------------
-all: FsLib SDLLib TextFiles $(BUILD)
+all: FsLib SDLLib Assets $(BUILD)
 
-$(BUILD): FsLib SDLLib TextFiles
+$(BUILD): FsLib SDLLib Assets
 	@[ -d $@ ] || mkdir -p $@
 	@$(MAKE) --no-print-directory -C $(BUILD) -f $(CURDIR)/Makefile
 
@@ -167,8 +167,9 @@ SDLLib:
 
 #---------------------------------------------------------------------------------
 
-TextFiles:
-	@python ./Text/compress_text.py
+Assets:
+	@echo python script
+	@python ./Assets/compress_assets.py
 
 #---------------------------------------------------------------------------------
 

Text/compress_text.py

@@ -1,41 +0,0 @@
-#!/usr/bin/env python3
-# coding: utf-8
-
-import zlib
-import os
-import sys
-import shutil
-
-def main() -> int:
-    # This is run from the makefile. All paths must be relative to it, not the script.
-    inputDir:  str  = "./Text/Files"
-    outputDir: str  = "./romfs/Text"
-
-    if os.path.exists(outputDir):
-        shutil.rmtree(outputDir)
-
-    os.mkdir(outputDir)
-
-    for entry in os.listdir(inputDir):
-
-        inputPath: str    = f"{inputDir}/{entry}"
-        inputSize: int    = os.path.getsize(inputPath)
-        with open(file=inputPath, mode="rb") as inputFile:
-
-            inputBuffer: bytes = inputFile.read()
-            outputBuffer: bytes = zlib.compress(inputBuffer, 9)
-
-            outputPath: str = f"{outputDir}/{entry}.z"
-            with open(file=outputPath, mode="wb") as outputFile:
-
-                inputSizeBytes: bytes = inputSize.to_bytes(4, byteorder="little")
-                outputSizeBytes: bytes = len(outputBuffer).to_bytes(4, byteorder="little")
-
-                outputFile.write(inputSizeBytes)
-                outputFile.write(outputSizeBytes)
-                outputFile.write(outputBuffer)
-
-    return 0
-
-if __name__ == "__main__":
-    sys.exit(main())

include/appstates/ConfirmState.hpp

@@ -56,6 +56,7 @@ class ConfirmState final : public BaseState
             ConfirmState::center_no();
             ConfirmState::center_yes();
             ConfirmState::load_holding_strings();
+            sm_dialogPop->play();
         }
 
         /// @brief Returns a new ConfirmState. See constructor.
@@ -180,13 +181,21 @@ class ConfirmState final : public BaseState
         /// @brief Pointer to data struct passed to ^
         const sys::Task::TaskData m_taskData{};
 
+        /// @brief This dialog is shared between all instances.
         static inline std::shared_ptr<ui::DialogBox> sm_dialog{};
 
+        /// @brief This sound is shared.
+        static inline sdl::SharedSound sm_dialogPop{};
+
         void initialize_static_members()
         {
-            if (sm_dialog) { return; }
+            static constexpr std::string_view POP_SOUND = "ConfirmPop";
+            static constexpr const char *POP_PATH       = "romfs:/Sound/ConfirmPop.wav";
 
-            sm_dialog = ui::DialogBox::create(0, 0, 0, 0);
+            if (sm_dialog && sm_dialogPop) { return; }
+
+            sm_dialog    = ui::DialogBox::create(0, 0, 0, 0);
+            sm_dialogPop = sdl::SoundManager::load(POP_SOUND, POP_PATH);
             sm_dialog->set_from_transition(m_transition, true);
         }
 

include/appstates/MessageState.hpp

@@ -67,6 +67,9 @@ class MessageState final : public BaseState
         /// @brief All instances share this. There's no point in constantly allocating a new one.
         static inline std::shared_ptr<ui::DialogBox> sm_dialog{};
 
+        /// @brief This is the same sound that the confirmation uses.
+        static inline sdl::SharedSound sm_dialogPop{};
+
         /// @brief Allocates and ensures ^
         void initialize_static_members();
 

include/appstates/SettingsState.hpp

@@ -55,6 +55,9 @@ class SettingsState final : public BaseState
         /// @brief Toggles or executes the code to changed the selected menu option.
         void toggle_options();
 
+        /// @brief Calls config::reset_to_default and refreshes the menu.
+        void reset_settings();
+
         /// @brief Creates and pushes the message with the description.
         void create_push_description_message();
 

include/appstates/TitleInfoState.hpp

@@ -78,6 +78,9 @@ class TitleInfoState final : public BaseState
         /// @brief This frame is shared by all instances. No point in allocating it over and over.
         static inline std::shared_ptr<ui::Frame> sm_frame{};
 
+        /// @brief This is the little chime that plays when this is opened.
+        static inline sdl::SharedSound sm_openChime{};
+
         /// @brief Initializes the static members if they haven't been already.
         void initialize_static_members();
 

include/ui/Menu.hpp

@@ -124,6 +124,9 @@ namespace ui
             /// @brief Text scroll for when the current option is too long to on screen.
             std::shared_ptr<ui::TextScroll> m_optionScroll{};
 
+            /// @brief The sound played when the selected/cursor moves.
+            static inline sdl::SharedSound sm_cursor{};
+
             /// @brief Calculates the alignment variables.
             void calculate_alignments() noexcept;
 
@@ -136,6 +139,9 @@ namespace ui
             /// @brief Initializes the UI elements used within the menu.
             void initialize_ui_elements();
 
+            /// @brief Ensures the menu cursor sound is loaded.
+            void initialize_cursor_sound();
+
             /// @brief Updates the text scroll for the currently highlighted option.
             void update_scroll_text();
 

include/ui/TitleView.hpp

@@ -71,6 +71,12 @@ namespace ui
             /// @brief Bounding box rendered around the selected title.
             std::shared_ptr<ui::BoundingBox> m_bounding{};
 
+            /// @brief Sound that is played when the selected title changes. This is shared with the menu code.
+            static inline sdl::SharedSound sm_cursor{};
+
+            /// @brief Ensures static members are initialized properly.
+            void initialize_static_members();
+
             /// @brief Performs the input routine.
             void handle_input();
 

source/appstates/MessageState.cpp

@@ -11,6 +11,7 @@ MessageState::MessageState(std::string_view message)
     , m_transition(0, 0, 32, 32, 0, 0, 720, 256, ui::Transition::DEFAULT_THRESHOLD)
 {
     MessageState::initialize_static_members();
+    sm_dialogPop->play();
 }
 
 void MessageState::update()
@@ -44,12 +45,16 @@ void MessageState::render()
 
 void MessageState::initialize_static_members()
 {
-    static constexpr int HALF_WIDTH = 640;
-    if (sm_okText && sm_dialog) { return; }
+    static constexpr int HALF_WIDTH             = 640;
+    static constexpr std::string_view POP_SOUND = "ConfirmPop";
+    static constexpr const char *POP_PATH       = "romfs:/Sound/ConfirmPop.wav";
 
-    sm_okText = strings::get_by_name(strings::names::YES_NO_OK, 2);
-    sm_okX    = HALF_WIDTH - (sdl::text::get_width(22, sm_okText) / 2);
-    sm_dialog = ui::DialogBox::create(0, 0, 0, 0);
+    if (sm_okText && sm_dialog && sm_dialogPop) { return; }
+
+    sm_okText    = strings::get_by_name(strings::names::YES_NO_OK, 2);
+    sm_okX       = HALF_WIDTH - (sdl::text::get_width(22, sm_okText) / 2);
+    sm_dialog    = ui::DialogBox::create(0, 0, 0, 0);
+    sm_dialogPop = sdl::SoundManager::load(POP_SOUND, POP_PATH);
     sm_dialog->set_from_transition(m_transition, true);
 }
 

source/appstates/SettingsState.cpp

@@ -78,10 +78,12 @@ void SettingsState::update()
     const bool hasFocus     = BaseState::has_focus();
     const bool aPressed     = input::button_pressed(HidNpadButton_A);
     const bool bPressed     = input::button_pressed(HidNpadButton_B);
+    const bool xPressed     = input::button_pressed(HidNpadButton_X);
     const bool minusPressed = input::button_pressed(HidNpadButton_Minus);
 
     m_settingsMenu->update(hasFocus);
     if (aPressed) { SettingsState::toggle_options(); }
+    else if (xPressed) { SettingsState::reset_settings(); }
     else if (minusPressed) { SettingsState::create_push_description_message(); }
     else if (bPressed) { BaseState::deactivate(); }
 
@@ -231,6 +233,12 @@ void SettingsState::toggle_options()
     SettingsState::update_menu_options();
 }
 
+void SettingsState::reset_settings()
+{
+    config::reset_to_default();
+    SettingsState::update_menu_options();
+}
+
 void SettingsState::create_push_description_message()
 {
     const int selected      = m_settingsMenu->get_selected();

source/appstates/TitleInfoState.cpp

@@ -57,6 +57,7 @@ TitleInfoState::TitleInfoState(data::User *user, data::TitleInfo *titleInfo, con
 {
     TitleInfoState::initialize_static_members();
     TitleInfoState::initialize_info_fields();
+    sm_openChime->play();
 }
 
 void TitleInfoState::update()
@@ -95,7 +96,10 @@ void TitleInfoState::render()
 
 void TitleInfoState::initialize_static_members()
 {
-    if (sm_frame)
+    static constexpr std::string_view CHIME_NAME = "TitleInfoChime";
+    static constexpr const char *CHIME_PATH      = "romfs:/Sound/TitleInfo.wav";
+
+    if (sm_frame && sm_openChime)
     {
         sm_frame->set_from_transition(m_transition, true);
         return;
@@ -106,6 +110,7 @@ void TitleInfoState::initialize_static_members()
     const int width  = m_transition.get_width();
     const int height = m_transition.get_height();
     sm_frame         = ui::Frame::create(x, y, width, height);
+    sm_openChime     = sdl::SoundManager::load(CHIME_NAME, CHIME_PATH);
 }
 
 void TitleInfoState::initialize_info_fields()

source/ui/Menu.cpp

@@ -20,6 +20,7 @@ ui::Menu::Menu(int x, int y, int width, int fontSize, int renderTargetHeight)
     Menu::initialize_transition();
     Menu::initialize_option_target();
     Menu::initialize_ui_elements();
+    Menu::initialize_cursor_sound();
 }
 
 void ui::Menu::update(bool hasFocus)
@@ -155,6 +156,16 @@ void ui::Menu::initialize_ui_elements()
                                             false);
 }
 
+void ui::Menu::initialize_cursor_sound()
+{
+    static constexpr std::string_view CURSOR_NAME = "MenuCursor";
+    static constexpr const char *CURSOR_PATH      = "romfs:/Sound/MenuCursor.wav";
+
+    if (sm_cursor) { return; }
+
+    sm_cursor = sdl::SoundManager::load(CURSOR_NAME, CURSOR_PATH);
+}
+
 void ui::Menu::update_scroll_text()
 {
     const std::string_view text   = m_optionScroll->get_text();
@@ -172,6 +183,7 @@ void ui::Menu::handle_input()
     const bool rShoulderPressed = input::button_pressed(HidNpadButton_R);
     const int optionsSize       = m_options.size();
 
+    const int previousSelected = m_selected;
     if (upPressed) { --m_selected; }
     else if (downPressed) { ++m_selected; }
     else if (leftPressed) { m_selected -= m_scrollLength; }
@@ -181,6 +193,8 @@ void ui::Menu::handle_input()
 
     if (m_selected < 0) { m_selected = 0; }
     else if (m_selected >= optionsSize) { m_selected = optionsSize - 1; }
+
+    if (m_selected != previousSelected) { sm_cursor->play(); }
 }
 
 void ui::Menu::update_scrolling()

source/ui/TitleView.cpp

@@ -20,6 +20,7 @@ ui::TitleView::TitleView(data::User *user)
     , m_transition(0, UPPER_THRESHOLD, 0, 0, 0, UPPER_THRESHOLD, 0, 0, m_transition.DEFAULT_THRESHOLD)
     , m_bounding(ui::BoundingBox::create(0, 0, 188, 188))
 {
+    TitleView::initialize_static_members();
     TitleView::refresh();
 }
 
@@ -111,6 +112,16 @@ void ui::TitleView::reset()
     for (ui::TitleTile &currentTile : m_titleTiles) { currentTile.reset(); }
 }
 
+void ui::TitleView::initialize_static_members()
+{
+    static constexpr std::string_view CURSOR_NAME = "MenuCursor";
+    static constexpr const char *CURSOR_PATH      = "romfs:/Sound/MenuCursor.wav";
+
+    if (sm_cursor) { return; }
+
+    sm_cursor = sdl::SoundManager::load(CURSOR_NAME, CURSOR_PATH);
+}
+
 void ui::TitleView::handle_input()
 {
     const int totalTiles        = m_titleTiles.size() - 1;
@@ -121,6 +132,8 @@ void ui::TitleView::handle_input()
     const bool lShoulderPressed = input::button_pressed(HidNpadButton_L);
     const bool rShoulderPressed = input::button_pressed(HidNpadButton_R);
 
+    const int previousSelected = m_selected;
+
     if (upPressed) { m_selected -= ICON_ROW_SIZE; }
     else if (leftPressed) { --m_selected; }
     else if (lShoulderPressed) { m_selected -= ICON_ROW_SIZE * 3; }
@@ -130,6 +143,8 @@ void ui::TitleView::handle_input()
 
     if (m_selected < 0) { m_selected = 0; }
     if (m_selected > totalTiles) { m_selected = totalTiles; }
+
+    if (m_selected != previousSelected) { sm_cursor->play(); }
 }
 
 void ui::TitleView::handle_scrolling()