rojo/README.md

 

---

Rojo is a tool designed to enable Roblox developers to use professional-grade software engineering tools.

With Rojo, it's possible to use industry-leading tools like Visual Studio Code and Git.

Rojo is 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, model, or plugin using Git or another VCS
• Sync rbxmx and rbxm models into your game in real time
• Package and deploy your project to Roblox.com from the command line

Soon, Rojo will be able to:

• Sync instances from Roblox Studio to the filesystem
• Compile MoonScript and other custom things for your project

Documentation

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 and Alternatives

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:

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

If you use a plugin that isn't Rojo for syncing code, open an issue and let me know why! I'd like Rojo to be the end-all tool so that people stop reinventing solutions to this problem.

Contributing

Pull requests are welcome!

Rojo supports Rust 1.32 and newer. Any changes to the minimum required compiler version require a minor version bump.

License

Rojo is available under the terms of the Mozilla Public License, Version 2.0. See LICENSE.txt for details.