Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/IntoTheDev/Save-System-for-Unity
Save System for Unity with AOT (IL2CPP) and assets references support.
https://github.com/IntoTheDev/Save-System-for-Unity
filesystem game-development save save-and-load savegame unity unity-asset unity-scripts unity3d
Last synced: 3 months ago
JSON representation
Save System for Unity with AOT (IL2CPP) and assets references support.
- Host: GitHub
- URL: https://github.com/IntoTheDev/Save-System-for-Unity
- Owner: IntoTheDev
- Created: 2019-09-11T17:14:00.000Z (over 5 years ago)
- Default Branch: master
- Last Pushed: 2024-06-24T14:01:19.000Z (7 months ago)
- Last Synced: 2024-11-05T06:33:46.455Z (3 months ago)
- Topics: filesystem, game-development, save, save-and-load, savegame, unity, unity-asset, unity-scripts, unity3d
- Language: C#
- Homepage:
- Size: 507 KB
- Stars: 229
- Watchers: 9
- Forks: 18
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- Changelog: Changelog.md
Awesome Lists containing this project
README
# Save System for Unity
### TODO
- [x] Assets References
- [x] AOT support
- [x] Upload MessagePack version to separate branch? MessagePack version has better performance and less file size (WIP)
## Features
- Can save pretty much everything (Vector, Quaternion, Array, List, Class, Struct, etc)
- Can save assets references
- As easy to use as PlayerPrefs
- Fast in terms of performance. Even simple int saving way more faster than ```PlayerPrefs.SetInt()```. Performance test at the end of README
- Save files are encrypted
- Multiple profiles
## How to Install
### Git Installation (Best way to get latest version)
If you have Git on your computer, you can open Package Manager indside Unity, select "Add package from Git url...", and paste link ```https://github.com/IntoTheDev/Save-System-for-Unity.git```
or
Open the manifest.json file of your Unity project.
Add ```"com.intothedev.savesystem": "https://github.com/IntoTheDev/Save-System-for-Unity.git"```
### Manual Installation (Version can be outdated)
Download latest package from the Release section.
Import SaveSystem.unitypackage to your Unity Project
## Usage
### Saving
```csharp
float health = 100f;
DataSerializer.Save("SaveKeyHere", health);
```
### Loading
```csharp
float health = DataSerializer.Load("SaveKeyHere");
```
### Check for key
```csharp
if (DataSerializer.HasKey("SaveKeyHere"))
float health = DataSerializer.Load("SaveKeyHere");
// OR
float health;
if (DataSerializer.TryLoad("SaveKeyHere", out float value))
health = value;
```
### Delete key
```csharp
DataSerializer.DeleteKey("SaveKeyHere");
```
### Delete all save file data
```csharp
DataSerializer.DeleteAll();
```
### Change profile. Old profile will be saved and new one is loaded.
```csharp
DataSerializer.ChangeProfile(profileIndex: 1);
```
### Complex example
```csharp
using System.Collections.Generic;
using ToolBox.Serialization;
using UnityEngine;
public class Player : MonoBehaviour
{
[SerializeField] private float _health = 0f;
[SerializeField] private List _inventory = new List();
private const string SAVE_KEY = "PlayerSaveData";
private void Awake()
{
DataSerializer.FileSaving += FileSaving;
if (DataSerializer.TryLoad(SAVE_KEY, out var loadedData))
{
_health = loadedData.Health;
transform.position = loadedData.Position;
_inventory = loadedData.Inventory;
}
}
// This method will be called before application quits
private void FileSaving()
{
DataSerializer.Save(SAVE_KEY, new SaveData(_health, transform.position, _inventory));
}
}
// If you want to make scriptable object or any other asset saveable then you need to add that asset to Assets Container.
// See guide below
[CreateAssetMenu]
public class Item : ScriptableObject
{
[SerializeField] private string _name = string.Empty;
[SerializeField] private int _cost = 100;
}
public struct SaveData
{
[SerializeField] private float _health;
[SerializeField] private Vector3 _position;
[SerializeField] private List _inventory;
public float Health => _health;
public Vector3 Position => _position;
public List Inventory => _inventory;
public SaveData(float health, Vector3 position, List inventory)
{
_health = health;
_position = position;
_inventory = inventory;
}
}
```
### How to make asset saveable
1. Open ```Assets Container``` window. Window/Assets Container. Window looks like this:
2. Select path where your assets stored. If you already have path field then press the ```Select Path``` button or ```Add Path``` if not. In my case path is ```Assets/ScriptableObjects/Items```.
3. Press the ```Load assets at paths``` button.
4. Repeat step 3 every time you create a new asset.
### AOT platforms
AOT (IL2CPP) works without any additional work, but IF some types do NOT serialize, please follow the steps below.
You need to create a simple C# class that implements the ```ITypeProvider``` interface. Then, you need to define the types that fail to save for some reason.
Although it should work without an ITypeProvider, for the sake of simplicity, I'll use the case above as an example.
```csharp
using System;
using System.Collections.Generic;
using ToolBox.Serialization;
using UnityEngine;
public sealed class TestProvider : ITypeProvider
{
public Type[] GetTypes()
{
return new Type[]
{
typeof(SaveData),
typeof(Vector3),
typeof(List)
};
}
}
```
## Performance test
### PlayerPrefs result: 329 milliseconds
### Code:
```csharp
using Sirenix.OdinInspector;
using System.Diagnostics;
using UnityEngine;
public class Tester : MonoBehaviour
{
[SerializeField] private int _number = 0;
[Button]
private void Test()
{
Stopwatch stopwatch = new Stopwatch();
stopwatch.Start();
for (int i = 0; i < 10000; i++)
{
PlayerPrefs.SetInt("SAVE", _number);
_number = PlayerPrefs.GetInt("SAVE");
}
stopwatch.Stop();
print(stopwatch.Elapsed.TotalMilliseconds);
}
}
```
### DataSerializer result: 18 milliseconds
### Code:
```csharp
using Sirenix.OdinInspector;
using System.Diagnostics;
using ToolBox.Serialization;
using UnityEngine;
public class Tester : MonoBehaviour
{
[SerializeField] private int _number = 0;
[Button]
private void Test()
{
Stopwatch stopwatch = new Stopwatch();
stopwatch.Start();
for (int i = 0; i < 10000; i++)
{
DataSerializer.Save("SAVE", _number);
_number = DataSerializer.Load("SAVE");
}
stopwatch.Stop();
print(stopwatch.Elapsed.TotalMilliseconds);
}
}
```
## License
[DataSerializer](https://github.com/IntoTheDev/Save-System-for-Unity/tree/master/DataSerializer) folder is licensed under the MIT License, see [LICENSE](https://github.com/IntoTheDev/Save-System-for-Unity/blob/master/DataSerializer/LICENSE) for more information.
[OdinSerializer](https://github.com/IntoTheDev/Save-System-for-Unity/tree/master/OdinSerializer) folder is licensed under the Apache-2.0 License, see [LICENSE](https://github.com/IntoTheDev/Save-System-for-Unity/blob/master/OdinSerializer/LICENSE) for more information. Odin Serializer belongs to [Team Sirenix](https://github.com/TeamSirenix)