Glossary
The terms Rogen's docs use, and where each one is explained.
The Pipeline
-
Root directory: A directory Rogen scans and watches for code, declared in
rootDirs. With several, their feature folders and modules merge into one tree, and the later one wins a clash. See Project Layout. -
Common root: The deepest directory containing every root directory. Derived, never written in the config. See Sync Directory.
-
Linked directory: A symlink or Windows junction inside a root directory, read as the directory it points at. See Project Layout.
-
Feature folder: A folder inside a root directory that groups every file belonging to one gameplay feature, whichever service each file ends up in. See Routing.
-
Sync directory: The directory Rojo syncs from, declared as
syncDir: your compiler's output. See Output and Sync. -
Template: The Rojo project file that Rogen merges its generated tree into, declared as
template. See Output and Sync. -
Output: The Rojo project file a config writes, named by
outFile. Rogen owns it. See Output and Sync. -
Build: One complete run that turns root directories into an output for one config. See CLI.
-
Rendering: The tree written out as a project file, with its
$paths rooted at one directory. See Output and Sync. -
Watch: A long-running build that regenerates its output when files change, and reloads itself when a config changes. See CLI.
-
Toolchain: The language (Luau or roblox-ts), an optional processor and the package manager that a workspace uses.
initdetects it once. See CLI. -
Processor: A tool such as Darklua that rewrites your code into a folder of its own before Rojo syncs it. See the Darklua guide.
-
Place: One Roblox place in a repo that builds several, written as a config that extends a shared one. See the multi-place guide.
Routing
-
Service: A top-level Roblox DataModel container that code can be placed in, such as
ServerScriptService. See Routing. -
Route: A rule in
routesthat sends files to a target. Its name is the route key. See Routing. -
Governing route: The one route that decides where a file goes: the outermost one, walking from the root directory down. See Routing.
-
Target: The path a route places files at, whose first segment is a service. See Routing.
-
Fallback route: The
*route, for files that no route matched. See Routing. -
Routing folder: A folder named after a route key. It never appears in the generated tree. See Routing.
-
Suffix: A route key or tag at the end of a script name. See Routing.
-
Declared key: A route key or a tag. Both are recognised as a folder, a marker file or a suffix. See Tags.
-
Marker file: An empty dot-file naming a declared key, which applies it to its directory and everything below. See Routing.
-
Metadata file: Rojo's
*.meta.json, which sets a class, properties or attributes. See Project Layout. -
Invisible folder: A folder written as
(name), left out of the generated tree. See Project Layout. -
Init folder: A directory containing an
initorindexscript, which Rojo treats as one instance. See Project Layout.
Tags and Filtering
-
Tag: A name declared in
tagsthat marks a colocated variant of a file. See Tags. -
Active tag: A tag switched on for the current build. Its suffix is stripped and its file replaces an untagged one. See Tags.
-
Tag folder: A folder named after a declared tag. It never appears in the tree. See Tags.
-
Dormant tag: A declared tag that isn't active in the current build. See Tags.
-
Pruned: Left out of the output because the file carries a dormant tag. See Tags.
-
Excluded: Left out of the output because the file matches an
excludeglob. See Project Layout.
Configuration
-
Config: A
<name>.rogen.jsonfile. See Configuration. -
Variant: A config that differs from another, selected by name and usually extending it. See Configuration.
-
Override: A CLI flag that replaces a config value for one invocation. See CLI.