1- # Save System
1+ # Unity - Save System
22
33[ Save System] ( https://github.com/DerKekser/unity-save-system ) is a simple save system for Unity.
44It allows you to save and load scene objects and their components.
55
66## Contents
77- [ Saving and Loading] ( #saving-and-loading )
8- - [ Using the Saveable Component] ( #using-the-saveable -component )
8+ - [ Using the Savable Component] ( #using-the-savable -component )
99- [ Prefab Registry] ( #prefab-registry )
10- - [ Create your own Saveable Component] ( #create-your-own-saveable -component )
10+ - [ Create your own Savable Component] ( #create-your-own-savable -component )
1111- [ Data Types] ( #data-types )
1212- [ Supported Types] ( #supported-types )
1313- [ Install via git URL] ( #install-via-git-url )
@@ -25,7 +25,7 @@ using Kekser.SaveSystem;
2525SaveLoadManager .Save (path );
2626SaveLoadManager .Load (path );
2727```
28- ### Using the Saveable Component
28+ ### Using the Savable Component
2929
3030You can save and load a scene object by adding the ` Savable ` component to it.
3131You can use it on any scene object, but it is recommended to use it on Prefabs.
@@ -44,10 +44,9 @@ This is a manual process, and needs to be done every time you add a new prefab t
4444
4545![ Prefab Registry] ( /Assets/Kekser/Screenshots/create_update_prefab_registry.png )
4646
47- ### Create your own Saveable Component
48-
49- You can create your own saveable component by using the ` Savable ` , ` Save ` or ` Load ` attribute.
47+ ### Create your own Savable Component
5048
49+ You can create your own savable component by using the ` Savable ` , ` Save ` or ` Load ` attribute.\
5150#### Fields
5251``` csharp
5352using Kekser .SaveSystem ;
@@ -73,13 +72,14 @@ private void Load(DataObject data)
7372 _score = dataObject .Get <DataElement >(" Score" ).ToObject <int >();
7473}
7574```
75+ * These attributes are also usable on static fields and methods.*
7676### Data Types
7777#### DataObject
7878The ` DataObject ` class is a dictionary that contains other ` DataObject ` , ` DataArray ` and ` DataElement ` objects.
7979#### DataArray
8080The ` DataArray ` class is a list that contains other ` DataObject ` , ` DataArray ` and ` DataElement ` objects.
8181#### DataElement
82- The ` DataElement ` class is a wrapper for any supported objects .
82+ The ` DataElement ` class is a wrapper for any [ supported types ] ( #supported-types ) .
8383
8484### Supported Types
8585- ` byte[] `
@@ -104,11 +104,11 @@ The `DataElement` class is a wrapper for any supported objects.
104104
105105### Install via git URL
106106
107- You can add this package to your project by adding this git URL
108-
107+ You can add this package to your project by adding this git URL to the package manager:
109108```
110109https://github.com/DerKekser/unity-save-system.git?path=Assets/Kekser/SaveSystem
111110```
111+ ![ Package Manager] ( /Assets/Kekser/Screenshots/package_manager.png )
112112### License
113113
114114This library is under the MIT License.
0 commit comments