# rproj
[](https://crates.io/crates/rproj)
[](#license)
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
```sh
cargo install rproj
```
## Usage
```sh
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
| `rproj` | Welcome screen. Touches neither disk nor network. |
| `rproj new <name>` | Scaffold a project. `--like <setup>` reuses a saved selection, `--save-setup <name>` saves one, `--reconfigure` re-asks the machine questions. |
| `rproj setup` | Machine provisioning on its own. Optional — `rproj new` is self-sufficient. Safe to re-run. |
| `rproj configure [tool]` | Walk through a tool's settings one at a time, explaining each, then merge them into its config file. Covers `stylua`, `selene`, `luau-lsp`. |
| `rproj upgrade` | Re-apply generated config to an existing project, so it picks up fixes shipped since. Shows the plan and asks first. |
| `rproj watch` | From inside a project: install anything missing, then run Rojo's sourcemap watcher. |
| `rproj copy` | Copy everything under `src/` to the clipboard, with path headers. |
| `rproj info [key]` | What a tool or package is for, when to reach for it, and the commands to type. |
| `-v`, `--verbose` | Show every sub-process and its output. |
### 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
```text
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. "Is this a good choice for a new project" is a judgement, and a last-commit timestamp does not make it — a feature-complete library with no commits in a year is fine, and a repository with daily commits may be pre-alpha churn.
What *is* objective — whether a repository has been archived — is checked weekly in CI against every catalogued repo, so a badge cannot silently contradict upstream.
## Environment
| `RPROJ_NO_EMOJI=1` | Use `+` / `-` / `!` markers instead of emoji — for log files, CI transcripts, or screen readers. |
| `RPROJ_NO_UPDATE_CHECK=1` | Don't check crates.io for a newer version. |
## Building from source
```sh
cargo build
cargo test
cargo clippy --all-targets -- -D warnings
```
## License
MIT © Chatar Abdelilah