punkfuncgames/save-module

SaveModule Reference

Package: com.punkfuncgames.save | Define: PUNKFUNC_SAVE Location: Packages/com.punkfuncgames.save/Runtime/PunkFuncGames.Save/ Namespace: PunkFuncGames.Save

ISaveService : IAsyncInitializable

Properties:

• bool IsInitialized, bool HasSaveData
• ReactiveProperty<bool> AutoSaveEnabled
• bool IsCloudSyncAvailable

Lifecycle:

• UniTask InitializeAsync(ct), UniTask SaveAsync(ct), UniTask LoadAsync(ct), DeleteAll()

Key-Value Storage:

• Set<T>(string key, T value) — marks dirty, notifies observers
• T Get<T>(string key, T defaultValue = default)
• bool HasKey(string key), Delete(string key)
• Observable<T> Observe<T>(string key, T defaultValue) — reactive stream for key changes

Metadata:

• SaveMetadata GetMetadata(), SetMetadata(SaveMetadata)

Implementation: SaveService

Dependencies (all optional):

• GameSettings, ISaveSerializer, ISaveEncryption, SaveMigrator, ISteamCloudService
• 7 MessagePipe publishers for events

Defaults: BinarySerializer (MessagePack+LZ4 or JSON fallback), AesEncryption (device-specific key)

Save Flow: Serialize → Compute checksum → Encrypt → Backup existing → Write → Cloud sync Load Flow: Cloud download (if available) → Decrypt → Validate checksum → Migrate → Deserialize → Notify observers

Auto-save: Configurable interval (default 60s), only if dirty

Serialization

ISaveSerializer — Serialize<T>(T), Deserialize<T>(byte[]), SerializeToString<T>, DeserializeFromString<T>

BinarySerializer: Uses MessagePack with LZ4 compression (#if MESSAGEPACK), falls back to JSON (Newtonsoft.Json)

Encryption

AesEncryption : ISaveEncryption

• AES-256, CBC mode, PKCS7 padding, PBKDF2 key derivation (10K iterations, SHA256)
• Device-specific key from SystemInfo.deviceUniqueIdentifier + model + graphicsDeviceID
• Static utilities: ComputeChecksum(byte[]) → SHA256 Base64, VerifyChecksum(byte[], string)

Migration

ISaveMigration — int FromVersion, int ToVersion, SaveData Migrate(SaveData)

SaveMigrator:

• RegisterMigration(ISaveMigration), bool NeedsMigration(SaveData)
• SaveData MigrateToLatest(SaveData) — chains migrations sequentially
• bool HasMigrationPath(int from, int to)

SaveDataVersion: const int V1 = 1, const int Current = V1

Models

SaveData: Version, LastSaved (UTC), Checksum, Dictionary<string, byte[]> Values SaveMetadata: PlayTimeSeconds, CurrentLevel, ProfileName, SlotIndex, Thumbnail (PNG bytes), Custom dict

Events

| Event | Key Fields | |-------|------------| | SaveStartedEvent | SlotIndex | | SaveCompletedEvent | Success, SlotIndex, ErrorMessage | | LoadStartedEvent | SlotIndex | | LoadCompletedEvent | Success, SlotIndex, ErrorMessage | | SaveConflictEvent | LocalSave, CloudSave, OnResolved callback | | CloudSyncCompletedEvent | Success, Direction (Upload/Download), ErrorMessage | | SaveMigratedEvent | FromVersion, ToVersion |

SaveConflictResolution enum: UseCloud, UseLocal, UseMostRecent, KeepBoth

Installer

SaveInstaller.Install(builder, options);
// Registers: AesEncryption (Singleton) with .WithParameter("enabled", true).WithParameter("customSalt", (string)null)
// Registers: BinarySerializer (Singleton)
// Registers: SaveMigrator (Singleton)
// Registers: SaveService (Singleton)
// Events: 7 message brokers

Usage Patterns

// Storing data
_saveService.Set("PlayerLevel", 42);
_saveService.Set("Inventory", myInventoryObject);

// Reading data
int level = _saveService.Get<int>("PlayerLevel", defaultValue: 1);

// Reactive observation
_saveService.Observe<int>("PlayerLevel", 1)
    .Subscribe(level => UpdateLevelUI(level))
    .AddTo(_disposables);

// Creating a migration
public sealed class V1ToV2Migration : ISaveMigration
{
    public int FromVersion => 1;
    public int ToVersion => 2;
    public SaveData Migrate(SaveData data)
    {
        // Transform data as needed
        return data;
    }
}