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 is a command-line tool that lets you build Roblox games and libraries using the same workflows professional software engineers rely on every day. Instead of writing scripts inside Roblox Studio’s built-in editor, you work with Lua and Luau files on your filesystem in any editor — Visual Studio Code, Neovim, or whatever you prefer — and Rojo syncs them into Studio live as you save.

​
What problems Rojo solves

Roblox Studio’s built-in editor is purpose-built for Roblox but lacks the tooling that professional developers expect: version control, external editor support, automated builds, and scriptable deployment pipelines. Rojo solves these problems by treating your game as a collection of files on disk rather than a Studio-only asset. With Rojo you can:
  • Edit files in any editor. Write scripts and configure your game tree from your preferred development environment.
  • Version your project with Git. Because everything lives on the filesystem, Git, GitHub, and other VCS tools work exactly as you’d expect.
  • Build and deploy from the command line. Compile .rbxl or .rbxm files and upload them to Roblox without opening Studio.
  • Stream model files in real time. Drop rbxmx and rbxm model files into your project and watch them appear in Studio instantly.

​
Key features

  • Live sync — rojo serve starts a local server; the Studio plugin connects and applies your filesystem changes as you save.
  • Build — rojo build compiles your project into a place or model file without Studio.
  • Upload — rojo upload deploys your game to Roblox.com directly from the terminal.
  • Syncback — rojo syncback converts an existing Roblox file back into a Rojo project structure.
  • Sourcemap — rojo sourcemap generates a JSON map of your instance tree for use with language server tooling.
  • File type support — Luau scripts, JSON modules, plain text, binary models (rbxm, rbxmx), images, sounds, and more.
  • Project files — A default.project.json file defines how your filesystem maps to the Roblox instance tree.
  • Sync rules — Control which files are included or excluded from sync using configurable rules.
  • Meta files — Attach properties to instances using .meta.json sidecar files without changing the source file.

​
Who Rojo is for

Rojo is designed for developers who want to apply professional-grade software engineering practices to Roblox. It is a great fit if you:
  • Prefer writing code outside of Studio in a fully featured editor.
  • Want to collaborate on a Roblox project using Git and pull requests.
  • Need to automate builds or deployments as part of a CI/CD pipeline.
  • Are building open-source Roblox libraries or frameworks that benefit from a standard project structure.

Install Rojo

Set up the Rojo binary and the companion Roblox Studio plugin.

Get started

Create your first project and sync it to Studio in minutes.

Build docs developers (and LLMs) love

Get started for freeTalk to us