SaveManager

What is the SaveManager?

The SaveManager is an addon that allows you to save, load, delete and set autoload configurations in Obsidian.

Quick Start

To quickly get started with the SaveManager addon, you can use the following code:

local repo = "https://raw.githubusercontent.com/deividcomsono/Obsidian/main/"
local Library = loadstring(game:HttpGet(repo .. "Library.lua"))()
local SaveManager = loadstring(game:HttpGet(repo .. "addons/SaveManager.lua"))()
 
local Tabs = {
	Main = Window:AddTab("Main", "user"),
	["UI Settings"] = Window:AddTab("UI Settings", "settings"),
}
 
-- Set the library
SaveManager:SetLibrary(Library)
 
-- Don't save theme settings in configuration
SaveManager:IgnoreThemeSettings()
 
-- Manual Ignore List (will ignore all Toggles/Options with the indexes provided)
-- Here we are ignoring the menu keybind
SaveManager:SetIgnoreIndexes({ "MenuKeybind" })
 
-- Map out folder structure
SaveManager:SetFolder("MyScriptHub/specific-game")
SaveManager:SetSubFolder("Lobby") -- if the game has multiple places inside of it (for example: DOORS)
-- you can use this to save configs for those places separately
-- The path in this script would be: MyScriptHub/specific-game/settings/specific-place
-- [ This is optional ]
 
-- Builds our config menu on the right side of our tab
SaveManager:BuildConfigSection(Tabs["UI Settings"])
 
-- Load the autoload config
SaveManager:LoadAutoloadConfig()

API Reference

Methods

SetLibrary

Sets the library to use for the SaveManager.

SaveManager:SetLibrary(Library)

SetFolder

Sets the folder to use for the SaveManager.

SaveManager:SetFolder(folder)

SetSubFolder

Sets the subfolder to use for the SaveManager. This is not required, but can be used to save configs for specific places inside of the game.

SaveManager:SetSubFolder(subfolder)

SetIgnoreIndexes

Sets the indexes to ignore when saving configs.

SaveManager:SetIgnoreIndexes(indexes)

IgnoreThemeSettings

Adds the default theme-related indexes to the ignore list so configs do not override user themes.

SaveManager:IgnoreThemeSettings()

Save

Serializes the current library state to a JSON file inside the configured folder tree.

local success, err = SaveManager:Save(name)

Returns boolean, string? where the second value contains an error message when the save fails.

Load

Loads a JSON configuration produced by the save method and applies it to the library controls.

local success, err = SaveManager:Load(name)

Returns boolean, string? describing the outcome.

Delete

Removes a configuration file from disk.

local success, err = SaveManager:Delete(name)

Returns boolean, string? describing the outcome.

RefreshConfigList

Scans the folder tree and returns an array of available configuration names (without extensions).

local configs = SaveManager:RefreshConfigList()

Returns { string } of config names.

GetAutoloadConfig

Reads the persistent autoload marker and returns the config name that should be auto-loaded.

local name = SaveManager:GetAutoloadConfig()

Returns a string representing the config name or the literal value "none".

LoadAutoloadConfig

Loads and applies the configuration marked for autoload if a name is stored on disk.

SaveManager:LoadAutoloadConfig()

SaveAutoloadConfig

Sets the configuration that should load automatically on script startup.

local success, err = SaveManager:SaveAutoloadConfig(name)

Returns boolean, string? describing the outcome.

DeleteAutoLoadConfig

Clears the autoload marker so no configuration is loaded automatically.

local success, err = SaveManager:DeleteAutoLoadConfig()

Returns boolean, string? describing the outcome.

BuildConfigSection

Creates the SaveManager UI in your library tab so users can create, load, overwrite and manage configs directly.

SaveManager:BuildConfigSection(tab)

This call also ignores the config management controls when saving.