Skip to main content

Documentation Index

Fetch the complete documentation index at: https://mintlify.com/rojo-rbx/rojo/llms.txt

Use this file to discover all available pages before exploring further.

rojo serve reads your project file, watches the filesystem for changes, and exposes a local HTTP API that the Rojo Studio plugin connects to. Any file you save is reflected in Studio immediately, without needing to publish or rebuild.

​
Synopsis

rojo serve [PROJECT] [OPTIONS]

​
Arguments and flags

​
PROJECT
string
Path to the project file or to a directory containing a default.project.json. Defaults to the current directory.
​
--address
string
default:"127.0.0.1"
IP address for the server to listen on. Override this when you need the server reachable from another machine on your network.
​
--port
number
default:"34872"
Port for the server to listen on. Defaults to the port specified by servePort in your project file, or 34872 if the project does not set one.

​
Global flags

​
--verbose / -v
boolean
Increase log verbosity. Pass multiple times (e.g. -vv) for more detail.
​
--color
string
default:"auto"
Control color output. Accepted values are auto, always, and never.

​
Connecting Studio

After the server starts, Rojo prints the address and a browser URL: 
Rojo server listening:
  Address: localhost
  Port:    34872

Visit http://localhost:34872/ in your browser for more information.
Open that URL to see which project is being served and confirm the plugin can reach it. In Studio, open the Rojo plugin and click Connect. The plugin will connect to localhost:34872 by default.
The Rojo Studio plugin must be installed before you can sync. Download it from the Roblox Creator Marketplace or build it locally with rojo build --plugin.

​
Port resolution order

The effective port is chosen using this priority:
  1. --port flag (highest priority)
  2. servePort field in default.project.json
  3. Built-in default 34872

​
Examples

Serve the project in the current directory: 
rojo serve
Serve a project file at an explicit path: 
rojo serve path/to/my-game.project.json
Serve on a non-default port: 
rojo serve --port 8080
Expose the server to your local network: 
rojo serve --address 0.0.0.0
Setting --address 0.0.0.0 makes the server reachable from any device on your network. Only do this in a trusted environment.

Build docs developers (and LLMs) love

Get started for freeTalk to us