Bootstrapping

In order to use Quebec, you must bootstrap it. It's only one line of code, so there's no need to worry 😉

This snippet expects the Quebec module to be installed at the following path: game:GetService("ReplicatedStorage").Quebec

Obviously, you can change this path to fit your needs.

require(game:GetService("ReplicatedStorage").Quebec)(script--[[, optional options ]])

It's as easy as that! But there is one requirement: The calling script must contain a folder called controllers or services (for the singletons) or the folder exists as a child of the parent instance.

🎚️ Passing Options

The second parameter can optionally be a table of options to configure the instance:

require(game:GetService("ReplicatedStorage").Quebec)(
    script,
    {
        --[[ options ]]
    }
)

📦 Available Options

Identifier *	Type	Description
config?	ModuleScript | FrameworkConfiguration	Passes a ModuleScript containing the framework configuration or the configuration itself
exportName?	string	Exports this instance to be used in other instances
singletonFolder?	string | Folder	Sets the folder which holds singletons. This can either be a folder name or a folder directly

* ? marks an identifier as optional