|
1 | | -<h1 align="center">Welcome to com.gameframe.saveload 👋</h1> |
| 1 | +<h1 align="center">Gameframe.SaveLoad 👋</h1> |
2 | 2 |
|
3 | 3 | <!-- BADGE-START --> |
4 | 4 | [](https://www.codacy.com/manual/coryleach/UnitySaveLoad?utm_source=github.com&utm_medium=referral&utm_content=coryleach/UnitySaveLoad&utm_campaign=Badge_Grade) |
|
8 | 8 | [](https://twitter.com/coryleach) |
9 | 9 | <!-- BADGE-END --> |
10 | 10 |
|
11 | | -> This is a simple utility for quickly saving and loading objects to disk in unity.</br></br> |
12 | | -> Supports Binary, UnityJson, and JsonDotNet.</br> |
13 | | -> Optionally you can select an encrypted version of each of the above.</br> |
14 | | -> Additionally custom serialization methods are supported using the ISerializationMethod interface.</br> |
15 | | -> JsonDotNet support requires the Json.Net for Unity asset store package or Newtonsoft's Json.</br> |
16 | | -> For info on enabling JsonDotNet support see the <b>Enable Json.Net Support</b> section of this readme.</br> |
| 11 | +Serialization helper utility that supports save, load and encryption. |
17 | 12 |
|
18 | 13 | ## Quick Package Install |
19 | 14 |
|
20 | 15 | #### Using UnityPackageManager (for Unity 2019.3 or later) |
21 | 16 | Open the package manager window (menu: Window > Package Manager)<br/> |
22 | 17 | Select "Add package from git URL...", fill in the pop-up with the following link:<br/> |
23 | | -https://github.com/coryleach/UnitySaveLoad.git#1.0.1<br/> |
| 18 | +https://github.com/coryleach/UnitySaveLoad.git#1.0.2<br/> |
24 | 19 |
|
25 | 20 | #### Using UnityPackageManager (for Unity 2019.1 or later) |
26 | 21 |
|
27 | 22 | Find the manifest.json file in the Packages folder of your project and edit it to look like this: |
28 | 23 | ```js |
29 | 24 | { |
30 | 25 | "dependencies": { |
31 | | - "com.gameframe.saveload": "https://github.com/coryleach/UnitySaveLoad.git#1.0.1", |
| 26 | + "com.gameframe.saveload": "https://github.com/coryleach/UnitySaveLoad.git#1.0.2", |
32 | 27 | ... |
33 | 28 | }, |
34 | 29 | } |
35 | 30 | ``` |
36 | 31 |
|
| 32 | +<!-- DOC-START --> |
| 33 | +<!-- |
| 34 | +Changes between 'DOC START' and 'DOC END' will not be modified by readme update scripts |
| 35 | +--> |
| 36 | + |
37 | 37 | ## Usage |
38 | 38 |
|
39 | 39 | SaveLoadManager is not a singleton. Multiple instances may be used and created.<br /> |
@@ -75,16 +75,19 @@ manager.LoadUnityObjectOverwrite(myScriptableObject,"MyUnityObjectData.data"); |
75 | 75 | Ensure the Json.Net for Unity package has been imported.</br> |
76 | 76 | In player settings add the string 'JSON_DOT_NET' to Scripting Define Symbols. |
77 | 77 |
|
| 78 | +<!-- DOC-END --> |
| 79 | + |
78 | 80 | ## Author |
79 | 81 |
|
80 | 82 | 👤 **Cory Leach** |
81 | 83 |
|
82 | 84 | * Twitter: [@coryleach](https://twitter.com/coryleach) |
83 | 85 | * Github: [@coryleach](https://github.com/coryleach) |
84 | 86 |
|
| 87 | + |
85 | 88 | ## Show your support |
86 | 89 |
|
87 | 90 | Give a ⭐️ if this project helped you! |
88 | 91 |
|
89 | 92 | *** |
90 | | -_This README was generated with ❤️ by [readme-md-generator](https://github.com/kefranabg/readme-md-generator)_ |
| 93 | +_This README was generated with ❤️ by [Gameframe.Packages](https://github.com/coryleach/unitypackages)_ |
0 commit comments