rojo/README.md

 

---

Rojo is a flexible multi-tool designed for creating robust Roblox projects.

It's designed for power users who want to use the best tools available for building games, libraries, and plugins.

Features

Rojo lets you:

• Work on scripts from the filesystem, in your favorite editor
• Version your place, library, or plugin using Git or another VCS
• Sync JSON-format models from the filesystem into your game

Later this year, Rojo will be able to:

• Sync rbxmx models between the filesystem and Roblox Studio
• Package projects into rbxmx files from the command line

Documentation Website

You can also view the documentation by browsing the docs folder of the repository, but because it uses a number of Markdown extensions, it may not be very readable.

Inspiration

There are lots of other tools that sync scripts into Roblox or provide other tools for working with Roblox places.

Here are a few, if you're looking for alternatives or supplements to Rojo:

• Studio Bridge by Vocksel
• RbxRefresh by Osyris
• RbxSync by evaera
• CodeSync and rbx-exteditor by MemoryPenguin
• rbxmk by Anaminus

I also have a couple tools that Rojo intends to replace:

• rbxfs, which has been deprecated by Rojo
• rbxpacker, which is still useful

Contributing

Pull requests are welcome!

All pull requests are run against a test suite on Travis CI. That test suite should always pass!

License

Rojo is available under the terms of the MIT license. See LICENSE.md for details.