rojo

Rojo is a tool that enables Roblox developers to use professional software engineering workflows. Key capabilities include:

• Filesystem-based development: Work on scripts and models directly from your filesystem using editors like Visual Studio Code.
• Version Control: Use Git or other Version Control Systems (VCS) to manage your game, library, or plugin code.
• Real-time Streaming: Stream .rbxmx and .rbxm models into your Roblox game session in real time.
• CLI Deployment: Package and deploy projects to Roblox.com directly from the command line.
• Syncback: Use rojo syncback to pull Instances from Roblox place and model files back into an existing Rojo project.
• Two-way Sync: An optional setting in the Rojo Studio plugin allows supported edits made in Roblox Studio to sync back to your local filesystem.

memofs supports different backends that determine how files are stored and watched. You can choose a backend based on your requirements:

• StdBackend: Uses the standard std::fs and the notify crate for real filesystem operations and file watching.
• NoopBackend: A backend that always throws errors; useful for disabling filesystem operations.
• InMemoryFs: A simple in-memory filesystem, primarily useful for testing environments where persistent storage is not required.

To compile a Rojo project into a Roblox Model XML file (.rbxmx), use the rojo build command with the -o (output) flag. This process converts your local file structure into a format that can be imported into Roblox Studio.

rojo build -o "{project_name}.rbxmx"

To build a Rojo plugin into a local .rbxm file, use the rojo build command with the -p (or --plugin) flag specifying the output filename. This is typically used when developing Rojo extensions or plugins.

rojo build -p "{project_name}.rbxm"

To compile a Rojo project into a standalone Roblox place file (.rbxlx), use the rojo build command with the -o flag to specify the output filename.

rojo build -o "{project_name}.rbxlx"

To automatically re-build your Rojo plugin whenever a file change is detected, include the --watch flag in your build command. This is useful during active development to ensure the .rbxm file is always up to date.

rojo build -p "{project_name}.rbxm" --watch

You can initialize a Vfs with different backends depending on your needs:

• StdBackend: Uses the standard OS filesystem (std::fs) and supports file watching via the notify crate. Use Vfs::new_default() for this.
• InMemoryFs: A simple in-memory filesystem, ideal for testing.
• NoopBackend: A backend that always throws errors, useful for testing error paths.

The generated sourcemap is a JSON tree of SourcemapNode objects. Each node represents an instance in the Rojo project hierarchy.

Fields:

• name: The name of the instance.
• className: The class name of the instance (e.g., Script, Folder).
• filePaths: An array of paths to the files associated with this instance. These are either relative to the project directory or absolute, depending on the --absolute flag.
• children: An array of SourcemapNode objects representing the children of this instance.

The upload command supports two distinct authentication workflows:

1. Legacy Upload (Cookie-based)

Uses the standard Roblox web authentication.

• Requirement: Provide a --cookie or ensure a valid cookie is available in your system environment.
• Note: If you provide --universe_id while using this method, it will be ignored and a warning will be issued.

2. Open Cloud API (API Key-based)

Uses the modern Roblox Open Cloud interface.

• Requirement: You must provide both --api_key AND --universe_id.
• Note: If you provide --cookie while using this method, it will be ignored and a warning will be issued.
• Limitation: This method currently only supports uploading to a place.

The syncback command automatically converts Roblox files (.rbxl, .rbxlx, .rbxm, or .rbxmx) into a Rojo project. It uses your existing project.json file to traverse the Roblox file and serialize Instances into the filesystem in a format Rojo understands.

To use it, provide the path to your Rojo project and the path to the Roblox file you want to pull from. By default, the command will prompt you for confirmation before writing any changes to your filesystem.