UpliftGames / rojo

Fork of rojo with changes for our workflow

This is a fork of Rojo with changes specific to the workflow at Uplift Games.

If you are looking for syncback, check out releases. If you're looking for its source, look at syncback-tests. If you're looking for the legacy fork we had that is being replaced, check out below:

Changes from upstream Rojo:

• TOML support
• Ability to define the type of a file using glob patterns
• Font property support
• Model Scale property support
• Adds Font and Gui Inset migrations
• MeshPart support
• UniqueId support

Release Instructions

New Uplift Games-specific releases should:

• Be created via workflow dispatch on the Release action
  • Be created on the uplift branch (this is our main)
  • Be tagged with an appropriate semver plus a pre-release tag in the following format:
    v1.2.3-uplift.1
    ...where v1.2.3 is the semver and uplift.1 increments for each release we make. It is acceptable to maintain the release count across semver changes.
  • Once the release action finishes there will be a release draft. Add a changelog and publish it. If any release job fails due to aftman github limits, re-run failed jobs.
• Add our changes to CHANGELOG.md. If we rebase on a new version of Rojo that includes some of our additions, we should list only what has changed between upstream Rojo and our fork.
• Where possible, our changes should become PRs to the upstream Rojo repo. When we do this, we should include a link to the PR in the changelog entry.

---

 

---

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.

Installation

The following instructions are for installing the Uplift fork of rojo. If you're looking to install standard Rojo, see Rojo's Installation section.

With Aftman

Rojo can be installed with Aftman, a toolchain manager for Roblox projects:

[tools]
rojo = "UpliftGames/rojo@7.3.0-uplift.11"

From GitHub Releases

You can download pre-built binaries from the GitHub Releases page.

Features

Rojo enables:

• Working on scripts and models from the filesystem, in your favorite editor
• Versioning your game, library, or plugin using Git or another VCS
• Streaming rbxmx and rbxm models into your game in real time
• Packaging and deploying your project to Roblox.com from the command line

In the future, Rojo will be able to:

• Sync instances from Roblox Studio to the filesystem
• Automatically convert your existing game to work with Rojo
• Import custom instances like MoonScript code

Documentation

Documentation is hosted in the rojo.space repository.

Contributing

Check out our contribution guide for detailed instructions for helping work on Rojo!

Pull requests are welcome!

Rojo supports Rust 1.58.1 and newer. The minimum supported version of Rust is based on the latest versions of the dependencies that Rojo has.

License

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