v2.1.6

Author: SchuhBaum

.gitignore

@@ -2,6 +2,7 @@ SourceCode/bin
 SourceCode/obj
 
 MapOptions/plugins/
+MapOptions/region_names*
 MapOptions.zip
 steam_description.txt
 

MapOptions/modinfo.json

@@ -1,7 +1,7 @@
 {
   "id": "MapOptions",
   "name": "MapOptions",
-  "version": "2.1.5",
+  "version": "2.1.6",
   "authors": "SchuhBaum",
   "description": "Adds options to configure the map.",
   "requirements": [],

MapOptions/workshopdata.json

@@ -2,7 +2,7 @@
   "Title": "MapOptions",
   "Description": "Adds options to configure the map.",
   "ID": "MapOptions",
-  "Version": "2.1.5",
+  "Version": "2.1.6",
   "TargetGameVersion": "",
   "Requirements": "",
   "RequirementNames": "",

ReadMe.md

@@ -1,24 +1,26 @@
 ## MapOptions
-###### Version: 2.1.5
+###### Version: 2.1.6
 This is a mod for Rain World v1.9.
 
 ### Description
 Adds options to configure the map:  
 - `(Map Zoom)` The zoom can be adjusted (50%-150%).
 - `(Aerial Map)` When disabled, the default map shader is used in Chimney Canopy and Sky Islands.
+- `(Clear Expedition Maps)` When enabled, clears the map progress for each new expedition run. Warning: Map progress is saved even without completing a full cycle.
 - `(Creature Symbols)` These symbols display what creature types are present in each room.
+- `(Discover Multiplier)` Can be used to decrease or increase the map discover range around slugcat. Warning: This deletes your map progress first. The game tries to recover it but you might gain (or lose) map progress.
 - `(Item Tracker)` Tracked key items are shown on the map even when the option 'Slug Senses' is disabled. The option 'Key item tracking' needs to be enabled in Rain World Remix.
 - `(Layer Focus)` Only the active layer is displayed on the map.
 - `(Shadow Sprites)` Draws shadows for creature and slugcat symbols.
 - `(Skip Fade In/Out)` Pressing the map button shows the map with no delay.
 - `(Slugcat Symbols)` Draws a slugcat sprite on the map instead of a red circle. When Jolly Co-Op Mod is enabled, draws a sprite for each player.
-- `(Uncover Region)` Once loaded into the game the whole region map gets uncovered.
+- `(Uncover Region)` Once loaded into the game the whole region map gets uncovered. Warning: Map progress is saved even without completing a full cycle.
 - `(Uncover Room)` When the player enters a room the whole room gets uncovered instead of just the area around slugcat.
 - `(Reveal Speed Multiplier)` For a given value X the map is revealed X-times as fast. If the maximum value is selected then opening the map displays known areas instantly instead of revealing them gradually.
 
 ### Installation
 0. Update Rain World to version 1.9 if needed.
-1. Download the file  `MapOptions.zip` from [Releases](https://github.com/SchuhBaum/MapOptions/releases/tag/v2.1.5).
+1. Download the file  `MapOptions.zip` from [Releases](https://github.com/SchuhBaum/MapOptions/releases/tag/v2.1.6).
 2. Extract its content in the folder `[Steam]\SteamApps\common\Rain World\RainWorld_Data\StreamingAssets\mods`.
 3. Start the game as normal. In the main menu select `Remix` and enable the mod. 
 
@@ -34,14 +36,15 @@ There are two licenses available - MIT and Unlicense. You can choose which one y
 
 ### Changelog
 #### (Rain World v1.9)
-v2.1.5:
+v2.1.6:
 - Fixed a bug that could lag the game when you would try to open the map while an in-game text message is displayed.
 - (creature symbols) Fixed a bug where slugcat npc symbols would have the same color as the player.
 - (creature symbols) Fixed a bug where a NullReference exeption was thrown when the room of the creature could not be found.
 - (creature symbols) Removed that symbols are shown in shelters. Vanilla already shows symbols for items and creatures in shelters.
 - Changed the hook initialization logic. This should reduce the log spam from IL hooks. Instead of doing it every cycle while in-game they are initialized when starting the game or when changing the options.
 - (discover multiplier) Added a slider to change the map discover radius around slugcat.
 - (uncover room) Potentially fixed an issue where adjacent non-overlapping rooms were partly getting uncovered as well.
+- (clear expedition maps) Added this options (disabled by default). Clears the map progress for each new expedition run.
 
 v2.1.0:
 - Added support for Rain World 1.9.

SourceCode/ExpeditionMod.cs

@@ -0,0 +1,115 @@
+using System.Collections.Generic;
+using System.IO;
+using UnityEngine;
+using static ProcessManager;
+using static MapOptions.MainMod;
+using RWCustom;
+
+namespace MapOptions;
+
+public static class ExpeditionMod {
+    //
+    // variables
+    //
+
+    public static List<string>? region_names_of_cleared_maps = null;
+
+    //
+    //
+    //
+
+    internal static void On_Config_Changed() {
+        On.Menu.CharacterSelectPage.Singal -= Menu_CharacterSelectPage_Singal;
+        On.PlayerProgression.LoadMapTexture -= PlayerProgression_LoadMapTexture;
+        On.ProcessManager.RequestMainProcessSwitch_ProcessID -= ProcessManager_RequestMainProcessSwitch;
+
+        if (Option_ClearExpeditionMaps) {
+            On.Menu.CharacterSelectPage.Singal += Menu_CharacterSelectPage_Singal;
+            On.PlayerProgression.LoadMapTexture += PlayerProgression_LoadMapTexture;
+            On.ProcessManager.RequestMainProcessSwitch_ProcessID += ProcessManager_RequestMainProcessSwitch;
+        }
+    }
+
+    //
+    // public
+    //
+
+    public static void Load_Region_Names_Of_Cleared_Maps() {
+        string file_path = mod_directory_path + "region_names_of_cleared_maps" + Custom.rainWorld.options.saveSlot + ".json";
+        if (!File.Exists(file_path)) {
+            region_names_of_cleared_maps = null;
+            return;
+        }
+
+        try {
+            Debug.Log("MapOptions: Load the variable region_names_of_cleared_maps for save slot " + Custom.rainWorld.options.saveSlot + ".");
+            List<object> file_content = (List<object>)Json.Deserialize(File.ReadAllText(file_path));
+            region_names_of_cleared_maps = new();
+
+            foreach (object obj in file_content) {
+                region_names_of_cleared_maps.Add(obj.ToString());
+            }
+        } catch { }
+        return;
+    }
+
+    public static void Save_Region_Names_Of_Cleared_Maps() {
+        if (region_names_of_cleared_maps == null) return;
+        try {
+            Debug.Log("MapOptions: Save the variable region_names_of_cleared_maps for save slot " + Custom.rainWorld.options.saveSlot + ".");
+            string file_path = mod_directory_path + "region_names_of_cleared_maps" + Custom.rainWorld.options.saveSlot + ".json";
+            File.WriteAllText(file_path, Json.Serialize(region_names_of_cleared_maps));
+        } catch { }
+    }
+
+    //
+    // private
+    //
+
+    private static void Menu_CharacterSelectPage_Singal(On.Menu.CharacterSelectPage.orig_Singal orig, Menu.CharacterSelectPage character_select_page, Menu.MenuObject sender, string message) {
+        orig(character_select_page, sender, message);
+        if (sender != character_select_page.confirmExpedition) return;
+
+        if (message == "NEW") {
+            // the variable is saved when entering the game by the process_manager;
+            Debug.Log("MapOptions: Start new expedition.");
+            region_names_of_cleared_maps = new();
+            return;
+        }
+
+        if (message == "LOAD") {
+            Debug.Log("MapOptions: Load expedition.");
+            Load_Region_Names_Of_Cleared_Maps();
+            return;
+        }
+    }
+
+    private static void PlayerProgression_LoadMapTexture(On.PlayerProgression.orig_LoadMapTexture orig, PlayerProgression player_progression, string region_name) {
+        // the function orig() might return early without loading the map; but the function
+        // map.Update() calls this function only once; it only has once chance to load =>
+        // reset map progress in any case;
+        orig(player_progression, region_name);
+        if (region_names_of_cleared_maps == null) return;
+        if (region_names_of_cleared_maps.Contains(region_name)) return;
+        Debug.Log("MapOptions: Clear expedition map progress for region " + region_name + ".");
+
+        // this would not work for visited rooms; the game recovers the progress in that 
+        // case; it's okay here since for each new run there are no visited rooms;
+        player_progression.mapDiscoveryTextures[region_name] = null;
+        region_names_of_cleared_maps.Add(region_name);
+    }
+
+    private static void ProcessManager_RequestMainProcessSwitch(On.ProcessManager.orig_RequestMainProcessSwitch_ProcessID orig, ProcessManager process_manager, ProcessID next_process_id) {
+        orig(process_manager, next_process_id);
+        if (next_process_id == ProcessID.Game) {
+            Save_Region_Names_Of_Cleared_Maps();
+            return;
+        }
+
+        if (next_process_id == ProcessID.MainMenu) {
+            Save_Region_Names_Of_Cleared_Maps();
+            region_names_of_cleared_maps = null;
+            return;
+        }
+    }
+}

SourceCode/MainMod.cs

@@ -1,5 +1,7 @@
 using BepInEx;
 using MonoMod.Cil;
+using System.IO;
+using System.Reflection;
 using System.Security.Permissions;
 using UnityEngine;
 using static MapOptions.MainModOptions;
@@ -11,29 +13,31 @@
 
 namespace MapOptions;
 
-[BepInPlugin("SchuhBaum.MapOptions", "MapOptions", "2.1.5")]
+[BepInPlugin("SchuhBaum.MapOptions", "MapOptions", "2.1.6")]
 public class MainMod : BaseUnityPlugin {
     //
     // meta data
     //
 
     public static readonly string mod_id = "MapOptions";
     public static readonly string author = "SchuhBaum";
-    public static readonly string version = "2.1.5";
+    public static readonly string version = "2.1.6";
+    public static readonly string mod_directory_path = Directory.GetParent(Path.GetDirectoryName(Assembly.GetExecutingAssembly().Location)).FullName + Path.DirectorySeparatorChar;
 
     //
     // options
     //
 
     public static bool Option_AerialMap => aerial_map.Value;
+    public static bool Option_ClearExpeditionMaps => clear_expedition_maps.Value;
     public static bool Option_CreatureSymbols => creature_symbols.Value;
     public static bool Option_ItemTracker => item_tracker.Value;
 
     public static bool Option_LayerFocus => layer_focus.Value;
     public static bool Option_ShadowSprites => shadow_sprites.Value;
     public static bool Option_SkipFade => skip_fade.Value;
-
     public static bool Option_SlugcatSymbols => slugcat_symbols.Value;
+
     public static bool Option_UncoverRegion => uncover_region.Value;
     public static bool Option_UncoverRoom => uncover_room.Value;
 

SourceCode/MainModOptions.cs

@@ -15,23 +15,28 @@ public class MainModOptions : OptionInterface {
     //
 
     public static Configurable<bool> aerial_map = main_mod_options.config.Bind("aerial_map", defaultValue: false, new ConfigurableInfo("The default map shader is used in Chimney Canopy and Sky Islands instead of the aerial map shader.", null, "", "Aerial Map"));
+    public static Configurable<bool> clear_expedition_maps = main_mod_options.config.Bind("clear_expedition_maps", defaultValue: false, new ConfigurableInfo("Clears the map progress for each new expedition run.\nWARNING: This progress is lost even without completing a full cycle.", null, "", "Clear Expedition Maps"));
     public static Configurable<bool> creature_symbols = main_mod_options.config.Bind("creature_symbols", defaultValue: true, new ConfigurableInfo("Creature symbols are added to the map. These symbols display what creature types are present in each room.", null, "", "Creature Symbols"));
     public static Configurable<bool> item_tracker = main_mod_options.config.Bind("item_tracker", defaultValue: true, new ConfigurableInfo("Tracked key items are shown on the map even when the option 'Slug Senses' is disabled. The option 'Key item tracking' needs to be enabled in Rain World Remix.", null, "", "Item Tracker"));
 
     public static Configurable<bool> layer_focus = main_mod_options.config.Bind("layer_focus", defaultValue: false, new ConfigurableInfo("Only the active layer is displayed on the map.", null, "", "Layer Focus"));
     public static Configurable<bool> shadow_sprites = main_mod_options.config.Bind("shadow_sprites", defaultValue: false, new ConfigurableInfo("Draws shadows for creature and slugcat symbols.", null, "", "Shadow Sprites"));
     public static Configurable<bool> skip_fade = main_mod_options.config.Bind("skip_fade", defaultValue: false, new ConfigurableInfo("Pressing the map button shows the map with no delay.", null, "", "Skip Fade In/Out"));
-
     public static Configurable<bool> slugcat_symbols = main_mod_options.config.Bind("slugcat_symbols", defaultValue: true, new ConfigurableInfo("Draws a slugcat sprite on the map instead of a red circle. When Jolly Co-Op is enabled, draws a sprite for each player.", null, "", "Slugcat Symbols"));
-    public static Configurable<bool> uncover_region = main_mod_options.config.Bind("uncover_region", defaultValue: false, new ConfigurableInfo("Once loaded into the game the whole region map gets uncovered.\nWARNING: This progress is saved (even without completing a cycle). Turning this option off after saving will *not* remove the gained progress.", null, "", "Uncover Region"));
+
+    public static Configurable<bool> uncover_region = main_mod_options.config.Bind("uncover_region", defaultValue: false, new ConfigurableInfo("Once loaded into the game the whole region map gets uncovered.\nWARNING: This progress is saved even without completing a full cycle.", null, "", "Uncover Region"));
     public static Configurable<bool> uncover_room = main_mod_options.config.Bind("uncover_room", defaultValue: true, new ConfigurableInfo("When the player enters a room the whole room gets uncovered instead of just the area around slugcat.", null, "", "Uncover Room"));
 
-    public static Configurable<int> zoom_slider = main_mod_options.config.Bind("zoom_slider", defaultValue: 10, new ConfigurableInfo("The default value is 100% (10) zoom. Each value (5-15) corresponds to 10*value% (50%-150%) zoom..", new ConfigAcceptableRange<int>(5, 15), "", "Zoom Level (10)"));
+    //
+    //
+    //
+
     public static Configurable<int> creature_symbol_scale = main_mod_options.config.Bind("creature_symbol_scale", defaultValue: 10, new ConfigurableInfo("The default value is 100% (10). Each value (5-20) corresponds to 10*value% (50%-200%).", new ConfigAcceptableRange<int>(5, 20), "", "Creature Symbol Size (10)"));
+    public static Configurable<int> discover_multiplier = main_mod_options.config.Bind("discover_multiplier", defaultValue: 2, new ConfigurableInfo("The default value is two. For a given value X the map around slugcat is discovered (X/2)-times as far.\nWARNING: This will delete and change the size of any loaded region discover texture. The game tries to recover your map progress based on visited rooms.", new ConfigAcceptableRange<int>(1, 10), "", "Discover Multiplier (2)"));
     public static Configurable<int> slugcat_symbol_scale = main_mod_options.config.Bind("slugcat_symbol_scale", defaultValue: 10, new ConfigurableInfo("The default value is 100% (10). Each value (5-20) corresponds to 10*value% (50%-200%).", new ConfigAcceptableRange<int>(5, 20), "", "Slugcat Symbol Size (10)"));
 
-    public static Configurable<int> discover_multiplier = main_mod_options.config.Bind("discover_multiplier", defaultValue: 2, new ConfigurableInfo("The default value is two. For a given value X the map around slugcat is discovered (X/2)-times as far.\nWARNING: This will delete and change the size of any loaded region discover texture. The game tries to recover your map progress based on visited rooms.", new ConfigAcceptableRange<int>(1, 10), "", "Discover Multiplier (2)"));
     public static Configurable<int> reveal_speed_multiplier = main_mod_options.config.Bind("reveal_speed_multiplier", defaultValue: 1, new ConfigurableInfo("The default value is one. For a given value X the map is revealed X-times as fast.\nIf the maximum value is selected then opening the map displays known areas instantly instead of revealing them gradually.", new ConfigAcceptableRange<int>(1, 10), "", "Reveal Speed Multiplier (1)"));
+    public static Configurable<int> zoom_slider = main_mod_options.config.Bind("zoom_slider", defaultValue: 10, new ConfigurableInfo("The default value is 100% (10) zoom. Each value (5-15) corresponds to 10*value% (50%-150%) zoom..", new ConfigAcceptableRange<int>(5, 15), "", "Zoom Level (10)"));
 
     //
     // parameters
@@ -205,6 +210,7 @@ public override void Initialize() {
         DrawTextLabels(ref Tabs[tab_index]);
         AddNewLine();
 
+        AddCheckBox(clear_expedition_maps, (string)clear_expedition_maps.info.Tags[0]);
         AddCheckBox(uncover_region, (string)uncover_region.info.Tags[0]);
         DrawCheckBoxes(ref Tabs[tab_index]);
 
@@ -227,13 +233,14 @@ public void Log_All_Options() {
 
         Debug.Log(mod_id + ": Option_AerialMap " + Option_AerialMap);
         Debug.Log(mod_id + ": Option_CreatureSymbols " + Option_CreatureSymbols);
+        Debug.Log(mod_id + ": Option_ClearExpeditionMaps " + Option_ClearExpeditionMaps);
         Debug.Log(mod_id + ": Option_ItemTracker " + Option_ItemTracker);
 
         Debug.Log(mod_id + ": Option_LayerFocus " + Option_LayerFocus);
         Debug.Log(mod_id + ": Option_ShadowSprites " + Option_ShadowSprites);
         Debug.Log(mod_id + ": Option_SkipFade " + Option_SkipFade);
-
         Debug.Log(mod_id + ": Option_SlugcatSymbols " + Option_SlugcatSymbols);
+
         Debug.Log(mod_id + ": Option_UncoverRegion " + Option_UncoverRegion);
         Debug.Log(mod_id + ": Option_UncoverRoom " + Option_UncoverRoom);
     }

SourceCode/MapMod.cs

@@ -1,5 +1,4 @@
 using HUD;
-using IL;
 using MonoMod.Cil;
 using MoreSlugcats;
 using RWCustom;
@@ -9,6 +8,7 @@
 using static HUD.Map;
 using static MapOptions.MainMod;
 using static MapOptions.MainModOptions;
+using static MapOptions.PlayerMod;
 
 namespace MapOptions;
 
@@ -226,7 +226,7 @@ public static void Initialize_Creature_Symbols(Map map, RainWorldGame game) {
 
         foreach (AbstractCreature abstract_player in game.Players) {
             if (abstract_player.realizedCreature is Player player) {
-                PlayerMod.Remove_ObjectInStomach_Symbol(player);
+                Remove_ObjectInStomach_Symbol(player);
             }
         }
     }

SourceCode/MapOptions.csproj

@@ -2,7 +2,7 @@
 
   <PropertyGroup>
     <TargetFramework>net48</TargetFramework>
-    <Version>2.1.5</Version>
+    <Version>2.1.6</Version>
     <Nullable>enable</Nullable>
 	  <LangVersion>10.0</LangVersion>
   </PropertyGroup>

SourceCode/ProcessManagerMod.cs

@@ -24,10 +24,11 @@ public static void Initialize_Option_Specific_Hooks() {
 
         main_mod_options.Log_All_Options();
         Debug.Log(mod_id + ": Initialize option specific hooks.");
-
         can_log_il_hooks = true;
+
         AbstractCreatureMod.On_Config_Changed();
         AbstractRoomMod.On_Config_Changed();
+        ExpeditionMod.On_Config_Changed();
         MapMod.On_Config_Changed();
 
         OverWorldMod.On_Config_Changed();