RSG Framework
Getting Started

Licenses

How RSG identifies players, and when you need a Steam Web API key.

RSG Framework identifies players by their Rockstar license. This is the default identifier used throughout the framework for saving characters, permissions, bans, and more. It works out of the box with no extra setup.

When you need a Steam Web API key

Some third party scripts and systems identify players by their Steam hex identifier instead of the Rockstar license. If you run any resource that requires a Steam identifier, your server needs a Steam Web API key so it can read that identifier.

Add your key to server.cfg:

set steam_webApiKey "YOURAPIKEYHERE"

Keep your API key private. Do not commit it to a public repository or share it publicly.

Getting your API key

You can obtain a free Steam Web API key from the official Steam developer page:

Sign in with your Steam account, register a domain name (any value works for a game server), and copy the generated key into the steam_webApiKey convar shown above.

If none of your resources require a Steam identifier, you can leave this unset — RSG only needs the Rockstar license to function.

On this page