Rojo

https://rojo.space/docs/v7
Admin
Rojo is a project management tool designed to get professional resources in the hands of Roblox...
Tokens:13,957
Snippets:135
Trust Score:7.9
Update:2 weeks ago
Show doc for...
Tokens:
Raw
### Start the live sync server with `rojo serve`

Source: https://rojo.space/docs/v7/getting-started/new-game

Run this command to start the live sync server that exposes your project to the Rojo plugin in Roblox Studio. The server listens on localhost and prints a port number and a URL for more information.

```bash
rojo serve  

```

--------------------------------

### Install Rojo with Rokit

Source: https://rojo.space/docs/v7/getting-started/installation

Install the latest release of Rojo using Rokit, the in-house toolchain manager. Run these commands after installing Rokit.

```shell
rojo add rojo-rbx/rojo  
rojo install  

```

--------------------------------

### Install Rojo Plugin via CLI

Source: https://rojo.space/docs/v7/getting-started/installation

Install or upgrade the Rojo plugin from the command line after installing the Rojo server.

```shell
rojo plugin install  

```

--------------------------------

### Output of `rojo serve`

Source: https://rojo.space/docs/v7/getting-started/new-game

Example terminal output after running `rojo serve`. It shows the server address, port, and a URL to visit for more information.

```bash
$ rojo serve  
Rojo server listening:  
  Address: localhost  
  Port:    34872  
  
Visit http://localhost:34872/ in your browser for more information  

```

--------------------------------

### Install Rojo 7 with Cargo

Source: https://rojo.space/docs/v7/getting-started/installation

Install Rojo 7 from source using Rust's package manager. This compiles Rojo from source and installs it on your machine.

```shell
cargo install rojo --version ^7  

```

--------------------------------

### Meta file to create a Tool

Source: https://rojo.space/docs/v7/sync-details

Create an init.meta.json file in a directory to change the className to Tool and set properties like Grip. This example sets className to Tool and Grip to a 12-element array.

```json
{  
  "className": "Tool",  
  "properties": {  
    "Grip": [0, 0, 0, 1, 0, 0, 0, 1, 0, 0, 0, 1]  
  }  
}  

```

--------------------------------

### Meta file to set ignoreUnknownInstances

Source: https://rojo.space/docs/v7/sync-details

Create a .meta.json file next to an instance to set Rojo-specific settings like ignoreUnknownInstances. This example sets ignoreUnknownInstances to true for a file named hello.txt.

```json
{  
  "ignoreUnknownInstances": true  
}  

```

--------------------------------

### JSON Module Example

Source: https://rojo.space/docs/v7/sync-details

A JSON file that will be synced as a ModuleScript returning a table with the same structure.

```json
{  
  "Hello": "world!",  
  "bool": true,  
  "array": [1, 2, 3],  
  "object": {  
    "key 1": 1337,  
    "key 2": []  
  }  
}  

```

--------------------------------

### JSON Model Example

Source: https://rojo.space/docs/v7/sync-details

A .model.json file describing a Folder containing a Part and a RemoteEvent.

```json
{  
  "ClassName": "Folder",  
  "Children": [  
    {  
      "Name": "RootPart",  
      "ClassName": "Part",  
      "Properties": {  
        "Size": [4, 4, 4]  
      }  
    },  
    {  
      "Name": "SendMoney",  
      "ClassName": "RemoteEvent"  
    }  
  ]  
}  

```

--------------------------------

### Generated ModuleScript Source from JSON

Source: https://rojo.space/docs/v7/sync-details

The resulting ModuleScript Source for the JSON example above.

```lua
return {  
	Hello = "world!",  
	array = {1, 2, 3},  
	bool = true,  
	object = {  
		["key 1"] = 1337,  
		["key 2"] = {},  
	},  
}  

```

--------------------------------

### Meta file to disable a script

Source: https://rojo.space/docs/v7/sync-details

Create a .meta.json file next to a script to set properties like Disabled. This example sets Disabled to true for foo.server.lua.

```json
{  
  "properties": {  
    "Disabled": true  
  }  
}  

```

--------------------------------

### Upload a place to Roblox.com with `rojo upload`

Source: https://rojo.space/docs/v7/getting-started/new-game

Uploads your place to Roblox.com. Requires an existing game and the `.ROBLOSECURITY` cookie of an account with write access. On Windows with Roblox Studio installed, `--cookie` is optional and pulled from the Studio session if omitted.

```bash
rojo upload --asset_id [PLACE ID] --cookie "[SECURITY COOKIE]"  

```

--------------------------------

### Enum implicit property format

Source: https://rojo.space/docs/v7/properties

Shows the implicit format for the Enum type, which is a string corresponding to the name of the enum item. Example uses the Face property of a SurfaceLight.

```json
{  
	"$className": "SurfaceLight",  
	"$properties": {  
		"Face": "Front"  
	}  
}  

```

--------------------------------

### Enum explicit property format

Source: https://rojo.space/docs/v7/properties

Shows the explicit format for the Enum type, which is an integer corresponding to the value of the enum item. Example uses the Face property of a SurfaceLight.

```json
{  
	"$className": "SurfaceLight",  
	"$properties": {  
		"Face": {  
			"Enum": 5  
		}  
	}  
}  

```

--------------------------------

### Initialize a new Rojo project with `rojo init`

Source: https://rojo.space/docs/v7/getting-started/new-game

Run this command in a terminal to create a new Rojo project in a folder named `my-new-game`. The folder is created if it doesn't exist, and all necessary project files are generated.

```bash
rojo init my-new-game  

```

--------------------------------

### Full game project file with services and properties

Source: https://rojo.space/docs/v7/project-format

Full project file for a game, showing how to configure services, properties, and paths. It ignores spec files, enables HttpService, sets Gravity, and loads Terrain from a file.

```json
{  
  "name": "Sisyphus Simulator",  
  "globIgnorePaths": ["**/*.spec.lua"],  
  "tree": {  
    "$className": "DataModel",  
  
    "HttpService": {  
      "$className": "HttpService",  
      "$properties": {  
        "HttpEnabled": true  
      }  
    },  
  
    "ReplicatedStorage": {  
      "$className": "ReplicatedStorage",  
      "$path": "src/ReplicatedStorage"  
    },  
  
    "StarterPlayer": {  
      "$className": "StarterPlayer",  
  
      "StarterPlayerScripts": {  
        "$className": "StarterPlayerScripts",  
        "$path": "src/StarterPlayerScripts"  
      }  
    },  
  
    "Workspace": {  
      "$className": "Workspace",  
      "$properties": {  
        "Gravity": 67.3  
      },  
  
      "Terrain": {  
        "$path": "Terrain.rbxm"  
      }  
    }  
  }  
}  

```

--------------------------------

### Build a Roblox place file with `rojo build`

Source: https://rojo.space/docs/v7/getting-started/new-game

Run this command from inside the project folder to generate a place file named `build.rbxlx`. To generate a binary place file instead, use `build.rbxl` as the output filename.

```bash
rojo build -o build.rbxlx  

```

--------------------------------

### Minimal project file for a plugin or model

Source: https://rojo.space/docs/v7/project-format

Minimal project file that maps the entire `src` directory into the instance tree. Suitable for a plugin or model.

```json
{  
  "name": "AwesomeLibrary",  
  "tree": {  
    "$path": "src"  
  }  
}  

```

--------------------------------

### Implicit Property Syntax in Rojo Project Files

Source: https://rojo.space/docs/v7/upgrade

Shows the implicit property syntax in Rojo project files, which is unchanged between Rojo 6 and 7. It is recommended to use this syntax when possible because it is shorter, easier to read, and more future-proof.

```json
{  
	"name": "cool-skateboard",  
	"tree": {  
		"$className": "Part",  
		"$properties": {  
			"Material": "Wood",  
			"Size": [2, 0.5, 6],  
			"Color": [1, 0, 0],  
			"CFrame": [  
				0, 10, 0,  
				1, 0, 0,  
				0, 1, 0,  
				0, 0, 1  
			]  
		}  
	}  
}  

```

--------------------------------

### Content property format

Source: https://rojo.space/docs/v7/properties

Shows both implicit and explicit formats for the Content type. Both use a string value.

```json
{  
	"$properties": {  
		"ImplicitExample": "rbxassetid://12345",  
		"ExplicitExample": {"Content": "rbxassetid://12345"}  
	}  
}  

```

--------------------------------

### Attributes property format

Source: https://rojo.space/docs/v7/properties

Shows how to specify the Attributes property both implicitly (via the "Attributes" key) and explicitly (via "AttributesSerialized"). Attribute values must be explicit values, e.g., {"Bool": true} or {"Vector3": [1.0, 2.0, 3.0]}.

```json
{  
	"$properties": {  
		"Attributes": {  
			"Foo": {"Bool": true},  
			"Bar": {"Vector3": [1.0, 2.0, 3.0]},  
		},  
		"AttributesSerialized": {  
			"Attributes": {  
				"Foo": {"Bool": true},  
				"Bar": {"Vector3": [1.0, 2.0, 3.0]},  
			}  
		}  
	}  
}  

```

--------------------------------

### String property value format

Source: https://rojo.space/docs/v7/properties

Shows the JSON format for a String property value. Both implicit and explicit forms are accepted, where the explicit form wraps the string in an object with a "String" key.

```json
{  
	"$properties": {  
		"ImplicitExample": "Hello, world!",  
		"ExplicitExample": {"String": "Hello, world!"}  
	}  
}  

```

--------------------------------

### Implicit property value for Anchored

Source: https://rojo.space/docs/v7/project-format

Shows how to set the Anchored property of a Part using an implicit value. Rojo infers the type from the class and property, so a boolean is required.

```json
{  
    "$className": "Part",  
    "$properties": {  
        "Anchored": true,  
    }  
}  

```

--------------------------------

### Bool property format

Source: https://rojo.space/docs/v7/properties

Shows both implicit and explicit formats for the Bool type. Both use a boolean value.

```json
{  
	"$properties": {  
		"ImplicitExample": true,  
		"ExplicitExample": {"Bool": false}  
	}  
}  

```

--------------------------------

### UDim property value format

Source: https://rojo.space/docs/v7/properties

Shows the JSON format for a UDim property value. The UDim type cannot be specified implicitly; the explicit form uses an object with a "UDim" key containing a list of Scale (float) and Offset (integer) components.

```json
{  
	"$properties": {  
		"ExplicitExample": {"UDim": [1.0, 32]}  
	}  
}  

```

--------------------------------

### UDim2 property value format

Source: https://rojo.space/docs/v7/properties

Shows the JSON format for a UDim2 property value. The UDim2 type cannot be specified implicitly; the explicit form uses an object with a "UDim2" key containing a list of X and Y components, each a UDim.

```json
{  
	"$properties": {  
		"ExplicitExample": {"UDim2": [[-1.0, 100], [1.0, -100]]}  
	}  
}  

```

--------------------------------

### Color3 property format

Source: https://rojo.space/docs/v7/properties

Shows both implicit and explicit formats for the Color3 type. The value is a list of R, G, B components, each a float in the range [0, 1].

```json
{  
	"$properties": {  
		"ImplicitExample": [  
			0.6392156862745098,  
			0.6352941176470588,  
			0.6470588235294118  
		],  
		"ExplicitExample": {  
			"Color3": [  
				0.6392156862745098,  
				0.6352941176470588,  
				0.6470588235294118  
			]  
		}  
	}  
}  

```

--------------------------------

### CFrame implicit property format

Source: https://rojo.space/docs/v7/properties

Shows the implicit format for the CFrame type, which is a flat list of components.

```json
{  
	"$properties": {  
		"ImplicitExample": [  
			1.0, 2.0, 3.0,  
			4.0, 5.0, 6.0,  
			7.0, 8.0, 9.0,  
			10.0, 11.0, 12.0  
		]  
	}  
}  

```

--------------------------------

### Rojo 7 Explicit Property Syntax

Source: https://rojo.space/docs/v7/upgrade

Shows the explicit property syntax in Rojo 7, where the 'Type' and 'Value' fields are folded together. Some types like 'CFrame' and 'ColorSequence' had fields added or renamed.

```json
{  
	"name": "cool-skateboard",  
	"tree": {  
		"$className": "Part",  
		"$properties": {  
			"Material": {  
				"Enum": 512  
			},  
			"Size": {  
				"Vector3": [2, 0.5, 6]  
			},  
			"Color": {  
				"Color3": [1, 0, 0]  
			},  
			"CFrame": {  
				"CFrame": {  
					"position": [0, 10, 0],  
					"orientation": [  
						1, 0, 0,  
						0, 1, 0,  
						0, 0, 1  
					]  
				}  
			}  
		}  
	}  
}  

```

--------------------------------

### ColorSequence explicit property format

Source: https://rojo.space/docs/v7/properties

Shows the explicit format for the ColorSequence type, which cannot be specified implicitly. The value is an object with a keypoints field, an array of ColorSequenceKeypoints, each with time and color fields (color is a Color3).

```json
{  
	"$properties": {  
		"ExplicitExample": {  
			"ColorSequence": {  
				"keypoints": [  
					{  
						"time": 0.0,  
						"color": [1.0, 1.0, 0.5]  
					},  
					{  
						"time": 1.0,  
						"color": [0.0, 0.0, 0.0]  
					}  
				]  
			}  
		}  
	}  
}  

```

--------------------------------

### Rojo 6 Explicit Property Syntax

Source: https://rojo.space/docs/v7/upgrade

Shows the explicit property syntax as used in Rojo 6, with separate 'Type' and 'Value' fields. This syntax is only needed for new enum values or properties with a different value type than expected.

```json
{  
	"name": "cool-skateboard",  
	"tree": {  
		"$className": "Part",  
		"$properties": {  
			"Material": {  
				"Type": "Enum",  
				"Value": 512  
			},  
			"Size": {  
				"Type": "Vector3",  
				"Value": [2, 0.5, 6]  
			},  
			"Color": {  
				"Type": "Color3",  
				"Value": [1, 0, 0]  
			},  
			"CFrame": {  
				"Type": "CFrame",   
				"Value": [  
					0, 10, 0,  
					1, 0, 0,  
					0, 1, 0,  
					0, 0, 1  
				]  
			}  
		}  
	}  
}  

```

--------------------------------

### Color3uint8 explicit property format

Source: https://rojo.space/docs/v7/properties

Shows the explicit format for the Color3uint8 type, which cannot be specified implicitly. The value is a list of R, G, B components, each an integer in the range [0, 255].

```json
{  
	"$properties": {  
		"ExplicitExample": {  
			"Color3uint8": [163, 162, 165]  
		}  
	}  
}  

```

--------------------------------

### Vector3 property value format

Source: https://rojo.space/docs/v7/properties

Shows the JSON format for a Vector3 property value. Both implicit and explicit forms are accepted, where the explicit form wraps the list of X, Y, and Z float components in an object with a "Vector3" key.

```json
{  
	"$properties": {  
		"ImplicitExample": [-300.0, 0.0, 1500.0],  
		"ExplicitExample": {"Vector3": [-300.0, 0.0, 1500.0]}  
	}  
}  

```

--------------------------------

### Vector2 property value format

Source: https://rojo.space/docs/v7/properties

Shows the JSON format for a Vector2 property value. Both implicit and explicit forms are accepted, where the explicit form wraps the list of X and Y float components in an object with a "Vector2" key.

```json
{  
	"$properties": {  
		"ImplicitExample": [-50.0, 50.0],  
		"ExplicitExample": {"Vector2": [-50.0, 50.0]}  
	}  
}  

```

--------------------------------

### Tags property value format

Source: https://rojo.space/docs/v7/properties

Shows the JSON format for a Tags property value. Both implicit and explicit forms are accepted, where the explicit form wraps the list of strings in an object with a "Tags" key.

```json
{  
	"$properties": {  
		"ImplicitExample": ["foo", "con'fusion?!", "bar"],  
		"ExplicitExample": {"Tags": ["foo", "con'fusion?!", "bar"]}  
	}  
}  

```

--------------------------------

### Explicit property value for Anchored as Bool

Source: https://rojo.space/docs/v7/project-format

Shows how to set the Anchored property using an explicit value with the Bool type. Rojo does not validate the type against Roblox's API for explicit values.

```json
{  
    "$className": "Part",  
    "$properties": {  
        "Anchored": {  
        	"Bool": true  
        },  
    }  
}  

```

--------------------------------

### BinaryString explicit property format

Source: https://rojo.space/docs/v7/properties

Shows the explicit format for the BinaryString type, which cannot be specified implicitly. The value is a base64-encoded string.

```json
{  
	"$properties": {  
		"ExplicitExample": {"BinaryString": "SGVsbG8sIHdvcmxkIQ=="}  
	}  
}  

```

--------------------------------

### Vector3int16 property value format

Source: https://rojo.space/docs/v7/properties

Shows the JSON format for a Vector3int16 property value. Both implicit and explicit forms are accepted, where the explicit form wraps the list of X, Y, and Z integer components in an object with a "Vector3int16" key.

```json
{  
	"$properties": {  
		"ImplicitExample": [60, 37, -450],  
		"ExplicitExample": {"Vector3int16": [60, 37, -450]}  
	}  
}  

```

--------------------------------

### Vector2int16 property value format

Source: https://rojo.space/docs/v7/properties

Shows the JSON format for a Vector2int16 property value. Both implicit and explicit forms are accepted, where the explicit form wraps the list of X and Y integer components in an object with a "Vector2int16" key.

```json
{  
	"$properties": {  
		"ImplicitExample": [-300, 300],  
		"ExplicitExample": {"Vector2int16": [-300, 300]}  
	}  
}  

```

--------------------------------

### BrickColor explicit property format

Source: https://rojo.space/docs/v7/properties

Shows the explicit format for the BrickColor type, which cannot be specified implicitly. The value is an integer representing the Number of a BrickColor.

```json
{  
	"$properties": {  
		"ExplicitExample": {"BrickColor": 194}  
	}  
}  

```

--------------------------------

### Explicit property value overriding type to String

Source: https://rojo.space/docs/v7/project-format

Shows how to override the type of the Anchored property to a string using an explicit value. This is necessary for properties Rojo does not know about.

```json
{  
    "$className": "Part",  
    "$properties": {  
        "Anchored": {  
        	"String": "Hello, world!"  
        },  
    }  
}  

```

--------------------------------

### Axes explicit property format

Source: https://rojo.space/docs/v7/properties

Shows the explicit format for the Axes type, which cannot be specified implicitly. The value is a list of strings, each either "X", "Y", or "Z", setting the corresponding component.

```json
{  
	"$properties": {  
		"ExplicitExample1": {"Axes": ["X", "Y", "Z"]},  
		"ExplicitExample2": {"Axes": ["X", "Z"]},  
		"ExplicitExample3": {"Axes": []}  
	}  
}  

```

--------------------------------

### CFrame explicit property format

Source: https://rojo.space/docs/v7/properties

Shows the explicit format for the CFrame type, which is an object with position and orientation fields.

```json
{  
	"$properties": {  
		"ExplicitExample": {  
			"CFrame": {  
				"position": [1.0, 2.0, 3.0],  
				"orientation": [  
					[4.0, 5.0, 6.0],  
					[7.0, 8.0, 9.0],  
					[10.0, 11.0, 12.0]  
				]  
			}  
		}  
	}  
}  

```
Tokens:
Raw