Roblox key

Optional. Only for the stuff Roblox requires auth for.

Most of RbxNative works without a Roblox account. A key is for publishing, My Games, version history, DataStores, and downloading plugins from the store.

Making a key

  1. Sign in to the Creator Dashboard and open API Keys, under Open Cloud.
  2. Create a key and give it only the scopes you need. The setup wizard tells you which ones it wants, and a feature missing one names it in its error.
  3. If the dashboard lets you lock it to specific experiences or IPs, do it. Less damage if it ever leaks.
  4. Copy it, Roblox only shows it once.

Adding it

Paste it in the first-run setup or later under Home, Manage key. It goes in your OS keyring.

For scripts and CI, rbxcloud and the editor also read these, in this order:

  1. The RBX_API_KEY environment variable.
  2. A plain text file at ~/.config/rbx-native/api_key. Run chmod 600 on it, the loader warns you if other users can read it.

Never commit a key, in this repo or any other.

Signing in

Separate from the key. Play, Team Create and presence use a Roblox sign-in, done by code from the first-run setup or Settings, Account.

PreviousInstallNextPlaytesting