roblox-rp

QBCore-inspired roleplay framework for Roblox, structured for Rojo-based development.

Overview

This repository maps game code into Roblox services using default.project.json and a src/-first workflow.

Key mapped services include:

• ReplicatedStorage shared modules/remotes (e.g. QBShared, QBCoreClient, QBRemotes)
• ServerScriptService/QBCore server-side framework code
• StarterPlayer/StarterPlayerScripts client systems (HUD, inventory, banking, garage, jobs, phone, admin, weather, etc.)
• ServerStorage content folders for weapons, vehicles, and interiors

Project Structure

• src/ — source code synced into the Roblox DataModel via Rojo
• default.project.json — Rojo project mapping
• serve-rojo.ps1 / serve-rojo.bat — helper scripts to run Rojo locally
• docs/ — project documentation/static docs assets

Prerequisites

• Rojo 7.7.0

The provided PowerShell script is pinned to Rojo 7.7.0 and will fail if a different version is found.

Local Development

1) Start Rojo server

On Windows (PowerShell):

./serve-rojo.ps1

Or via batch wrapper:

serve-rojo.bat

This starts:

rojo serve default.project.json --port 34872

2) Connect from Roblox Studio

Use the Rojo Studio plugin to connect to localhost:34872 and sync the DataModel from this repository.

Notes

• This repository currently focuses on source layout and framework modules.
• Some runtime assets/folders are marked with $ignoreUnknownInstances in default.project.json so Studio-only instances can coexist.

License

Licensed under GNU GPL v3.0. See LICENSE.