UniversalSynSaveInstance README

The project's README from github.com/luau/UniversalSynSaveInstance. As one markdown file: README.md.

[!IMPORTANT] Independent, unofficial project. Not affiliated with, endorsed by, or officially connected to Roblox Corporation. "Luau" is a trademark of Roblox Corporation.

Loadstring

local Params = {
 RepoURL = "https://raw.githubusercontent.com/luau/UniversalSynSaveInstance/main/",
 SSI = "saveinstance",
}
local synsaveinstance = loadstring(game:HttpGet(Params.RepoURL .. Params.SSI .. ".luau", true), Params.SSI)()
local Options = {} -- Documentation here https://luau.github.io/UniversalSynSaveInstance/api/UniversalSynSaveInstance
synsaveinstance(Options)

Universal Syn Save Instance

Or shortly USSI, a project aimed at resurrecting saveinstance function from Synapse X.
Reason: Many tools fail miserably at providing good user experience when it comes to tinkering with saving instances.

[!WARNING] As stated under the Section 7 (b) in the LICENSE:

  • You MUST always include the following Credit string: UniversalSynSaveInstance https://discord.gg/wx4ThpAsmw
  • You are NOT allowed to claim authorship of the source code provided in this repository
  • You MUST always include the following License

Disclaimer

This project is provided for development, debugging, archival, and research purposes within the Roblox platform.

It is not intended for misuse, including violating platform rules, unauthorized access, or redistribution of content without permission.

Users are responsible for ensuring their usage complies with all applicable rules, including Roblox’s Terms of Use.

The maintainers do not support or condone misuse of this software and are not responsible for how it is used.

[!TIP] If this script is helpful to you, please click ⭐ Star in the upper right corner of the page to support it, thank you!

Documentation

Documentation

💖 Support Us & Our Work

Buy Me a Coffee at ko-fi.com ko-fi
ko-fi

DISCORD SERVER:

https://discord.com/invite/wx4ThpAsmw / https://discord.gg/wx4ThpAsmw
Our Official Discord Server!

TO-DOs

Acknowledgments

[!IMPORTANT] This document is based largely on the efforts of @Anaminus & @Dekkonot, authors of the Roblox Format Specifications. Additional resources include:

*** View source code of this file for more credits

UniversalSynSaveInstance (luau/UniversalSynSaveInstance)

Searching Database…

What is this?USSI is a Luau script that revives the saveinstance function from Synapse X, so you can save Roblox game instances to files. It is an independent, unofficial project, not affiliated with Roblox.
Is it an app or a library?Neither exactly. It is a script you run inside a Roblox executor, and it writes Roblox files such as rbxl, rbxm and rbxmx.
How do I start using it?Use the Loadstring snippet from the README in an executor that supports the saveinstance API, then call it with options such as FilePath.
Which executor do I need?The README does not name one. It targets KRNL-like saveinstance options and the UNC standard, so you need an executor that supports those.
Are there known gaps?Yes. The TODO list still has open items such as type-checking, floor division, resuming a crashed save, and choosing which special properties to save.
Who is it meant for?The README says it is for development, debugging, archival and research on Roblox. It warns against misuse such as violating platform rules or redistributing content without permission.
What are the license terms?GitHub detects no standard license. The README says the LICENSE requires keeping the credit string 'UniversalSynSaveInstance', not claiming authorship of the code, and including the license.
What file formats can it save?It writes binary Roblox files (rbxl/rbxm) and XML model files (rbxmx). The TODO list marks both support items as done.
Can it decompile scripts while saving?Yes. There is a Decompile option along with DecompileIgnore and DecompileTimeout. The README says Decompile overrides OPTIONS.noscripts if it is set.
Why did the author revive saveinstance?The README says many tools handle saving instances poorly, so the project brings back the Synapse X function with a better user experience.
Creator
luau
Size
5.6 MB
Stars
1.2K
Updated
CommitNov 16
Age
3y
Commits · 90 Days