Getting Started

This guide will help you set up Quebec in your Roblox game in just a few steps

📥 Installation

Note

The Rojo setup is highly recommended for large projects, especially those using multiple places or shared codebases.

Rojo Example Project

We offer an example project made with Rojo which supports a multiplace architecture with place-shared code aswell. You can find it here: https://github.com/BaxoPlenty/quebec-rojo-setup

The Rojo setup also has a branch called singleplace for projects that don't require a multiplace setup.

Manual Installation

Recommendation

We recommend parenting the Quebec module to ReplicatedStorage to avoid duplicates and mismatching versions. The Quebec module supports both client and server by default and uses RunService to determine on which platform it is running right now.

You can also manually install and set up Quebec in your Roblox game.

Option A: GitHub Releases (recommended)

1. Go to the Quebec GitHub Repository Releases

2. Download the source code of the latest release or the Roblox model file (.rbxm)

3. Open the folder in Roblox Studio using the Rojo toolchain, by importing the model file or by manually importing files into Studio

Option B: GitHub Source Code

1. Go to the Quebec GitHub Repository

2. Click Code -> Download ZIP or clone via Git: git clone https://github.com/BaxoPlenty/quebec.git

3. Open the folder in Roblox Studio using the Rojo toolchain, by importing the model file or by manually importing files into Studio

Option C: Roblox Marketplace

WIP

⚙️ Folder Structure

Quebec expects a predicatable folder layout to function properly.

We recommend placing your code folder under either ReplicatedStorage (for client code) or ServerScriptService (for server code). Inside this folder:

1. Add a Script

   1. Set the RunContext to Client or Server as needed

2. Bootstrap Quebec in that script

3. Create a folder named controllers (for client singletons) or services (for server singletons) in the same directory

Here's an example for client-side:

ReplicatedStorage
- Client/
  - controllers/
    - exampleController.luau 
  - init.client.luau -- Script that bootstraps Quebec

Note

You can rename the folders and files as long as you configure Quebec correctly. See Bootstrapping for more details.