UniversalSynSaveInstance

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.

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.

Documentation

Documentation

💖 Support Us & Our Work

DISCORD SERVER:

https://discord.com/invite/wx4ThpAsmw / https://discord.gg/wx4ThpAsmw

TO-DOs

• Look into adding support for Binary Format Output (rbxl/rbxm)

• Add table.clone instead {} in some cases if possible

• Support for Model files:

  • rbxmx (xml)
  • rbxm (binary)

• Implement Luau Syntax (important for performance!):

  • Compound Operators
  • Avoid using next, ipairs & pairs
  • Interpolated strings instead of concat Slower
  • Type-checking (😩🙀)
  • if-then-else expressions No reason to
  • Floor division

• Speed things up as much as possible

  • Requires benchmarks

• Support for as many [KRNL-like saveinstance Options] & UNC:

  • Change mode to invalid mode like “custom” if you only want to save ExtraInstances
  • Decompile (! This takes priority over OPTIONS.noscripts if set !)
  • DecompileIgnore
  • DecompileTimeout (! This takes priority over OPTIONS.timeout if set !)
  • ExtraInstances
  • FilePath
  • IgnoreDefaultProps
  • IsolateStarterPlayer
  • NilInstances
  • Object (for .rbxmx files)
  • RemovePlayerCharacters
  • SavePlayers
  • ShowStatus
    • Add Drawing Library support for ShowStatus Can’t reliably test if it’s working on a tool
  • IsolatePlayerGui (same as IsolateLocalPlayer)
  • Callback
  • CopyToClipboard/Clipboard
  • Binary (rbxl/rbxm)

• Remove buffersize, savebuffer & so on for sake of performance by concatenating strings to total string then writing it to file (no extra steps like table.concat) table.concat proved faster in the case of huge amount of concatenations

  • Test table.concat vs string …= with a full buffer (this benchmark differs per usecase)

• Add Option to restart saveinstance from the point that it crashed on (perhaps by skipping)

• Maybe modes should do more than just determining the list of instances to save, like changing IgnoreDefaultProperties to false if mode is “full” for example

• Add Lua & Luau versions instead of merged (WARNING: LUAU MIGHT BE MORE UPDATED THAN LUA VERSION, lua version exists just for the sake of old & bad tools, ask devs of your tools to support luau as its latest & greatest)

• Add Support for multiple Instances to be saved as a model IsModel = true & ExtraInstances

• Force disable ParticleEmitters in case something like IgnorePropertiesOfNotScriptsOnScriptsMode is enabled (they stack in one place and create huge lag) Not needed anymore it seems as empty FlipbookLayout breaks them which also results in no particles

• Be able to specify which special properties you want saved (to avoid saving all)

Acknowledgments

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

• Syngp Synapse X Source code 2019 for base saveinstance code (extended by @mblouka & @Acrillis)
• Moon/LorekeeperZinnia for being the original creator of saveinstance that was used in Synapse X, Elysian and many others. As well as being an inspiration for this project.
• Rojo Rbx Dom Xml for being a fallback documentation in case something wasn’t clear in the Roblox Format Specifications
• Roblox File Format for a list of redirects of old/deprecated xml properties that still use the old tag values
• Roblox Client Tracker for an extended & close to full JSON Api Dump (with hidden properties & default values)

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