Remodel is a command line tool to manipulate Roblox files and the instances contained within them. It's intended as a building block for Roblox automation tooling.
Remodel is still in early development, but much of its API is already fairly stable. Feedback is welcome!
You can download pre-built Windows and macOS binaries from Remodel's GitHub Releases page.
You'll need Rust 1.37+.
bash
cargo install remodel
You'll need Rust 1.37+.
bash
cargo install --git https://github.com/rojo-rbx/remodel
Most of Remodel's interface is its Lua API. Users write Lua 5.3 scripts that Remodel runs, providing them with a special set of APIs.
One use for Remodel is to break a place file apart into multiple model files. Imagine we have a place file named my-place.rbxlx that has some models stored in ReplicatedStorage.Models.
We want to take those models and save them to individual files in a folder named models.
```lua local game = remodel.readPlaceFile("my-place.rbxlx")
-- If the directory does not exist yet, we'll create it. remodel.createDirAll("models")
local Models = game.ReplicatedStorage.Models
for _, model in ipairs(Models:GetChildren()) do -- Save out each child as an rbxmx model remodel.writeModelFile(model, "models/" .. model.Name .. ".rbxmx") end ```
For more examples, see the examples folder.
remodel.readPlaceFile
remodel.readPlaceFile(path: string): Instance
Load an rbxlx file from the filesystem.
Returns a DataModel instance, equivalent to game from within Roblox.
Throws on error.
remodel.readModelFile
remodel.readModelFile(path: string): List<Instance>
Load an rbxmx or rbxm (0.4.0+) file from the filesystem.
Note that this function returns a list of instances instead of a single instance! This is because models can contain mutliple top-level instances.
Throws on error.
remodel.writePlaceFile
remodel.writePlaceFile(instance: DataModel, path: string)
Saves an rbxlx file out of the given DataModel instance.
If the instance is not a DataModel, this method will throw. Models should be saved with writeModelFile instead.
Throws on error.
remodel.writeModelFile
remodel.writeModelFile(instance: Instance, path: string)
Saves an rbxmx or rbxm (0.4.0+) file out of the given Instance.
If the instance is a DataModel, this method will throw. Places should be saved with writePlaceFile instead.
Throws on error.
remodel.readFile (0.3.0+)
remodel.readFile(path: string): string
Reads the file at the given path.
Throws on error, like if the file did not exist.
remodel.readDir (0.4.0+)
remodel.readDir(path: string): List<string>
Returns a list of all of the file names of the children in a directory.
Throws on error, like if the directory did not exist.
remodel.writeFile (0.3.0+)
remodel.writeFile(path: string, contents: string)
Writes the file at the given path.
Throws on error.
remodel.createDirAll
remodel.createDirAll(path: string)
Makes a directory at the given path, as well as all parent directories that do not yet exist.
This is a thin wrapper around Rust's fs::create_dir_all function. Similar to mkdir -p from Unix.
Throws on error.
Remodel is similar to rbxmk: * Both Remodel and rbxmk use Lua * Remodel and rbxmk have a similar feature set and use cases * Remodel is imperative, while rbxmk is declarative * Remodel emulates Roblox's API, while rbxmk has its own, very unique API
Remodel is available under the terms of the MIT license. See LICENSE.txt for details.