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 init creates the directory structure and starter files for a new Rojo project. By default it creates a place project template, runs git init in the target directory (if git is available and the path is not already inside a repository), and names the project after the directory.

Synopsis

rojo init [PATH] [OPTIONS]

Arguments and flags

PATH
string
Path to the directory in which to create the project. Rojo creates the directory if it does not exist. Defaults to the current directory.
--kind
string
default:"place"
Template to use for the new project. Accepted values are place, model, and plugin.
--skip-git
boolean
Skip automatic git init. By default Rojo runs git init in the project directory when git is installed and the path is not already inside an existing repository.

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.

Templates

Each --kind value produces a different set of starter files.
KindWhat gets created
placeA default.project.json wired to a baseplate, plus a src/ folder.
modelA minimal default.project.json for a library or model asset.
pluginA minimal default.project.json configured for a Roblox Studio plugin.
Rojo skips creating a file if it already exists in the target directory, so it is safe to run rojo init inside an existing project to add missing template files.

Examples

Initialize a place project in the current directory:
rojo init
Initialize a model project in a new subdirectory:
rojo init my-library --kind model
Initialize a plugin project without creating a git repository:
rojo init my-plugin --kind plugin --skip-git
Initialize a place project in an existing directory with no color output:
rojo init ./my-game --color never

Build docs developers (and LLMs) love