Skip to content

Kampfkarren/rojo

 
 

Repository files navigation

Rojo
 

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

It lets Roblox developers use industry-leading tools like Git and VS Code, and crucial utilities like Luacheck.

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, library, or plugin using Git or another VCS
  • Sync JSON-format models from the filesystem into your game

Later in 2018, Rojo will be able to:

  • Sync scripts from Roblox Studio to the filesystem
  • Compile MoonScript and sync it into Roblox Studio
  • Sync rbxmx models between the filesystem and Roblox Studio
  • Package projects into rbxmx files from the command line

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:

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

The master branch is a rewrite known as Epiphany. It includes a breaking change to the project configuration format and an infrastructure overhaul.

Building Rojo requires the latest Rust beta in order to use 2018 Edition features. Once Rust 1.31 is stable on December 6, 2018, Rojo master will compile on Rust stable again.

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 Mozilla Public License, Version 2.0. See LICENSE for details.

About

Tool for building robust Roblox projects

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Languages

  • Rust 78.9%
  • Lua 21.1%