Settings System

Settings System file is saved Separate from game saves: Settings are global, not per slot.

All of this is already handled in the Showcase Settings Menu, but below you´ll find the required API to expand your Settings System as required.

Quick Start

You can Save & Load custom metadata ( like Settings ) given the following API.

using OmniSave.Settings;

// Save settings
await SettingsManager.SetSetting("Audio.MasterVolume", 0.8f);
await SettingsManager.SetSetting("Graphics.Quality", 2);

// Load settings
float volume = SettingsManager.GetSetting("Audio.MasterVolume", 1.0f);
int quality = SettingsManager.GetSetting("Graphics.Quality", 1);

Auto-Save (Default)

// Auto-saves by default
await SettingsManager.SetSetting("Controls.Sensitivity", 2.5f);

// Disable auto-save
SettingsManager.AutoSave = false;
await SettingsManager.SetSetting("test", 123);
await SettingsManager.SaveAsync(); // Manual save

Event-Driven Updates

void Start()
{
    SettingsManager.OnSettingChanged += OnSettingChanged;
}

void OnSettingChanged(string key, object value)
{
    if (key == "Audio.MasterVolume")
    {
        AudioListener.volume = (float)value;
    }
    else if (key == "Graphics.VSyncCount")
    {
        QualitySettings.vSyncCount = (int)value;
    }
}

Custom Setting Types

[System.Serializable]
public class GraphicsSettings
{
    public int qualityLevel = 2;
    public bool fullscreen = true;
    public int resolutionWidth = 1920;
    public int resolutionHeight = 1080;
}

// Save
var graphics = new GraphicsSettings();
await SettingsManager.SetSetting("Graphics", graphics);

// Load
var graphics = SettingsManager.GetSetting("Graphics", new GraphicsSettings());

Settings vs Game Saves

Feature	Settings	Game Saves
Storage	user_settings.json	game_save_{slot}.json
Scope	Global (all slots)	Per slot
Use Cases	Audio, graphics, controls, custom metadata, etc...	Gameplay state
Auto-save	Yes (configurable)	Manual trigger

---