rproj-0.10.0 is not a library.

rproj

rproj is a guided Windows CLI for setting up Roblox/Luau development and creating consistent projects.

Status: pre-release alpha. The main workflows work, but the command surface, generated files, and rproj.toml schema may change without migration support. Use it for real projects only when you are willing to review generated changes and update with the tool.

What rproj does

rproj connects two layers that are usually assembled by hand:

Machine setup installs and configures development applications, command-line tools, Roblox Studio plugins, and VS Code extensions.
Project setup turns your choices into a Roblox project with pinned tools, dependencies, editor settings, quality checks, and optional asset workflows.

It explains the available choices before applying them. It does not hide the underlying ecosystem: generated projects remain ordinary Rojo, Rokit, Wally, Luau, and Git projects that can be maintained without rproj.

Ecosystems

Layer	What rproj manages
Windows applications	Git, VS Code, Roblox Studio, Blender, Figma, and related prerequisites
CLI toolchain	Rokit plus pinned tools such as Rojo, Wally, Selene, StyLua, luau-lsp, Lute, Asphalt, and Tungsten
Packages	Wally packages or Git submodules, including UI, state, networking, data, testing, and ECS libraries
Roblox Studio	Development plugins selected during machine setup
VS Code	Recommended extensions and project-scoped settings
Generated project	Rojo mapping, source tree, dependency manifests, lint/format/type configuration, tests, CI, and asset configuration

Use rproj info to browse the complete current catalog and rproj info <key> to inspect one entry.

Requirements

Windows with winget
Rust and Cargo for installation from crates.io or source
Network access while installing tools and packages

Install

cargo install rproj

The repository version can be installed with:

git clone https://github.com/chatarabdelilah/rproj.git
cd rproj
cargo install --path .

First project

rproj new my-first-game

On a new machine, rproj first offers the missing machine-level tools. It then asks how the project should manage packages, which packages and capabilities it needs, and which generated files to keep. The final summary is reviewable before anything is created and lists the relevant rproj configure commands for the chosen project.

After creation:

cd my-first-game
rproj watch

rproj watch restores missing project dependencies, regenerates the Rojo sourcemap, and starts the development watcher.

Commands

Command	Purpose
`rproj`	Show the product overview and command list
`rproj new <name>`	Set up the machine when needed and create a project
`rproj setup`	Review or change machine-level tools
`rproj setup <tool>`	Set up one supported tool for the current project
`rproj configure [key]`	Configure a project tool, or choose what to configure
`rproj configure project`	Edit or reset the global Rojo tree inherited by future projects
`rproj upgrade`	Re-render maintained files from the current `rproj.toml` decisions
`rproj watch`	Restore dependencies and start the Rojo development loop
`rproj copy`	Copy source files with path headers
`rproj info [key]`	Browse tools, packages, capabilities, and usage notes
`rproj --verbose ...`	Include commands and captured subprocess output

Generated project

The exact tree follows your choices. A full project can include:

my-first-game/
|-- default.project.json
|-- rokit.toml
|-- wally.toml
|-- selene.toml
|-- stylua.toml
|-- .luaurc
|-- .gitattributes
|-- .gitignore
|-- rproj.toml
|-- src/
|   |-- client/
|   |-- server/
|   `-- shared/
|-- tests/
|-- .lute/check.luau
|-- .github/workflows/ci.yml
|-- figma/
|-- asphalt.toml or tungsten.toml
`-- .vscode/settings.json

rproj.toml records the current project decisions used by rproj upgrade. During alpha, re-scaffolding is preferred when the schema changes substantially.

Project template

Run rproj configure project to customize the default.project.json used by projects created afterward. It opens a built-in, keyboard-driven Explorer; it never launches another editor. Existing projects are never changed.

Use the arrow keys to navigate, Enter to edit, Tab to switch panes, and type in searchable class and property pickers. A adds an instance, F2 renames, D duplicates, M reparents, Delete removes, and Ctrl+Z/Ctrl+Y undo and redo. The Inspector provides typed controls for common Roblox properties and attributes plus common project settings. Ctrl+E opens the complete JSON in rproj's internal text editor for uncommon Rojo values and advanced settings. Press ? in the editor for the full key list.

Ctrl+S checks the JSON, rproj-owned paths, and every reachable plain, Wally, and git-submodule mount combination with Rojo before atomically saving it under the rproj configuration directory. Validation failures leave the draft open and the last valid saved template untouched. A malformed saved file opens directly in JSON repair mode. Ctrl+R restores the built-in template after confirmation.

The project name, DataModel root, src/shared, src/server, and src/client mounts are visible but locked because rproj owns them. Package, module, server-package, and test mount names and paths are reserved because those directories depend on each new project's choices. Custom $path entries may target only the always-created source directories; use static instances and properties for other additions. The saved template is <rproj config>/templates/default.project.json.

Behavior and scope

rproj asks before optional machine-level installation and project generation.
External command output is summarized; --verbose exposes the underlying commands and captured output.
Existing user-owned configuration is preserved where a command supports merging. Unreadable configuration is refused rather than replaced.
The current implementation targets Windows. Cross-platform support is not claimed.
rproj is a development orchestrator, not a package registry, build system, game framework, or Roblox Studio replacement.

Development

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

The codebase separates CLI dispatch, decision modeling, catalogs, command orchestration, and filesystem/process steps. See Architecture, Development plan, UX redesign, and Release process.

Support

Support continued development through Buy Me a Coffee.

rproj 0.10.0