2.4 KiB
rbxfile
The rbxfile package handles the decoding, encoding, and manipulation of Roblox instance data structures.
This package can be used to manipulate Roblox instance trees outside of the Roblox client. Such data structures begin with a Root struct. A Root contains a list of child Instances, which in turn contain more child Instances, and so on, forming a tree of Instances. These Instances can be accessed and manipulated using an API similar to that of Roblox.
Each Instance also has a set of "properties". Each property has a specific value of a certain type. Every available type implements the Value interface, and is prefixed with "Value".
Root structures can be decoded from and encoded to various formats, including Roblox's native file formats. The two sub-packages bin and xml provide formats for Roblox's binary and XML formats. Root structures can also be encoded and decoded with the json package.
Besides decoding from a format, root structures can also be created manually. The best way to do this is through the declare sub-package, which provides an easy way to generate root structures.
Related
The implementation of the binary file format is based largely on the RobloxFileSpec document, a reverse-engineered specification by Gregory Comer.
Other projects that involve decoding and encoding Roblox files:
- rbx-fmt: An implementation in C.
- LibRbxl: An implementation in C#.
- rbx-dom: An implementation in Rust.
- Roblox-File-Format: An implementation in C#.