Settings & Configuration
Omni Save allows to set-up and customize the Save & Load system super easily though a file called SaveSettings. You can either locate SaveSettings file in Assets/OmniSave/Resources( If missing, create one: Right Click > Create > OmniSave > Settings ) or open the Omni Save Hub by pressing Alt + O and navigating to Set-Up > Manual Set-Up.
General Settings
Default Save Name: Default name for save files
Prefab Loading
Prefab Loader: Prefab loading system.
Resources: Prefabs are loaded from the Resources Folder. Simplier approach, excels at prototyping phase.
Addressables: Requires Addressables Package ( OmniSave Includes it as a Dependency ). Recommended approach for commercial games.
Versioning
Save Format Version: Increment this when you change save structure ( 1.0.0, 1.1.0, etc... )
Save On Scene Change: Automatically save when the scene changes ( Recommended )
Save On Quit: Automatically save when closing the game ( Recommended )
Load On Start: Automatically Load the Game when starting it ( Recommended )
Auto Restore Scene Data: Restore scene state when revisiting scenes ( Recommended )
Scene Filtering
Filter Mode:
None: save all scenes.
Blacklist: skip scenes in list.
Whitelist: only save scenes in list.
Filtered Scenes: Scenes to filter. Blacklist = skip these. Whitelist = only save these.
Use Encryption: Enable AES-256 encryption. Protects your files from easily being accessed and edited.
Use Compression: Enable GZip Compression for save files. If true, reduces the file size.
User Settings
Encrypt Settings: Enable AES-256 Encryption for user settings ( Graphics, Video, etc... )
Compress Settings: Compress User Settings. These are stored in a different file than game and metadata.
Error Handling
Use Checksum Validation: Add checksum to detect corrupted saves
Disk Write Retries: Retry attempts for failed disk writes
Allow Partial Saves: Continue if one object fails to save ( RECOMMENDED)
Show Partial Save Warnings: Show warning when partial save/load happens
Size Limits
Max Size MB: Max save size in MB. 0 = unlimited. Warning at 80% if warnOnLargeSize is enabled.
Warn On Large Size: Warn when save gets large
Log Save Size: Log save size in console ( For Development Debugging )
Platform Support
Show Platform Capabilities: Show platform storage info on startup
Paths
Custom Save Path: Custom save path. Empty = use PersistentDataPath
Last updated