Getting started

After importing Simple Save System from the Asset Store, you can immediately use it in your scripts without any additional setup.

Basic saving and loading

Each "Unit" have asynchronous and synchronous saving and loading. To save data with the concrete "Unit" you need to call Serialize/SerializeAsync and for data load DeserializeAsync/Deserialize methods.

Implemented load units

• ImagesCacheUnit for Images(Textures2D)
• JsonCacheUnit for any object
• TextCacheUnit for text(.txt) files

NOTE: you are free to make your custom unit

Serializers

By default, there are two serializers (StringSerializer, BinarySerializer) and one base BaseSerializer. You are also free to implement your custom serializers based on our BaseSerializer. To do that you just need to inherit from BaseSerializer and implement your custom functionality.

Path Config

Path config is a utility to provide easy access to the directory. You can get a path by file name by calling GetFilePath(string fileName) method. It also has a BasePath property which creates a directory when you are trying to refer to that property. You can use this separately from other functionality.

AES Encryption

Simple Save System also provides AES encryption support through the AesEncryptionProvider class. This class implements the IEncryptionProvider interface and offers methods for encrypting and decrypting data using AES. AES (Advanced Encryption Standard) is a widely-used encryption algorithm known for its security and reliability. To use encryption for your data saving you just need to pass AesEncryptionProvider instance to CacheUnit. You can also use AesEncryptionProvider separately.

Logs

We have implemented functionality to log information about saved and loaded files in the console but you can remove that functionality with the "DISABLE_LOG" define symbol.

You can check more information about how to add defined symbols in the unity https://docs.unity3d.com/Manual/CustomScriptingSymbols.html

Assembly Definition

Simple Save System has a separate assembly definition so you can use it in your modules.

Error Handling

It is recommended that you handle errors. This can be performed using a try/catch block to catch exceptions and display an appropriate message to the user when necessary.