Prerequisites

To install Roblox Supabase on your projects, you need to make sure you have the following:

A Supabase project set up.
Your Supabase project API_URL and API_KEY.

HTTP Requests disclaimer

Make sure you activated HTTP requests on your Roblox project or any requests to the PostgreSQL endpoint of your Supabase project will fail.

See more details.

These are the only steps you must make sure you follow to install Roblox Supabase on your project.

Installation

Manual Installation

If you prefer installing manually, please follow the steps below:

Download the .rbxm file from the GitHub releases accessible from the Roblox Supabase repository.

Drag and drop the file into your Roblox Studio project.

Place the "Supabase" ModuleScript in the ServerStorage of your project.

Using Git Submodules

In order to install Roblox Supabase using git submodules, make sure:

You are using Rojo (or an alternative).
That git is installed on your computer.

Go to your project's folder and start a new CLI.

In your CLI, enter this command:

git submodule add https://github.com/chteau/Roblox-Supabase.git

Update your Rojo configuration file to point to the appropriate path and sync Roblox Supabase directly in your project.

Update your submodule to get the latest changes.

To keep Roblox-Supabase up to date with the latest changes, you can simply enter this command:

git submodule update --remote

Using Wally

You can find the package on this link.

Using wally, make sure that:

Aftman is installed.
Wally is initialized in your project.

In wally.toml, add this line:

[server-dependencies]
roblox-supabase = "chteau/roblox-supabase@<THE_LATEST_VERSION>"
...

If you use Rojo, make sure that in your default.project.json file, you reference the ServerPackage folder in order for it to be replicated on your studio. (You don't have to put this in ServerStorage, but I recommend putting this in.) - See more on this link.

{
    "name": "project-name"
    "tree": {
        "$className": "DataModel",
        ...
        "ServerStorage": {
            "Packages": {
                "$path": "ServerPackages"
            }
        },
        ...
    }
}

In your CLI, enter this command:

wally install

You can now access Roblox Supabase in your server scripts using:

local SS = game:GetService("ServerStorage")
local Supabase = require(SS.Packages["roblox-supabase"])

...

Initializing

Once Roblox Supabase placed in your Roblox project, you can just set-up a new client in order to use it.

Script.luau

local Supabase = require("<PATH_TO_SUPABASE>") -- By default, it should be available in "ServerStorage" directly.

-- Create a single client for interacting with your database
local client = Supabase.createClient({
    url = "https://xyzcompany.supabase.co",
    apiKey = "publishable-or-anon-key"
})

Parameters

Prop

Type

Options are not supported yet.

Options such as accessToken, auth, db, global and realtime are yet to be implemented.

If you wish to contribute to the project, see the contribution docs

There you go! Now you should have a functional Supabase client inside of your Roblox project!

Installation

Prerequisites

Installation

Manual Installation

Using Git Submodules

Using Wally

Initializing

Parameters

On this page