KingEnderBrine-ProperSave icon

ProperSave

Saves your progress at the start of the stage so you can load later

Last updated 5 months ago
Total downloads 154762
Total rating 70 
Categories Mods Tweaks Client-side
Dependency string KingEnderBrine-ProperSave-2.7.0
Dependants 49 other mods depend on this mod

This mod requires the following mods to function

bbepis-BepInExPack-5.3.1 icon
bbepis-BepInExPack

Unified BepInEx all-in-one modding pack - plugin framework, detour library

Preferred version: 5.3.1
XoXFaby-MMHOOK_Standalone-1.0.1 icon
XoXFaby-MMHOOK_Standalone

Standalone MMHOOK_Assembly-CSharp for other mods to depend on.

Preferred version: 1.0.1

README

Description

Saves your progress at the start of each stage. You can leave run as soon as the stage started.
Only 1 save file for each profile for a singleplayer. If you die, the save will be deleted.

Multiplayer support

Only the host must have this mod for it to work.
A Load button will be active if you are host and was found suitable save file (if save file has the same set of players as in the current lobby).

Game modes support

Each game mode (for now Classic and Eclipse) has it's own save files, so that you can switch between game modes and not losing your progress.

For mod developers

Saving

To save data you need to subscribe to ProperSave.SaveFile.OnGatgherSaveData. It will be called every time the game is saved (this happens on RoR2.Stage.onStageStartGlobal) to gather info from mods that needs to be saved. You can add any value with any key, but remember that other mods can do the same thing, so keep keys unique (maybe add a mod name in front or something).
I would suggest adding only one object per mod because the type of the object is also stored to be able to deserialize objects, and it can take a lot of space in comparison with stored value.
An object that you add in the dictionary will be serialized to JSON. Here is some info about serialization:

  • Only public properties/fields will be serialized.
  • You can add [DataMember()] attribute from System.Runtime.Serialization to specify custom name for property/field in json file.
  • You can add [IgnoreDataMember] attribute from System.Runtime.Serialization to specify that this public property/field should be ignored on serialization.

Loading

Once save file is loaded you can get data you've previously saved and apply it anytime you want. Here are some things that will help you with that:

  • ProperSave.Loading.IsLoading - you can use this to check if the ProperSave is loading.
  • ProperSave.Loading.FirstRunStage - you can use this to check if run is starting. Is set to true on RoR2.Run.Start, is set to false on RoR2.Stage.onStageStartGlobal
  • ProperSave.Loading.OnLoadingStarted - event, fired when IsLoading set to true (this happens after save file is loaded into memory, before run started).
  • ProperSave.Loading.OnLoadingEnded - event, fired when IsLoading set to false (this happens after RoR2.TeamManager.Start because this is the last step of loading process).
  • ProperSave.Loading.CurrentSave - current save file, you can access it after OnLoadingStarted. Will be overwritten every time game is saved.
  • CurrentSave.GetModdedData<Type>("") - use this method to get data that you've saved.
  • ProperSave.Data - under this namespace you can find classes used to save some of vanilla data.

Known issues

I tried to save all necessary data so that when you load the game would continue as it should have been without saving.

  • Minions would respawn at different positions each time you load the same save file. It's not big of an issue, and there is nothing I can do about it.
  • I've not tested this mod much with achievements unlocking, but for most, if not all cases, it should be working as intended.

Changelog

2.7.0

  • Remove r2api dependency

2.6.1

  • Fixed time display in lobby save info.

2.6.0

  • Added tooltip with short save info when hower over Load button or hold load button on a gamepad.

2.5.3

  • Added text to a quit confirmation dialog which informs you when the game was saved last time.
  • Updated chat message, now it includes a stage name at which the game was saved.

2.5.2

  • Fixed an issue where the mod was trying to save while being a client in a multiplayer game.

2.5.1

  • Fixed an issue where after loading Monsoon run you sometimes didn't get mastery skin.

2.5.0

  • Added mods support. Now any other dev can add data they want to be saved from their mods.
  • A lot of refactoring.

2.4.5

  • Fixed StartingItemsGUI support. Hopefully, this is the last time. Thanks Phedg1 for making changes to StartingItemsGUI that will make my mod support last longer.

2.4.4

  • Fixed StartingItemsGUI support.

2.4.3

  • Fixed an issue where the game would be saved in the ending cutscene and you could load in it if you restart the game.

2.4.2

  • Changed artifacts saving. Now they are saved at the start of the stage (previously they were saved at the start of the run).

2.4.1

  • Fixed StartingItemsGUI support.

2.4.0

  • Updated for 1.0.1.1 version. Old saves are not compatible with new version!

2.3.2

  • Fixed StartingItemsGUI support. (This time for real)

2.3.1

  • Fixed TemporaryLunarCoins support.
  • Fixed StartingItemsGUI support.

2.3.0

  • Added ShareSuite support. (No longer reseting gold to 0 when loading run).
  • Added BiggerBazaar support.

2.2.2

  • Fixed Load button being active when returned to lobby after death.

2.2.1

  • Updated langauge stuff

2.2.0

  • Updated for RoR2 release.
  • Removed Continue button from the main menu (for game modes support).
  • Game modes support.

2.1.1

  • Fixed a bug: when entering the lobby when using a gamepad is causing the lobby glitches.

2.1.0

  • Added StartingItemsGUI support. (Items adding disabled while loading the game). Requested by Thunderer1101 on GitHub.

2.0.0

  • Changed save files structure, because of that, old version saves would be ignored, so consider end saved runs before updating.
  • Added multiplayer support.
  • Fixed an issue with lockbox from Rusted key not spawned when loading game.
  • Saving some artifacts info for consistent gameplay.
  • Fixed an issue for characters added by mods, when their loadouts weren't saved.
  • Some minor fixes

1.1.0

  • Added TemporaryLunarCoins mod support. When loading game lunar coins will be restored.

1.0.1

  • Fixed crash when the mod was installed using mod managers.
  • Saving lunar coins drop chance.

1.0.0

  • Mod release.

Available versions

Please note that the install buttons only work if you have compatible client software installed, such as the Thunderstore Mod Manager. Otherwise use the zip download links instead.

Upload date Version number Downloads Download link  
2021-3-31 2.7.0 48697 Version 2.7.0 Install
2021-1-4 2.6.1 28470 Version 2.6.1 Install
2020-12-12 2.6.0 7082 Version 2.6.0 Install
2020-12-10 2.5.3 909 Version 2.5.3 Install
2020-12-2 2.5.2 2710 Version 2.5.2 Install
2020-9-28 2.5.1 17007 Version 2.5.1 Install
2020-9-26 2.5.0 2215 Version 2.5.0 Install
2020-9-12 2.4.5 13707 Version 2.4.5 Install
2020-9-9 2.4.4 3009 Version 2.4.4 Install
2020-9-8 2.4.3 1524 Version 2.4.3 Install
2020-9-4 2.4.2 4740 Version 2.4.2 Install
2020-9-2 2.4.1 3285 Version 2.4.1 Install
2020-9-1 2.4.0 1760 Version 2.4.0 Install
2020-8-30 2.3.2 2521 Version 2.3.2 Install
2020-8-30 2.3.1 198 Version 2.3.1 Install
2020-8-29 2.3.0 1276 Version 2.3.0 Install
2020-8-22 2.2.2 3657 Version 2.2.2 Install
2020-8-18 2.2.1 2515 Version 2.2.1 Install
2020-8-17 2.2.0 1111 Version 2.2.0 Install
2020-6-18 2.1.1 3593 Version 2.1.1 Install
2020-6-7 2.1.0 1041 Version 2.1.0 Install
2020-5-15 2.0.0 1718 Version 2.0.0 Install
2020-4-28 1.1.0 1248 Version 1.1.0 Install
2020-4-27 1.0.1 340 Version 1.0.1 Install
2020-4-25 1.0.0 429 Version 1.0.0 Install