Configuration

The .rogen.json file controls the project. Store the file in the root directory to define source folders, routing preferences, and the base project tree.

Below is an verbose example configuration that demonstrates some top-level options and mode-specific overrides:

{
	"source": ["src"],
	"casing": "camelCase",
	"verbatim": false,
	"unwrap": false,
	"globIgnorePaths": ["**/_drafts/**"],
	"tags": {
		"dev": false,
		"prod": true
	},
	"aliases": {
		"Controller": "StarterPlayerScripts",
		"Service": "ServerScriptService"
	},
	"luau": {
		"output": "default.project.json",
		"build": "src",
		"tags": {
			"dev": true,
			"prod": false
		},
		"globIgnorePaths": ["**/*.spec.luau"]
	},
	"project": {
		"name": "my-game",
		"tree": {
			"$className": "DataModel"
		}
	}
}

Fields

source

(Required) A string or an array of strings. Defines the directories containing uncompiled code. Rogen scans these folders to generate the map. Passing an array merges multiple folders.

tags

(Optional) A key-value object mapping tag names to booleans. Assign true to keep associated files, or false to drop associated files.

casing

(Optional) Defines the capitalization of generated wrapper folders (like server or client). Accepts "camelCase" (default) or "PascalCase".

verbatim

(Optional) A boolean flag. Set to true to keep routing affixes in the final script names instead of removing them. Defaults to false.

unwrap

(Optional) A boolean flag. Set to true to not have global wrapper folders like server, client, or shared at the root of each service in Roblox Studio.

aliases

(Optional) An object defining custom routing maps. Register new affixes or overwrite default service routing.

globIgnorePaths

(Optional) An array of glob string patterns. Matches file or directory paths to ignore entirely.

project

(Optional) Defines the base Rojo tree. Accepts an inline JSON object or a string path to an external JSON file. Rogen merges generated paths directly into this object.

Modes

Define mode-specific pipelines for different workflows, such as luau, ts, or darklua. It is possible to define custom modes as well!

output

(Required) A string path defining the Rojo project file location.

build

(Required) A string path defining the directory containing the code that is synced to Roblox Studio.

tags

(Optional) A key-value object mapping tag names to booleans. Assign true to keep associated files, or false to drop associated files.

globIgnorePaths

(Optional) An array of glob string patterns. Matches file or directory paths to ignore entirely.

{
	"dev": {
		"output": "dev.project.json",
		"build": "src",
		"tags": {
			"dev": true,
			"prod": false
		},
		"globIgnorePaths": ["**/*.spec.luau"]
	}
}