hakowork/rojo
3
0
Fork 0
mirror of https://github.com/rojo-rbx/rojo.git synced 2026-10-20 17:41:37 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions
Rojo enables Roblox developers to use professional-grade software engineering tools https://rojo.space
268 commits 11 branches 88 tags 20 MiB
Find a file
Lucien Greathouse f691d8a6a5 Clean up DevSettings
2018-12-03 16:57:28 -08:00
assets Added plugin icons to Rojo (#70) 2018-05-22 10:52:55 -07:00
docs Mention VS Code extension in getting started guide 2018-06-02 01:04:31 -07:00
plugin Clean up DevSettings 2018-12-03 16:57:28 -08:00
rojo-e2e Rename 'integration' to 'rojo-e2e' 2018-08-26 01:13:57 -07:00
server Upgrade to latest rbx_tree (underscores! ) 2018-12-03 11:58:09 -08:00
test-projects Fix example test 2018-11-27 21:17:38 -08:00
.editorconfig merge impl-v2: .editorconfig 2018-06-10 22:50:37 -07:00
.gitignore Add root gitignore to ignore mkdocs generated site 2018-04-01 23:36:04 -07:00
.gitmodules Switch to library version of Promise 2018-04-20 23:26:50 -07:00
.travis.yml Move server to (temporarily) require Rust Beta or stable 1.31+ 2018-11-27 10:45:02 -08:00
CHANGES.md Update README and CHANGES from 0.4.12 release 2018-06-24 14:09:57 -07:00
design.gv Update design graph 2018-11-17 14:58:07 -08:00
LICENSE Update LICENSE 2018-04-12 00:18:45 -07:00
mkdocs.yml Flesh out documentation, normalize markdown indentation 2018-04-08 00:09:28 -07:00
README.md Move server to (temporarily) require Rust Beta or stable 1.31+ 2018-11-27 10:45:02 -08:00

README.md

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

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:

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.