Options menu, achievements, and installer wizard. (#19)

* Implemented guest-to-host function pointers (WIP)

Co-Authored-By: Skyth (Asilkan) <19259897+blueskythlikesclouds@users.noreply.github.com>

* function: support more types for function pointers

* Initial options menu implementation.

* Improve options menu visuals.

* Draw fade on borders, center tabs better.

* Adjust line sizes, fix tab text centering.

* Adjust padding & text sizes.

* Fix bar dark gradient effect.

* api: ported BlueBlur headers and misc. research

* Fix config name padding not getting scaled at different resolutions.

* config: use string_view, added method to get value pointer

* config: use std::map for reverse enum template

* Draw config options manually instead of looping through them.

* config: implemented name and enum localisation

* config_detail: move implementation to cpp, relocate sources

* Implemented accessing options menu via pause and title screen

* config: replace MSAA with AntiAliasing enum

* options_menu: implemented info panel and text marquee (see TODOs)

* Draw selection triangles.

* Supersample fonts to 2K.

* Implement options menu navigation.

* Fix duplicate triangles when selecting options.

* Draw scroll bar.

* Adjust scroll bar padding.

* Further scroll bar padding adjustments.

* Draw outer container as an outline.

* Improve marquee text scrolling.

* CTitleMenu: fix options menu re-entering on A press whilst visible

* Make procedural grid pattern more accurate.

* Add enum & bool editing.

* Update English localisation

* Fix input state mapping.

* options_menu: hide menu on Y hold

* CHudPause: fix crash when opening options menu from village/lab

* Implement float slider.

* options_menu: round res scale description resolution

* options_menu: use config callbacks after setting items

* api: fix GameObject layout

* camera_patches: implemented camera X/Y invert

* options_menu: fix buffered A press selecting first option upon entry

* config_locale: update description for Battle Music

* config: added Allow Background Input option

* options_menu: move ATOC option below Anti-Aliasing

* options_menu: only draw header/footer fade in stages

* Handle real-time modifications of some video config values.

* Converge increments only when holding the left/right button.

* Add sound effects to options menu.

* Change some sounds used in options menu.

* Give the final decide sound to bool toggling.

* Add option select animation.

* options_menu: only play slider sound between min/max range

* Apply category select animation.

* config: rename Controls category to Input

* Implement intro transition animation for options menu.

* audio_patches: implemented music volume

* Implement FPS slider.

* Prevent ImGui from displaying OS cursor.

* Fade container brackets during intro transition.

* player_patches: added penalty to Unleash Cancel

* config_locale: update English localisation

* player_patches: ensure Unleash gauge penalty doesn't dip into negatives

* options_menu: fix being unable to press A at least once after opening the menu

* CTitleMenu: added open/close sounds to the options menu

* audio_patches: implemented Music and SE volume

* api: update research

* Implemented music volume attenuation for Windows 10+

* api: fix score offset

* Add an interval between consecutive playbacks of the slider sound effect in fastIncrement mode

* config: implemented enum descriptions

* options_menu: fit thumbnail rect to grid, remove menu hide input

* options_menu: fix description wrap width

* camera_patches: fix FOV at narrow aspect ratios

mobile gaming is back on the menu

* options_menu: implemented greyed out options and localisation

* options_menu: allow providing reasons for greyed out options

* audio_patches: check if Windows version is supported

* Update PowerRecomp submodule

* api: more research

* options_menu: forget selected item upon opening

* options_menu: restrict XButtonHoming to title and world map

* window: always hide mouse cursor

The options menu doesn't accept mouse input, so there's not really any point to showing the cursor at all.

* Animate category tab background  from the center.

* Fix clip rect in info panel not getting popped at all times.

* Expose texture loader in "video.h".

* config: use final names and descriptions, label options to be moved to exports

* options_menu: implemented Voice Language (and some misc. clean-up)

* Move Voice Language patch to resident_patches

* config: added Aspect Ratio option (to be implemented)

* options_menu: implemented Subtitles

* Remove triple buffering from options menu, turn it to an enum.

* window: hide mouse cursor on controller input for windowed mode

* window: show window dimensions on title bar when resizing window

* api: update research

* Accept functions directly in GuestToHostFunction & add memory range asserts.

* Add guest_stack_var, improve shared_ptr implementation.

* Handle float/double arguments properly in GuestToHostFunction.

* CHudPause_patches: allocate options strings on stack

* api: update research

* guest_stack_var: allow creation without constructing underlying type

* memory: make assertions lenient towards nullptr

* api: include guest_stack_var in SWA.inl

* audio_patches: don't worry about it

* Implemented achievement overlay (WIP)

* Implemented achievements menu (WIP)

* Clean-up, improved animation and layouts

* options_menu: fix naming convention

* achievements_overlay: implemented queue and hermite interpolation

* achievements_menu: implemented animations and improved navigation

* achievements_menu: improve animation accuracy

* achievements_menu: added timestamps

* achievement_data: added checksum and format verification

* achievement_menu: improved outro animation

* achievement_menu: added total unlocked achievements

* achievement_menu: update sprite animation

* Update resources submodule

* Add installer wizard.

* Skip drawing scanlines when height is 0.

* Tweak install screen to better match the original

* Added arrow circle to installer's header

* Move icon header generation to resources submodule

* Added missing animations and tweaked other ones for installer

* Improve detection for DLC only mode. Add template for message prompts.

* Add language picker.

* window: update icon resources

* Added file_to_c

* Fixes to conversion.

* Implemented message window

* achievement_menu: use selection cursor texture

* Update embedded resources

* Implemented message window

* Merge branch 'bin2c' into options-menu

* Update embedded resources

* Framework for max width for buttons.

* Update embedded resources

* Use textures for pause menu containers

* audio_patches: check if Windows major version is >=10

Just in case.

* installer_wizard: use integer outline for button text

* Added arrow circle spinning animation during installation screen

* achievement_menu: fix timestamp and scroll bar padding

* achievement_overlay: fix achievement name padding

* installer_wizard: fix arrow circle spinning animation misaligning

* Add Scale and Origin to ImGui shaders. Change text to be squashed.

* message_window: implemented mouse input

* installer_wizard: implemented message windows

* achievement_menu: start marquee before timestamp margin

* Fix message box flow.

* message_window: use pause container texture

* Add extra condition for starting the installer.

* message_window: only accept mouse click if option is selected

* Implemented safer way to check if the game is loaded

* Add queued update when using files pickers.

* installer_wizard: implement localisation

* installer_wizard: use enum for localisation

* message_window: fix visibility persisting after window closes

* Fix arrow circle animation and added pulse animation

* Come back check space.

* Implement ZSTD compression in file_to_c.

* Add fade-in/out to installation icons and sleep after hitting 100%

* Implement ImGui font atlas caching.

* Controller navigation.

* Implemented button guide

* CTitleStateMenu: fix start button opening old options menu

* Update resources submodule

* imgui_snapshot: check if game is loaded before accessing XDBF

* message_window: added button guide

* options_menu: increase button guide side margins

* video: disable imgui.ini creation

* Use IM_DELETE for deleting the existing font atlas.

* Remove redundant FlushViewport call.

* Fix ImGui callbacks leaking memory.

* Replace unique_ptr reference arguments with raw pointers.

* Specialize description for resolution scale by reference.

---------

Co-authored-by: Hyper <34012267+hyperbx@users.noreply.github.com>
Co-authored-by: PTKay <jp_moura99@outlook.com>
Co-authored-by: Dario <dariosamo@gmail.com>

UnleashedRecomp/install/installer.cpp

@@ -66,7 +66,7 @@ static std::unique_ptr<VirtualFileSystem> createFileSystemFromPath(const std::fi
     }
 }
 
-static bool copyFile(const FilePair &pair, const uint64_t *fileHashes, VirtualFileSystem &sourceVfs, const std::filesystem::path &targetDirectory, bool skipHashChecks, std::vector<uint8_t> &fileData, Journal &journal, const std::function<void(uint32_t)> &progressCallback) {
+static bool copyFile(const FilePair &pair, const uint64_t *fileHashes, VirtualFileSystem &sourceVfs, const std::filesystem::path &targetDirectory, bool skipHashChecks, std::vector<uint8_t> &fileData, Journal &journal, const std::function<void()> &progressCallback) {
     const std::string filename(pair.first);
     const uint32_t hashCount = pair.second;
     if (!sourceVfs.exists(filename))
@@ -136,7 +136,8 @@ static bool copyFile(const FilePair &pair, const uint64_t *fileHashes, VirtualFi
         return false;
     }
 
-    progressCallback(++journal.progressCounter);
+    journal.progressCounter += fileData.size();
+    progressCallback();
 
     return true;
 }
@@ -200,7 +201,46 @@ bool Installer::checkGameInstall(const std::filesystem::path &baseDirectory)
     return std::filesystem::exists(baseDirectory / GameDirectory / GameExecutableFile);
 }
 
-bool Installer::copyFiles(std::span<const FilePair> filePairs, const uint64_t *fileHashes, VirtualFileSystem &sourceVfs, const std::filesystem::path &targetDirectory, const std::string &validationFile, bool skipHashChecks, Journal &journal, const std::function<void(uint32_t)> &progressCallback)
+bool Installer::checkDLCInstall(const std::filesystem::path &baseDirectory, DLC dlc)
+{
+    switch (dlc)
+    {
+    case DLC::Spagonia:
+        return std::filesystem::exists(baseDirectory / SpagoniaDirectory / DLCValidationFile);
+    case DLC::Chunnan:
+        return std::filesystem::exists(baseDirectory / ChunnanDirectory / DLCValidationFile);
+    case DLC::Mazuri:
+        return std::filesystem::exists(baseDirectory / MazuriDirectory / DLCValidationFile);
+    case DLC::Holoska:
+        return std::filesystem::exists(baseDirectory / HoloskaDirectory / DLCValidationFile);
+    case DLC::ApotosShamar:
+        return std::filesystem::exists(baseDirectory / ApotosShamarDirectory / DLCValidationFile);
+    case DLC::EmpireCityAdabat:
+        return std::filesystem::exists(baseDirectory / EmpireCityAdabatDirectory / DLCValidationFile);
+    default:
+        return false;
+    }
+}
+
+bool Installer::computeTotalSize(std::span<const FilePair> filePairs, const uint64_t *fileHashes, VirtualFileSystem &sourceVfs, Journal &journal, uint64_t &totalSize)
+{
+    for (FilePair pair : filePairs)
+    {
+        const std::string filename(pair.first);
+        if (!sourceVfs.exists(filename))
+        {
+            journal.lastResult = Journal::Result::FileMissing;
+            journal.lastErrorMessage = std::format("File {} does not exist in the file system.", filename);
+            return false;
+        }
+
+        totalSize += sourceVfs.getSize(filename);
+    }
+
+    return true;
+}
+
+bool Installer::copyFiles(std::span<const FilePair> filePairs, const uint64_t *fileHashes, VirtualFileSystem &sourceVfs, const std::filesystem::path &targetDirectory, const std::string &validationFile, bool skipHashChecks, Journal &journal, const std::function<void()> &progressCallback)
 {
     if (!std::filesystem::exists(targetDirectory) && !std::filesystem::create_directories(targetDirectory))
     {
@@ -265,45 +305,49 @@ bool Installer::parseContent(const std::filesystem::path &sourcePath, std::uniqu
     }
 }
 
-bool Installer::install(const Input &input, const std::filesystem::path &targetDirectory, Journal &journal, const std::function<void(uint32_t)> &progressCallback)
+constexpr uint32_t PatcherContribution = 512 * 1024 * 1024;
+
+bool Installer::parseSources(const Input &input, Journal &journal, Sources &sources)
 {
+    journal = Journal();
+    sources = Sources();
+
     // Parse the contents of the base game.
-    std::unique_ptr<VirtualFileSystem> gameSource;
     if (!input.gameSource.empty())
     {
-        if (!parseContent(input.gameSource, gameSource, journal))
+        if (!parseContent(input.gameSource, sources.game, journal))
         {
             return false;
         }
 
-        journal.progressTotal += GameFilesSize;
+        if (!computeTotalSize({ GameFiles, GameFilesSize }, GameHashes, *sources.game, journal, sources.totalSize))
+        {
+            return false;
+        }
     }
 
     // Parse the contents of Update.
-    std::unique_ptr<VirtualFileSystem> updateSource;
     if (!input.updateSource.empty())
     {
-        if (!parseContent(input.updateSource, updateSource, journal))
+        // Add an arbitrary progress size for the patching process.
+        journal.progressTotal += PatcherContribution;
+
+        if (!parseContent(input.updateSource, sources.update, journal))
         {
             return false;
         }
 
-        journal.progressTotal += UpdateFilesSize;
+        if (!computeTotalSize({ UpdateFiles, UpdateFilesSize }, UpdateHashes, *sources.update, journal, sources.totalSize))
+        {
+            return false;
+        }
     }
 
     // Parse the contents of the DLC Packs.
-    struct DLCSource {
-        std::unique_ptr<VirtualFileSystem> sourceVfs;
-        std::span<const FilePair> filePairs;
-        const uint64_t *fileHashes = nullptr;
-        std::string targetSubDirectory;
-    };
-
-    std::vector<DLCSource> dlcSources;
     for (const auto &path : input.dlcSources)
     {
-        dlcSources.emplace_back();
-        DLCSource &dlcSource = dlcSources.back();
+        sources.dlc.emplace_back();
+        DLCSource &dlcSource = sources.dlc.back();
         if (!parseContent(path, dlcSource.sourceVfs, journal))
         {
             return false;
@@ -346,17 +390,51 @@ bool Installer::install(const Input &input, const std::filesystem::path &targetD
             return false;
         }
 
-        journal.progressTotal += dlcSource.filePairs.size();
+        if (!computeTotalSize(dlcSource.filePairs, dlcSource.fileHashes, *dlcSource.sourceVfs, journal, sources.totalSize))
+        {
+            return false;
+        }
     }
 
-    // Install the base game.
-    if (!copyFiles({ GameFiles, GameFilesSize }, GameHashes, *gameSource, targetDirectory / GameDirectory, GameExecutableFile, input.skipHashChecks, journal, progressCallback))
+    // Add the total size in bytes as the journal progress.
+    journal.progressTotal += sources.totalSize;
+
+    return true;
+}
+
+bool Installer::install(const Sources &sources, const std::filesystem::path &targetDirectory, bool skipHashChecks, Journal &journal, const std::function<void()> &progressCallback)
+{
+    // Install files in reverse order of importance. In case of a process crash or power outage, this will increase the likelihood of the installation
+    // missing critical files required for the game to run. These files are used as the way to detect if the game is installed.
+
+    // Install the DLC.
+    if (!sources.dlc.empty())
+    {
+        journal.createdDirectories.insert(targetDirectory / DLCDirectory);
+    }
+
+    for (const DLCSource &dlcSource : sources.dlc)
+    {
+        if (!copyFiles(dlcSource.filePairs, dlcSource.fileHashes, *dlcSource.sourceVfs, targetDirectory / dlcSource.targetSubDirectory, DLCValidationFile, skipHashChecks, journal, progressCallback))
+        {
+            return false;
+        }
+    }
+
+    // If no game or update was specified, we're finished. This means the user was only installing the DLC.
+    if ((sources.game == nullptr) && (sources.update == nullptr))
+    {
+        return true;
+    }
+
+    // Install the update.
+    if (!copyFiles({ UpdateFiles, UpdateFilesSize }, UpdateHashes, *sources.update, targetDirectory / UpdateDirectory, UpdateExecutablePatchFile, skipHashChecks, journal, progressCallback))
     {
         return false;
     }
 
-    // Install the update.
-    if (!copyFiles({ UpdateFiles, UpdateFilesSize }, UpdateHashes, *updateSource, targetDirectory / UpdateDirectory, UpdateExecutablePatchFile, input.skipHashChecks, journal, progressCallback))
+    // Install the base game.
+    if (!copyFiles({ GameFiles, GameFilesSize }, GameHashes, *sources.game, targetDirectory / GameDirectory, GameExecutableFile, skipHashChecks, journal, progressCallback))
     {
         return false;
     }
@@ -374,6 +452,10 @@ bool Installer::install(const Input &input, const std::filesystem::path &targetD
         return false;
     }
 
+    // Update the progress with the artificial amount attributed to the patching.
+    journal.progressCounter += PatcherContribution;
+    progressCallback();
+
     // Replace the executable by renaming and deleting in a safe way.
     std::error_code ec;
     std::filesystem::path oldXexPath = targetDirectory / GameDirectory / (GameExecutableFile + OldExtension);
@@ -396,20 +478,6 @@ bool Installer::install(const Input &input, const std::filesystem::path &targetD
 
     std::filesystem::remove(oldXexPath);
 
-    // Install the DLC.
-    if (!dlcSources.empty())
-    {
-        journal.createdDirectories.insert(targetDirectory / DLCDirectory);
-    }
-
-    for (const DLCSource &dlcSource : dlcSources)
-    {
-        if (!copyFiles(dlcSource.filePairs, dlcSource.fileHashes, *dlcSource.sourceVfs, targetDirectory / dlcSource.targetSubDirectory, DLCValidationFile, input.skipHashChecks, journal, progressCallback))
-        {
-            return false;
-        }
-    }
-
     return true;
 }