Rojo

Rojo is a community tool that takes a "file system-first" approach to Roblox projects. It runs a server on your machine that communicates with a Studio plugin to sync files on your disk into the Studio data model, and it can build place and model files from those files. With your project on disk, you can use Git, your own editor, and CI.

How you use Rojo depends on how much of your game you want it to manage:

• Partially managed: Rojo manages your code, and Git is its source of truth. Places and assets stay on Roblox, where artists edit them with Team Create and packages. We recommend this for most teams that use Git.
• Fully managed: Rojo manages your entire game, including models and images. Git is the source of truth for everything, and CI builds and publishes your places.

To compare these with a Studio-native workflow, see Compare file-based workflows.

Install Rojo

You can manually download and run a Rojo binary, but that approach runs the risk of different people on your team using different Rojo versions. A better solution is to use a toolchain manager like Rokit, which uses a configuration file, a list of repositories and versions, to make the installation and upgrade process consistent across machines.

Because it manages your baseline development environment rather than the packages within your project, Rokit is more akin to nvm than npm, but the comparison isn't perfect. A simple rokit.toml file looks like this:

[tools]
rojo = "rojo-rbx/rojo@7.6.1"
wally = "upliftgames/wally@0.3.2"
lune = "lune-org/lune@0.10.4"

Then you install these tools with rokit install. In addition to a global rokit.toml file, Rokit supports per-project files, so you can easily use different versions of Rojo, Wally, or any other tool for different projects and keep your entire team on those same versions.

When a tool releases a new version, you then explicitly bump the version number in your .toml file, use Rokit to perform the upgrade, test the new version, and downgrade if it causes any problems. For commands and installation instructions, see Rokit.

Run Rojo

After you install Rojo with Rokit, what you've really installed is the Rojo server. The next step is to install the Rojo plugin for Roblox Studio.

You can install it from the Creator Store or install it locally with this command:

rojo plugin install

Then generate the project structure for your new game and build it:

rojo init my-new-experience
cd my-new-experience
rojo build -o my-new-experience.rbxl

Alternatively, you can port an existing game. Either way, after you have a project, start the Rojo server:

rojo serve

In Roblox Studio, open the .rbxl file you just built, open the Rojo plugin, and connect to your now-running server, at which point you can start making changes in your preferred text editor and watch those changes automatically sync back to Studio.

Rojo projects have certain naming requirements for files, numerous configuration options, and some limitations, all of which are covered in the Rojo documentation.

Troubleshoot Rojo