https://github.com/rimurudev/unity-jsonsaveloadservice

🐈JsonSaveLoadService is a flexible and powerful service designed for saving and loading data in Unity applications. It supports various data types including primitives, custom objects, and collections like Dictionary, HashSet, List, Queue, and Stack. This service ensures cross-platform compatibility (PC, Android, Web) and includes functionality fo
https://github.com/rimurudev/unity-jsonsaveloadservice

json json-data local-save newtonsoft-json rimuru-dev rimurudev save save-load save-load-model save-system serialization simple-json unity-json unity-package unity-save

Last synced: 6 days ago
JSON representation

🐈JsonSaveLoadService is a flexible and powerful service designed for saving and loading data in Unity applications. It supports various data types including primitives, custom objects, and collections like Dictionary, HashSet, List, Queue, and Stack. This service ensures cross-platform compatibility (PC, Android, Web) and includes functionality fo

• Host: GitHub
• URL: https://github.com/rimurudev/unity-jsonsaveloadservice
• Owner: RimuruDev
• License: mit
• Created: 2024-02-28T07:19:25.000Z (9 months ago)
• Default Branch: main
• Last Pushed: 2024-03-01T08:42:12.000Z (9 months ago)
• Last Synced: 2024-03-01T09:44:25.737Z (9 months ago)
• Topics: json, json-data, local-save, newtonsoft-json, rimuru-dev, rimurudev, save, save-load, save-load-model, save-system, serialization, simple-json, unity-json, unity-package, unity-save
• Language: C#
• Homepage:
• Size: 19.5 KB
• Stars: 1
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
🐈 Json Save Load Service 🐈



  

    

  

  

    

  

  

    

  

  

    

  

  

    

  

  

    

  

  

    

  

  

    

  

  

    

  



## Overview

`JsonSaveLoadService` is a flexible and powerful service designed for saving and loading data in Unity applications. It supports various data types including primitives, custom objects, and collections like Dictionary, HashSet, List, Queue, and Stack. This service ensures cross-platform compatibility (PC, Android, Web) and includes functionality for handling default values when loading data for the first time.

## Dependencies

This service requires the Newtonsoft.Json library for JSON serialization and deserialization. Specifically, it depends on the Unity package `com.unity.nuget.newtonsoft-json` version `3.2.1`.

## Installing Newtonsoft.Json in Unity

To use `JsonSaveLoadService` in your project, you must first ensure that Newtonsoft.Json is properly installed. Follow these steps to install the Newtonsoft.Json package through Unity's Package Manager:

1. Open your Unity project.

2. Navigate to `Window` > `Package Manager`.

3. Click the `+` button in the top left corner of the Package Manager window.

4. Select `Add package from git URL...`.

5. Enter `[email protected]` and click `Add`.

6. Unity will download and install the Newtonsoft.Json package.

Alternatively, you can manually edit your project's `Packages/manifest.json` file to include the following line in the `dependencies` section:

```json

"com.unity.nuget.newtonsoft-json": "3.2.1"

```

## Usage

### Saving Data

```csharp

var saveLoadService = new JsonSaveLoadService();

// Saving a simple data type :D

int highScore = 100;

saveLoadService.Save(highScore, "highScore");

// Saving a custom object :D

var playerData = new PlayerData { Name = "Rimuru", Level = 10 };

saveLoadService.Save(playerData, "playerData");

// Saving a collection :D

var scores = new List { 100, 200, 300 };

saveLoadService.Save(scores, "scores");

```

### Loading Data

```csharp

var loadedHighScore = saveLoadService.Load("highScore", 0);

var loadedPlayerData = saveLoadService.Load("playerData", new PlayerData());

var loadedScores = saveLoadService.Load("scores", new List());

```

### Working with Collections

- **Dictionary**: Save and load `Dictionary` collections.

    ```csharp

    var monsterConfigs = new Dictionary

    {

        { 1, new MonsterConfig { /* Initialization */ } },

    };

    saveLoadService.Save(monsterConfigs, "monsterConfigs");

    var loadedMonsterConfigs = saveLoadService.Load("monsterConfigs", new Dictionary());

    ```

- **HashSet**: Save and load `HashSet` collections.

    ```csharp

    var uniqueItems = new HashSet { "Sword", "Shield" };

    saveLoadService.Save(uniqueItems, "uniqueItems");

    var loadedUniqueItems = saveLoadService.Load("uniqueItems", new HashSet());

    ```

- **List**: Save and load `List` collections.

    ```csharp

    var itemList = new List { "Apple", "Banana" };

    saveLoadService.Save(itemList, "itemList");

    var loadedItemList = saveLoadService.Load("itemList", new List());

    ```

- **Queue**: Save and load `Queue` collections.

    ```csharp

    var messageQueue = new Queue();

    messageQueue.Enqueue("Hello");

    messageQueue.Enqueue("World");

    saveLoadService.Save(messageQueue, "messageQueue");

    var loadedMessageQueue = saveLoadService.Load("messageQueue", new Queue());

    ```

- **Stack**: Save and load `Stack` collections.

    ```csharp

    var undoCommands = new Stack();

    undoCommands.Push("Command1");

    undoCommands.Push("Command2");

    saveLoadService.Save(undoCommands, "undoCommands");

    var loadedUndoCommands = saveLoadService.Load("undoCommands", new Stack());

    ```

## Editor-Only Custom Path

For ease of debugging and testing in the Unity Editor, `JsonSaveLoadService` allows specifying a custom save path:

```csharp

#if UNITY_EDITOR

JsonSaveLoadService.SetCustomPathInEditor("Assets/Saves");

#endif

```