Unity-Saver

Encrypted local data storage in Unity runtime on any platform. Thread safe, Unity-Saver uses dedicated non-main thread for Read/Write operations with files. Data can be stored in different locations:

• :white_check_mark: Persistant - Regular Unity PersistantDataStorage location
  • ✔️ iOS
  • ✔️ Android
  • ✔️ Standalone
• :white_check_mark: Local - current location of executed app
  • :x: iOS
  • :x: Android
  • ✔️ Standalone
• :white_check_mark: Custom - any path on your own
  • :x: iOS
  • :x: Android
  • ✔️ Standalone

How to install

• Install ODIN Inspector
• Add this code to /Packages/manifest.json

{
  "dependencies": {
    "extensions.unity.saver": "1.0.6",
  },
  "scopedRegistries": [
    {
      "name": "Unity Extensions",
      "url": "https://registry.npmjs.org",
      "scopes": [
        "extensions.unity"
      ]
    }
  ]
}

Usage API

Usage is very simple, you have access to a data through Data property in saver class.

• Data - current data with read & write permission (does not read and write from file)
• DefaultData - access to default data, this data whould be taken on Load operation, only if file is missed or currupted
• Load() - force to execute load from a file operation, returns async Task
• Save() - insta save current Data to a file, returns async Task
• SaveDelay() - put save operation in a queue, if the same file is going to be saved twice, just single call will be executed. Very useful when data changes very often and required to call Save often as well. You may call SaveDelay as many times as need and do not worry about wasting CPU resources for continuously writing data into file.

How to use in MonoBehaviour

using Extensions.Saver;

public class TestMonoBehaviourSaver : SaverMonoBehaviour<TestData>
{
    protected override string SaverPath => "TestDatabase";
    protected override string SaverFileName => "testMonoBehaviour.data";
}

How to use in ScriptableObject

using UnityEngine;
using Extensions.Saver;

[CreateAssetMenu(menuName = "Example (Saver)/Test Scriptable Object Saver", fileName = "Test Scriptable Object Saver", order = 0)]
public class TestScriptableObjectSaver : SaverScriptableObject<TestData>
{
    protected override string SaverPath => "TestDatabase";
    protected override string SaverFileName => "testScriptableObject.data";

    protected override void OnDataLoaded(TestData data)
    {
        
    }
}

How to use in C# class

using System;
using System.Threading.Tasks;
using Extensions.Saver;

public class TestClassSaver
{
    public Saver<TestData> saver;

    // Should be called from main thread, in Awake or Start method for example
    public void Init()
    {
        saver = new Saver<TestData>("TestDatabase", "testClass.data", new TestData());
    }

    public TestData Load() => saver?.Load();

    public async Task Save(Action onComplete = null) => await saver?.Save(onComplete);
}