Configuring Quebec

You can configure the framework itself and the instances. This guide represents the framework configuration which holds just light and global configuration like logging, etc. For configuring an instance, refer to the bootstrapping guide.

🎚️ Using A Framework Configuration

The framework configuration is essentially just a table with the options seen in the table below. If no framework configuration is passed, Quebec will provide a default. You can pass the config either as a path to a ModuleScript or as a table within the instance options. For that, refer to the bootstrapping guide. Here's an example:

game.ReplicatedStorage.QuebecConfig

return {
    debug = "always"
}

init.client.luau

require(path_to_quebec)(script, {
    config = game:GetService("ReplicatedStorage").QuebecConfig
})

📦 Available Options

* Identifier + Type	Default	Description
debug?: "always" | "studio" | "never"	"never"	Sets the logging mode for the debug level
logNonCritical?: boolean	false	Sets the logging mode for the info level

* ? marks an option as optional