Quick Start

About 569 wordsAbout 2 min

GuideQuick Start

2026-01-24

Environment Requirements

Familiarity with your own development environment
Install Roblox Studio

There are different ways to install RbxPI depending on your development environment.

Roblox Install Manager Recommandé

The Roblox Install Manager is a program that allows you to install and update RbxPI as easily as possible.

It is impossible to update RbxPI if your installation was not done via Rojo.

To install rbxManager, please follow these steps:

Clone the Git repository of rbxmanager

git clone https://github.com/rbxpi/rbxmanager

Go to the RbxManager directory.
```
cd rbxmanager
```
Install the required dependencies
```
pip install -r requirements.txt
```
Run the program
```
python3 rbxmanager
```
Follow the rbxmanager installation steps

Install via Roblox Studio Recommended for beginners

If you are simply using Roblox Studio, you can install the model directly from the Creator Marketplace on Roblox. This allows you to install RbxPI in the simplest and most secure way possible.

Note

The Roblox model does not add anything to RbxPI. However, modifying this version is not recommended.

If you want to create a fork of RbxPI, it is preferable to do so via Rojo to allow for better versioning.

Install via Rojo & GitHub

Warning

This solution is not compatible with operating systems that are not supported by Roblox. If you want to know whether your machine is compatible, please refer to the Roblox documentation.

If you want to install RbxPI anywhere other than Roblox Studio, you must first have the following prerequisites installed:

Visual Studio Code
Rojo v7 or a later version
An implementation of a language server for the Luau programming language
The latest version of Git

Manual Installation

Warning

This solution assumes that you have already installed and configured the tools that were required for your project.

If you want to install RbxPI manually, please follow these steps:

Create the RbxPI Directory

cd path/to/your/project/
mkdir replicatedstorage-folder-name

Clone the Repository

git clone https://github.com/rbxpi/rbxpi-core

Move the RbxPI Source Folder

cd rbxpi-core/src/
cp RbxPI/ /path/to/your/replicatedstorage/folder/

Delete the Repository

cd path/to/your/project/
rmdir ./rbxpi-core/

Configure the Build Script
Add the following elements to default.project.json in the "tree" element:
```
"ReplicatedStorage": {
  "$path": "path/to/the/replicatedstorage/folder"
}
```
Launch Development
```
rojo serve
```
Warning
If an error message is displayed, please regenerate your sourcemap.json
Installation Complete

Directory Structure

For projects created via rbxmanager tool, the typical file structure is as follows:

.git

src# Source code directory

replicatedstorage

RbxPI# RbxPI source code

Include# RbxPI internal files directory

Lib# Packages directory

__rhello__

site-packages

…

API.luau# RbxPI API

LICENSE.luau

Version.txt

…

.gitignore

aftman.toml

default.project.json

README.md

selene.toml

sourcemap.json

Manually created projects can also be organized using this structure as a reference.

The Lib folder is where you will place the various packages you want to import; they will be read directly by RbxPI.

En Savoir Plus sur RbxPI

Now that you have a functional package repository, you should consult the following guide to learn more about RbxPI and find out how to import a package.