[Feature] Implement options menu and reading/writing values from/to the SRAM (#449)
* background * Implement Options button * Update main menu artwork * add options menu tiles * prepare options menu handling * incorporate main menu refactor * toto * add all menu interactions * do not reset selection_x in main_menu * options struct * fix rebase from ricfehr3's repo * Implement high contrast cards * Save/Load options values to SRAM * load options on game_init and validate data within the load_options function * Get changes from ricfehr3's PR * recover fix for glitched ace * clang format * clang format * clang format * Save 500B of image data by using only minimal set of tiles instead of keeping final window in source file * clang format * clang format * Implement Options button * Update main menu artwork * progress, leaving it alone for now until discussion * make game_vars an extern * Move options vars into their own struct * rollback previous commit * Implement save validation. Version check to come * implement data validity + version check for game saves * clang format * Save position in rng sequence for consistent run after load * fix rebase issues * fix rebase issue * remove unused/duplicate define * Oops, made a mistake when testing PR #424 * encode high contrast palette into an image, and load it at game_start * document save.c/h and correct typos * correct alignment * game speed and high contrast buttons working * small cleanup * sliders also work again now * clang format * Moved balatro_version extern declaration to version.h file * removed unsused variable * make showing ROM version a toggle * move ante, round and money to the GameVariables struct * Rename SaveCheckInfo struct to SaveHeader for clarity * Add SaveHeader struct explanation * clang format * Revert unnecessary tileset optimization * SFX now follows the sound volume slider * clang format * Music now follows volume slider * Changed volume slider increment from 5 to 20 to avoid having the music sound too rough under 20% volume * refactor main_menu.c to use SelectionGrid and Button structs * clang format * make a "new" save button so we don't save during the state transition * clang format * Reduced state transition flicker by only changing affine background to a different one * Fix loading game too late in game init sequence * First batch of suggestions from @MeirGavish * Remove unnecessary intermediary buffers for high contrast palette swapping * comment row warp hack for button input * Add some of Copilot's suggestions * rename balatro_version into gbalatro_version for rebranding reasons + version display erase screen fix * remove unnecessary NULL check on `on_selection_changed` method * implement small game speed arrow buttons animation * factorize some code * remove unnecessary data validation in load_game(), since we already checked the header * Implement @MeirGavish 's suggestion regarding splitting the huge `on_update` function * clang format * implement @ricfehr3 's suggestion about keeping last selected button instead of using an obscure `on_boot` boolean * Apply @ricfehr3's suggestions * fix clang-format flags --------- Co-authored-by: MathisMartin31 <mathis.martin31@gmail.com>
This commit is contained in:
Geralt
+166
@@ -0,0 +1,166 @@
|
||||
/**
|
||||
* @file save.c
|
||||
*/
|
||||
#include "save.h"
|
||||
|
||||
#include "audio_utils.h"
|
||||
#include "game.h"
|
||||
#include "joker.h"
|
||||
#include "list.h"
|
||||
#include "util.h"
|
||||
#include "version.h"
|
||||
|
||||
#include <stdlib.h>
|
||||
#include <string.h>
|
||||
|
||||
// See https://gbadev.net/gbadoc/memory.html for more details on SRAM
|
||||
// A few important pieces of info:
|
||||
// - Read/Writes are limited to 8-bits words so they are done byte per byte
|
||||
// - Memory is filled with 1s by default
|
||||
// (at least in mgba, not sure about real HW)
|
||||
|
||||
#define CHECK_BASE 0x0000
|
||||
#define GAME_BASE 0x0010
|
||||
#define LISTS_BASE 0x0060
|
||||
|
||||
#define CHECK_MAGIC 0x4C414247 // Spells GBAL, used to determine if the save data is junk
|
||||
#define CHECK_HASH_SIZE 7
|
||||
#define GIT_HASH_START 17 // starts after "GBALATRO-VERSION:" in the gbalatro_version var
|
||||
|
||||
// clang-format off
|
||||
/**
|
||||
* @brief SaveHeader for validation checks
|
||||
*
|
||||
* Structure holding save data header info to be packed and written to SRAM for validation.
|
||||
* Defined in this discussion as follows: https://github.com/GBALATRO/balatro-gba/discussions/450
|
||||
* word | Byte 0 | Byte 1 | Byte 2 | Byte 3 | name | purpose
|
||||
* -----|--------|--------|--------|--------|--------------|------------------------------------------------------------------
|
||||
* 0 | 0x47 | 0x42 | 0x41 | 0x4C | MAGIC | Identify if proceeding data is valid and not junk, spells "GBAL"
|
||||
* 1 | Dirty | H[0] | H[1] | H[2] | GITHASH_LOW | Dirty flag, followed by the first 3 bytes of shortened git hash H
|
||||
* 2 | H[3] | H[4] | H[5] | H[6] | GITHASH_HIGH | Last 4 bytes of shortened git hash H, with a dirty flag
|
||||
*/
|
||||
// clang-format on
|
||||
typedef struct SaveHeader
|
||||
{
|
||||
u32 magic;
|
||||
bool dirty;
|
||||
char githash[CHECK_HASH_SIZE];
|
||||
} SaveHeader;
|
||||
|
||||
/**
|
||||
* @brief Write raw binary data to SRAM
|
||||
*
|
||||
* @param sram_base address written to in the SRAM
|
||||
* @param bytes pointer to the written data
|
||||
* @param size number of bytes written
|
||||
*/
|
||||
static inline void write_sram(u32 sram_base, const u8* bytes, u32 size)
|
||||
{
|
||||
if (sram_base + size > SRAM_SIZE)
|
||||
return;
|
||||
|
||||
for (u32 i = 0; i < size; i++)
|
||||
{
|
||||
sram_mem[sram_base + i] = bytes[i];
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* @brief Read raw binary data from SRAM
|
||||
*
|
||||
* @sa write_sram
|
||||
*/
|
||||
static inline void read_sram(u32 sram_base, u8* bytes, u32 size)
|
||||
{
|
||||
if (sram_base + size > SRAM_SIZE)
|
||||
return;
|
||||
|
||||
for (u32 i = 0; i < size; i++)
|
||||
{
|
||||
bytes[i] = sram_mem[sram_base + i];
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* @brief Checks the 7 chars of gbalatro_version after the "GBALATRO_VERSION" prefix
|
||||
* representing the git hash of the code the build is based on.
|
||||
*
|
||||
* @returns true if the git hash of the ROM is equal to the hash saved in SRAM.
|
||||
* false if they are different.
|
||||
*/
|
||||
static inline bool check_hash(const char* prefix)
|
||||
{
|
||||
for (u32 i = 0; i < CHECK_HASH_SIZE; i++)
|
||||
{
|
||||
if (gbalatro_version[GIT_HASH_START + i] != prefix[i])
|
||||
{
|
||||
return false;
|
||||
}
|
||||
}
|
||||
|
||||
return true;
|
||||
}
|
||||
|
||||
/**
|
||||
* @brief Determines if the current build is considered "dirty" aka has uncommitted changes.
|
||||
* This works because the gbalatro_version string has "-dirty" added at the end if it's
|
||||
* dirty.
|
||||
*
|
||||
* @returns true if version is dirty, false otherwise.
|
||||
*/
|
||||
static inline bool is_version_dirty()
|
||||
{
|
||||
return strlen(gbalatro_version) > GIT_HASH_START + CHECK_HASH_SIZE;
|
||||
}
|
||||
|
||||
/**
|
||||
* @brief Writes a magic number and ROM version info to SRAM to signal that the
|
||||
* save data exists and allow the game to determine if it is compatible.
|
||||
*/
|
||||
static inline void set_save_header()
|
||||
{
|
||||
SaveHeader check = {};
|
||||
check.magic = CHECK_MAGIC;
|
||||
check.dirty = is_version_dirty();
|
||||
memcpy(&(check.githash), gbalatro_version + GIT_HASH_START, CHECK_HASH_SIZE);
|
||||
|
||||
write_sram(CHECK_BASE, (const u8*)&check, sizeof(check));
|
||||
}
|
||||
|
||||
/**
|
||||
* @brief Reads whether the save data exists and is valid.
|
||||
*
|
||||
* @sa set_save_valid
|
||||
*/
|
||||
static inline bool check_save_header()
|
||||
{
|
||||
SaveHeader check;
|
||||
read_sram(CHECK_BASE, (u8*)&check, sizeof(check));
|
||||
|
||||
bool is_valid = (check.magic == CHECK_MAGIC) && check.dirty == is_version_dirty() &&
|
||||
check_hash(check.githash);
|
||||
|
||||
return is_valid;
|
||||
}
|
||||
|
||||
void save_game(void)
|
||||
{
|
||||
set_save_header();
|
||||
write_sram(GAME_BASE, (const u8*)&g_game_vars, sizeof(g_game_vars));
|
||||
}
|
||||
|
||||
void load_game(void)
|
||||
{
|
||||
if (!check_save_header())
|
||||
return;
|
||||
|
||||
read_sram(GAME_BASE, (u8*)&g_game_vars, sizeof(g_game_vars));
|
||||
|
||||
// return to where we were in the random sequence so that the run stays reproducible
|
||||
for (u32 i = 0; i < g_game_vars.rng_step; i++)
|
||||
{
|
||||
(void)rand();
|
||||
}
|
||||
|
||||
mmSetModuleVolume(MM_MODULE_FULL_VOLUME * g_game_vars.music_volume / VOLUME_OPTION_MAX);
|
||||
}
|
||||
Reference in New Issue
Block a user