Skip to main content

Documentation Index

Fetch the complete documentation index at: https://mintlify.com/rojo-rbx/rojo/llms.txt

Use this file to discover all available pages before exploring further.

rojo build reads your project file, resolves all referenced source files, and writes a single Roblox file. You can target any of the four Roblox file formats, or install the result directly into Roblox Studio’s local plugins folder.

Synopsis

rojo build [PROJECT] [OPTIONS]
Either --output or --plugin is required. They are mutually exclusive.

Arguments and flags

PROJECT
string
Path to the project file or to a directory containing a default.project.json. Defaults to the current directory.
--output, -o
string
Path for the output file. The file extension determines the format — Rojo accepts .rbxl, .rbxlx, .rbxm, and .rbxmx. Cannot be used together with --plugin.
--plugin, -p
string
Relative filename to install into Roblox Studio’s local plugins folder. Must end in .rbxm or .rbxmx. The path must be relative, not absolute. Cannot be used together with --output.
--watch
boolean
Rebuild automatically whenever any source file changes. Works with both --output and --plugin.

Global flags

--verbose / -v
boolean
Increase log verbosity. Pass multiple times (e.g. -vv) for more detail.
--color
string
default:"auto"
Control color output. Accepted values are auto, always, and never.

Output formats

ExtensionFormatUse for
.rbxlBinary placePublishing a game
.rbxlxXML placeVersion-control-friendly place files
.rbxmBinary modelDistributing assets
.rbxmxXML modelVersion-control-friendly model files
--plugin only accepts .rbxm or .rbxmx. Use --output if you need to produce a place file (.rbxl or .rbxlx).

Examples

Build a binary place file:
rojo build --output game.rbxl
Build an XML place file (useful for diffing in version control):
rojo build --output game.rbxlx
Build a binary model file:
rojo build --output MyLibrary.rbxm
Install as a Studio plugin and watch for changes:
rojo build --plugin MyPlugin.rbxm --watch
Build from an explicit project file path:
rojo build path/to/my-game.project.json --output game.rbxl

Build docs developers (and LLMs) love