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 bridges the gap between professional software engineering and Roblox development. Instead of editing scripts inside Roblox Studio, you write Lua and Luau files on your filesystem using any editor, then Rojo syncs them into Studio live — or builds a deployable place file directly from the command line.

Installation

Install Rojo and the Studio plugin to get set up in minutes.

Getting Started

Create your first project and sync it to Roblox Studio.

Project Files

Learn how to configure your project tree with .project.json.

Command Reference

Full reference for every Rojo CLI command and flag.

What Rojo enables

Live sync to Studio

Run rojo serve to start a local server. The Studio plugin connects and applies filesystem changes in real time as you save files.

Build place files

Use rojo build to compile your project into .rbxl or .rbxm files — no Studio required.

Upload to Roblox

Deploy your game directly from the command line with rojo upload, supporting both legacy and Open Cloud APIs.

Syncback from Studio

Convert an existing Roblox file back into a Rojo project structure using rojo syncback.

Get started in three steps

1

Install Rojo

Download the Rojo binary via Rokit (the recommended toolchain manager) and install the companion Studio plugin.
rokit add rojo-rbx/rojo
2

Initialize a project

Create a new Rojo project in your directory. Choose place, model, or plugin depending on what you’re building.
rojo init my-game --kind place
cd my-game
3

Serve and connect

Start the Rojo server, then open Roblox Studio and click Connect in the Rojo plugin panel.
rojo serve
Rojo requires the companion Roblox Studio plugin to enable live sync. See the Installation guide for plugin setup instructions.

Build docs developers (and LLMs) love