@ldgerrits/rogen 1.4.4 → 2.0.0-beta.2

package/LICENSE.md

@@ -1,7 +1,7 @@
-Copyright © 2026 Loek Gerrits
-
-Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the “Software”), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
-
-The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
-
+Copyright © 2026 Loek Gerrits
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the “Software”), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+
 THE SOFTWARE IS PROVIDED “AS IS”, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

package/README.md

@@ -1,33 +1,109 @@
-<div>&nbsp;</div>
-
-<div align="center">
-	<img src="https://raw.githubusercontent.com/LDGerrits/rogen/main/docs/public/icon.png" alt="Rogen" width="100" />
-</div>
-
-<div align="center">
-    <a href="https://rogen-playfully.vercel.app"><strong>documentation</strong></a>
-</div>
-
----
-
-<div align="center">
-    A CLI tool that enables feature-based architecture for Roblox
-</div>
-
-## Features
-
-- **Feature Folders:** Keep related client, server, and shared code inside a single folder.
-- **Auto-Routing:** Map files to Roblox services automatically using Rojo or Argon.
-- **Multi-Place Support:** Merge multiple source directories to share core systems across different places.
-- **Environment Tags:** Filter test files and inject mock dependencies at build time using tags.
-- **Granular Control:** Shape the project tree using invisible folders, hoisting, and marker files.
-- **Modern Tooling:** Support Luau, roblox-ts, and Darklua pipelines out of the box.
-
-## Contributing
-
-Pull requests are welcome!
-Read the [contribution guidelines](CONTRIBUTING.md) to set up your local environment, run tests, and submit code changes.
-
-## License
-
-See the [licence](LICENSE.md) for details.
+<p align="center">
+	<a href="https://rogen-roblox.vercel.app">
+		<picture>
+			<source media="(prefers-color-scheme: dark)" srcset="docs/public/icon.png" />
+			<img src="docs/public/icon-dark.png" alt="Rogen logo" width="160" />
+		</picture>
+	</a>
+</p>
+<h1 align="center">Rogen</h1>
+<p align="center">
+	<strong>A Rojo superset that keeps each feature's server and client code in one folder.</strong>
+</p>
+<p align="center">
+	Rogen generates the Rojo project file from your file system, and sends each file to the right place in Studio.
+</p>
+<p align="center">
+	<a href="https://www.npmjs.com/package/@ldgerrits/rogen"><img alt="Beta release" src="https://img.shields.io/npm/v/@ldgerrits/rogen/next?style=flat-square&label=beta" /></a>
+	<a href="https://rogen-roblox.vercel.app/docs/v2"><img alt="Documentation" src="https://img.shields.io/badge/docs-website-blueviolet?style=flat-square" /></a>
+	<a href="https://discord.com/channels/385151591524597761/1503801029232295996"><img alt="Discord" src="https://img.shields.io/badge/discord-chat-5865F2?style=flat-square&logo=discord&logoColor=white" /></a>
+	<a href="https://github.com/LDGerrits/rogen/stargazers"><img alt="GitHub stars" src="https://img.shields.io/github/stars/LDGerrits/rogen?style=flat-square&logo=github" /></a>
+	<a href="https://luau.org"><img alt="Luau" src="https://img.shields.io/badge/Luau-00A2FF?style=flat-square&logo=luau&logoColor=white" /></a>
+	<a href="https://roblox-ts.com"><img alt="roblox-ts" src="https://img.shields.io/badge/roblox--ts-3178C6?style=flat-square&logo=typescript&logoColor=white" /></a>
+</p>
+
+<p align="center">
+	<picture>
+		<source media="(prefers-color-scheme: dark)" srcset="docs/public/readme/routing-dark.png" />
+		<img src="docs/public/readme/routing-light.png" alt="VS Code with an Inventory feature and rogen serve in its terminal, beside the Roblox Studio Explorer with each file where Rogen sent it" width="840" />
+	</picture>
+</p>
+
+## 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](https://rogen-roblox.vercel.app/docs/v2/linting) 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 replaces 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. See [Working with agents](https://rogen-roblox.vercel.app/docs/v2/agents) to set them up.
+
+## How it works
+
+`default.rogen.json` is a Rojo project file with `routes`. Its `tree` holds what folder names can't say, such as your packages:
+
+<!-- prettier-ignore -->
+```json
+{
+  "name": "my-game",
+  "routes": {
+    "Server": "ServerScriptService",
+    "Client": "StarterPlayer/StarterPlayerScripts",
+    "Shared": "ReplicatedStorage/Shared",
+    "*": "ReplicatedStorage/Shared"
+  },
+  "tree": {
+    "$className": "DataModel",
+    "ReplicatedStorage": {
+      "Packages": { "$path": "Packages" }
+    }
+  }
+}
+```
+
+A file goes where its [folder or `@` suffix](https://rogen-roblox.vercel.app/docs/v2/core-concepts/routing) says: `Server/` and `@Server` both mean ServerScriptService. Everything else goes to `*`, and a route you add, such as `"Gui": "StarterGui"`, works the same way.
+
+## Installation
+
+```bash
+rokit add ldgerrits/rogen@2.0.0-beta.2
+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
+
+```bash
+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 [command reference](https://rogen-roblox.vercel.app/docs/v2/commands) 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](https://rogen-roblox.vercel.app/docs/v2/coming-from-rojo).
+
+## Contributing
+
+Read the [contributing guide](CONTRIBUTING.md) before you open a pull request. You can also star the repo or [sponsor its development](https://github.com/sponsors/LDGerrits).
+
+## License
+
+Rogen is [MIT licensed](LICENSE.md).