Installation
Getting started with Traderie in Roblox is easy. The Studio plugin installs each Traderie runtime package separately, so you can add only the pieces your game needs.
Which setup do I need?
Most games only need the packages that match their current trading setup:
| Your game has... | Install | What you implement |
|---|---|---|
| An existing trade system | Traderie API | Call SaveTradeAsync when your trade completes. |
| No trade system yet | Trade System and optionally Trade UI | Implement InventoryAdapter so Traderie can read and move inventory entries. |
| A custom UI planned | Trade System | Build your own UI against ReplicatedStorage.Traderie.TradeSystem.Client. |
| Traderie's first-party trade UI | Trade System and Trade UI | Configure inventory data and optionally edit the generated theme. |
Use Data Sync with any setup when you want Traderie to import your catalog or item metadata from ModuleScripts in Studio.
If Trade System and Traderie API are both installed and configured, completed Trade System trades are reported automatically. You only need to call SaveTradeAsync yourself when you are using your own trade system.
Installing the Plugin
📥 Download the plugin here: TraderiePlugin.rbxm
Put it into your plugins folder. You can get there by pressing the Plugins Folder button under the Plugin tab in the toolbar.
Close and re-open your Roblox Studio.
You will now see a Traderie section under the Plugins tab in Studio
Install Runtime Packages
The plugin includes separate install and update buttons:
- Install Trade System adds the headless trade runtime.
- Install Trade UI adds the first-party trade interface.
- Install Traderie API adds the Traderie API SDK.
If Roblox Studio prompts you to give the plugin permission to insert scripts into your experience, select Allow.
The plugin preserves developer-owned config modules when you update a package:
| Package | Runtime path | Developer-owned files |
|---|---|---|
| Trade System | ServerScriptService/Traderie/TradeSystem and ReplicatedStorage/Traderie/TradeSystem | ServerScriptService/Traderie/TradeSystemConfig/InventoryAdapter |
| Trade UI | ReplicatedStorage/Traderie/TradeUI, StarterGui/TraderieTradeUI, and StarterPlayer/StarterPlayerScripts/TraderieTradeUI | ReplicatedStorage/Traderie/TradeUIConfig/Theme and ReplicatedStorage/Traderie/TradeUIConfig/TradeClient |
| Traderie API | ServerScriptService/Traderie/API and ReplicatedStorage/Traderie/API | ServerScriptService/Traderie/Config/Config |
Configure API Key
Click Traderie API Settings and this window will pop up
Enter your Traderie API Key
Click the Save button. This writes your API key to ServerScriptService/Traderie/Config/Config for the Traderie API package.
Your API key is a per-game secret. Keep it in Traderie's generated config module, do not paste it into client code, and do not commit it to a public repository. If a key is shared in the wrong place, ask Traderie support to rotate it.
Enable Roblox Services
In Roblox Studio, go to the Home tab and press Game Settings. Under the Security tab, enable Allow HTTP Requests and Enable Studio Access to API Services. This allows the Traderie API package to make requests to Traderie.
Package Requirements
Use the packages together or separately:
- Install Trade System when you want Traderie to handle trade requests, offer state, escrow, rollback, and commit.
- Install Trade UI when you want Traderie's first-party interface. The default UI expects the Trade System client, but you can replace
ReplicatedStorage/Traderie/TradeUIConfig/TradeClientto connect it to a custom backend. - Install Traderie API when you want to save completed trades or use Traderie users/reviews APIs.
When both Trade System and Traderie API are installed and configured, completed trades are reported automatically through the API package.
You do not configure a Traderie schema or game id manually. The SDK derives the schema automatically from the current Roblox experience as roblox_<game.GameId>. If Traderie support asks for your numeric Roblox game id during onboarding, you can run this in the Studio command bar:
print(game.GameId)