rproj

A guided CLI that takes a fresh Windows PC to a working Roblox/Luau development setup, then scaffolds projects on it.

It installs the tools — Git, VS Code, Roblox Studio, Blender, and the Rokit/Rojo/Wally/Selene/StyLua toolchain — along with the Studio plugins and editor extensions, then writes a project that already has default.project.json, wally.toml, linter and formatter config, a .gitattributes that keeps the tree checking out cleanly on Windows, and a quality gate that CI runs unchanged.

Every choice comes with a one-line explanation and a maintenance badge, so you can pick deliberately instead of guessing — or skip past the guidance if you already know what you want.

Requirements

Windows. Installs go through winget, and this is the only supported platform.

Installation

cargo install rproj

Usage

rproj new my-first-game

On a machine that has never been set up, this asks what to install first — system apps, CLI tools, Studio plugins, editor extensions — then asks about this project's packages. On every run after that it goes straight to the project questions.

Nothing already installed is reinstalled, and one item failing to install is a warning rather than an abort.

Commands

Choosing what gets generated

After the package questions, rproj new asks which files to generate. Everything is optional except the source tree and default.project.json — answer nothing and you get a bare Rojo project. Files that depend on a choice are only offered when it is present: selene.toml needs Selene, tests/ needs a test framework, blender/ needs Blender.

The CI workflow is off by default, since it changes what happens on a push.

Choosing packages

rproj new offers a guided walkthrough — one prompt per category, in order: state management, UI, data and profiles, testing, utilities — or an expert flat list across the whole catalog.

Guided mode adds companion packages for you: pick react and you get react-roblox; pick charm alongside Vide and you get vide-charm rather than the React binding.

Dependencies come from Wally by default, or from git submodules if you prefer vendoring.

What gets scaffolded

my-first-game/
├── default.project.json     server/client/shared tree + place properties
├── rokit.toml               project-local pins for every selected CLI tool
├── wally.toml               dependencies, split by realm
├── selene.toml              linter config
├── stylua.toml              formatter config
├── .luaurc                  strict mode
├── .gitattributes           pins the working tree to LF
├── rproj.toml               what you picked, and how
├── src/{shared,server,client}/
├── tests/                   if TestEZ was selected
├── .lute/check.luau         the quality gate
├── .github/workflows/ci.yml runs the same gate, unchanged
└── .vscode/settings.json    sourcemap, Studio bridge, formatter path

The gate — lute run check — regenerates the sourcemap, type-checks with luau-lsp, lints with Selene, and verifies formatting with StyLua. CI runs the same script, so local and CI results cannot drift. Each step is only emitted if the project selected its tool.

The catalog

Run rproj info for the full listing, or rproj info <key> for detail on any entry.

• System apps — Git, VS Code, Roblox Studio, Roblox, Blender
• CLI tools — rojo, wally, wally-package-types, selene, stylua, lute, luau-lsp, tarmac, mantle
• Studio plugins — Rojo, Hoarcekat, luau-lsp companion, Roblox's Blender add-on
• VS Code extensions — luau-lsp, vscode-rojo, selene, StyLua, roblox-ui, TestEZ Companion, and themes
• Wally packages — React, Vide, Fusion, Reflex, Charm, Lyra, ProfileStore, TestEZ, Janitor, Ripple, Remo, Promise, t, Sift, and their bindings

Maintenance badges are hand-curated rather than checked live.

Environment

Building from source

cargo build
cargo test
cargo clippy --all-targets -- -D warnings

License

MIT © Chatar Abdelilah