Why Rogen?
- Organize by feature — Group all code, UI, and assets for a specific feature in one place. This gives you high cohesion, better scalability, fewer merge conflicts, and features that are simple to maintain or delete.
- Enforce boundaries — Keep coupling low with a linter. Every path names its feature, so a lint rule can stop one feature from requiring another.
- Multi-place games — Write shared code once and use it in every place. When one place needs something different, add a file with the same name to that place's folder, and it overwrites the shared one there.
- Still Rojo — Rogen runs the Rojo commands you use, with the same flags. One tool, and nothing to relearn.
Built for agents
When an agent works on a feature, everything it needs is in one folder, from server to client. It spends its context on your task instead of searching the codebase.
Running several agents? Give each one a feature. A lint rule catches any agent that makes one feature require another, and there's no shared project file to conflict on.
Example
default.rogen.json is a Rojo project file with routes added. The tree is the base: put in it what folder names can't say, such as your packages, and Rogen adds every routed file to it:
{
"name": "my-game",
"routes": {
"Server": "ServerScriptService",
"Client": "StarterPlayer/StarterPlayerScripts",
"Shared": "ReplicatedStorage/Shared",
"*": "ReplicatedStorage/Shared"
},
"tree": {
"$className": "DataModel",
"ReplicatedStorage": {
"Packages": { "$path": "Packages" }
}
}
}
A folder or an @ suffix named after a route sends its code there. The * route takes every file that matches no other:
In src/Inventory | Goes to |
|---|
Server/InventoryService.luau | ServerScriptService/Inventory |
Client/InventoryController.luau | StarterPlayer/StarterPlayerScripts/Inventory |
Shared/InventoryTypes.luau | ReplicatedStorage/Shared/Inventory |
[email protected] | ServerScriptService/Inventory |
InventoryConfig.luau | ReplicatedStorage/Shared/Inventory |
The routes are yours to change. Add "Gui": "StarterGui", and a Gui folder or a @Gui suffix sends code to StarterGui.
Installation
rokit add ldgerrits/[email protected]
rogen init
rogen init pins Rojo in rokit.toml and tells you to run rokit install to fetch it. New to Rojo? Also run rogen plugin install to add its Studio plugin. Prefer npm? Run npm i @ldgerrits/rogen@next and use npx rogen.
Usage
rogen serve # Serve with Rojo and update the project file on changes
rogen build -o game.rbxl # Update the project file, then build a place with Rojo
rogen check # Print warnings and errors, and exit 1 on any
sourcemap, upload, syncback and plugin take Rojo's flags too. See the documentation for every command.
FAQ
Does Rogen replace Rojo?
Yes and no. You run rogen instead of rojo, but Rojo still does the syncing and building underneath. Its Studio plugin stays installed too.
Does Rogen work with Argon?
Yes, for syncing your files into Studio. Run rogen write --watch and serve with Argon. To bring Studio changes back, save the place and run rogen syncback --input game.rbxl. With Rojo, it's one command: rogen serve keeps the project file current and serves it.
Can I use Rogen in an existing Rojo project?
Yes. Run rogen init to move it to Rogen. See Coming from Rojo.
Contributing
Read the contributing guide before you open a pull request. You can also star the repo or sponsor its development.
License
Rogen is MIT licensed.
