CommonAPI-DSPModSave icon

DSPModSave

Library that allows to store mod save data separately from vanilla saves

Last updated 2 months ago
Total downloads 199478
Total rating 9 
Categories Libraries
Dependency string CommonAPI-DSPModSave-1.2.2
Dependants 27 other packages depend on this package

This mod requires the following mods to function

xiaoye97-BepInEx-5.4.11 icon
xiaoye97-BepInEx

BepInEx5.4.11 mod plugin framework, Mod框架

Preferred version: 5.4.11

README

DSP Mod Save

This library allows to store mod save data separately from vanilla saves. It works by storing a separate file along each save file. In that file data of all mods is stored.

Installation

With Mod Manager

Simply open the mod manager (if you don't have it install it here), select DSP Mod Save by CommonAPI, then Download.

If prompted to download with dependencies, select Yes.

Then just click Start modded, and the game will run with the mod installed.

Manually

Install BepInEx from here

Unzip all files into Dyson Sphere Program/BepInEx/plugins/DSPModSave/. (Create folder named DSPModSave)

Developing using DSP Mod Save

If you are a mod developer and want to use this library:

  • Add DSPModSave to your references. You can use this nuget to do so.
  • Implement IModCanSave interface in your plugin class:
[BepInPlugin(GUID, NAME, VERSION)]

[BepInDependency(DSPModSavePlugin.MODGUID)]
public class MyPlugin : BaseUnityPlugin
{
    public const string MODID = "myplugin";
    public const string GUID = "org.myname.plugin." + MODID;
    public const string NAME = "My Plugin";
    
    public void Import(BinaryReader r)
    {
        // Load your saved data here
    }

    public void Export(BinaryWriter w)
    {
        // Save your data here
    }

    public void IntoOtherSave()
    {
        // Initialize here. This method will only be called if there is no saved data.
    }
}
  • Don't forget to include CommonAPI-DSPModSave-1.1.0 to your mod manifest file.

Originally released by crecheng here. Reuploading since crecheng no longer maintains the mod.

Feedback and Bug Report

Feel free to contact me via Discord (Kremnev8#3756) for any feedback, bug-reports or suggestions.