Step 1: Install Dependencies

Before installing proton-cad, install and ensure these resources first, in this order, in your server.cfg:

  • ox_lib
  • NativeUILua — extract as a resource named NativeUI
  • wk_wars2x — the Wraith ARS 2X radar resource, required for plate scanning

proton-cad will not start without all three.

Step 2: Download the Resource

Navigate to Admin → Servers in your community dashboard and click Download Resource. This downloads a proton-cad.zip archive pre-configured with your community URL and slug.

Step 3: Add to Your Server

Extract the zip and place the proton-cad folder inside your server resources directory, after the dependencies above.

Step 4: Generate an API Key

In Admin → Servers, click Add Server. ProtonCAD will generate a 64-character API key.

Step 5: Set Your API Key — Server-Side Only

Copy server/config_secret.lua.example to server/config_secret.lua in the proton-cad folder and paste your key there:

Config.ApiKey = "your-64-char-api-key-here"

Never put your API key in config.lua. That file is a shared script sent to every connecting player's game client — anything written there can be read by anyone on your server. config_secret.lua is a server-only file and is the only safe place for the key.

Step 6: Configure config.lua

Config.CadUrl        = "https://app.protoncad.io"
Config.CommunitySlug = "your-community-slug"

Step 7: Start the Resource

Add ensure proton-cad to your server.cfg (after the dependencies from Step 1) and restart your server.

Staying up to date

When the resource starts, and every 6 hours after, it checks your CAD for the latest version. If yours is older, the server console says so in yellow, with the version you have, the latest one and where to download it (Admin → Servers → Download Resource). Replace the proton-cad folder with the new one, keeping your config.lua and server/config_secret.lua. An up-to-date resource prints its version in green.