Fix a bug with file recreation

README.md

@@ -1,9 +1,6 @@
 # Ludum Dare 50: *unnamed game*
 [![Build Full Release](https://github.com/Ewpratten/ludum-dare-50/actions/workflows/build.yml/badge.svg)](https://github.com/Ewpratten/ludum-dare-50/actions/workflows/build.yml)
 
-
-
-
 ## Cloning
 
 **IMPORTANT:** This project makes use of recursive submodules. Make sure to pull them via GitKracken, or with the following command:
@@ -11,5 +8,12 @@
 ```sh
 git submodule update --init --recursive
 ```
-
 *Your builds will fail unless this is done*
+
+## Development notes
+
+When working on the settings and savestate file code, there is a chance you will corrupt your save files. If this happens, launch the game with the following command to fix them:
+
+```sh
+cargo run -- --force-recreate-savefiles
+```

game/desktop_wrapper/src/cli.rs

@@ -8,4 +8,9 @@ pub struct Args {
     /// Use verbose logging
     #[clap(short, long)]
     pub verbose: bool,
+
+    /// Force re-create the settings and savestate files
+    #[clap( long)]
+    pub force_recreate_savefiles: bool,
+    
 }

game/desktop_wrapper/src/main.rs

@@ -7,8 +7,8 @@ use clap::StructOpt;
 use log::LevelFilter;
 
 mod cli;
-mod logging;
 mod debug_profiling;
+mod logging;
 
 #[tokio::main]
 async fn main() {
@@ -30,6 +30,6 @@ async fn main() {
 
     // Start the game
     log::info!("Starting game");
-    game_logic::entrypoint().await;
+    game_logic::entrypoint(args.force_recreate_savefiles).await;
     log::info!("Goodbye!");
 }

game/game_logic/src/lib.rs

@@ -7,15 +7,17 @@ pub(crate) mod rendering;
 
 /// This is the game logic entrypoint. Despite being async,
 /// this is expected to block the main thread for rendering and stuff.
-pub async fn entrypoint() {
+/// 
+/// Setting `force_recreate_savefiles` will cause the game to recreate its settings and savestate files.
+pub async fn entrypoint(force_recreate_savefiles: bool) {
     log::info!("Game main thread handed off to logic crate.");
 
     // Load the game settings
-    let mut settings = persistent::settings::PersistentGameSettings::load_or_create()
+    let mut settings = persistent::settings::PersistentGameSettings::load_or_create(force_recreate_savefiles)
         .expect("Failed to parse game settings from disk. Possibly corrupt file?");
 
     // Load the game save state
-    let mut save_state = persistent::save_state::GameSaveState::load_or_create()
+    let mut save_state = persistent::save_state::GameSaveState::load_or_create(force_recreate_savefiles)
         .expect("Failed to parse game save state from disk. Possibly corrupt file?");
 
     // Blocking call to the graphics rendering loop.

game/game_logic/src/persistent/save_state.rs

@@ -42,7 +42,7 @@ impl GameSaveState {
 
     /// Loads the savestate from disk.
     #[profiling::function]
-    pub fn load_or_create() -> Result<Self, serde_json::Error> {
+    pub fn load_or_create(force_create: bool) -> Result<Self, serde_json::Error> {
         // Attempt to load the savestate from the save location.
         let save_location = Self::get_save_location();
         log::debug!(
@@ -50,7 +50,7 @@ impl GameSaveState {
             save_location.display()
         );
 
-        if save_location.is_file() {
+        if save_location.is_file() && !force_create {
             log::debug!("Found existing savestate file.");
             return serde_json::from_str(std::fs::read_to_string(&save_location).unwrap().as_str());
         }

game/game_logic/src/persistent/settings.rs

@@ -44,7 +44,7 @@ impl PersistentGameSettings {
 
     /// Loads the settings from disk.
     #[profiling::function]
-    pub fn load_or_create() -> Result<Self, serde_json::Error> {
+    pub fn load_or_create(force_create: bool) -> Result<Self, serde_json::Error> {
         // Attempt to load the settings from the save location.
         let save_location = Self::get_save_location();
         log::debug!(
@@ -52,7 +52,7 @@ impl PersistentGameSettings {
             save_location.display()
         );
 
-        if save_location.is_file() {
+        if save_location.is_file() && !force_create {
             log::debug!("Found existing settings file.");
             return serde_json::from_str(std::fs::read_to_string(&save_location).unwrap().as_str());
         }