Quickstart

Getting started

A stash in your game's menu, filled from the platform, drawn with your own item art. About five minutes, and no C++ toolchain.

1. Get a key

Sign in to the dashboard, open an environment and issue an API key. Development keys are prefixed ex_dev_, production keys ex_live_ — the prefix is not decoration, the plugin treats them differently.

2. Install the SDK

Raid State SDK

The plugin itself. Precompiled, no C++ toolchain needed. Drops into Plugins/ in any project.

771 KB

ExtractorSDK-0.1.0-UE5.8.zip sha256 4053d5251630ffa784f1556ab0bf0f398a799bceb49903568ad360a192041b3e

USME drop-in

The SDK plus the USME stash and lobby widgets. Use this one if your project is USME — it contains the SDK, so you do not need both. Requires your own USME licence; no USME content is included.

839 KB

RaidState-USME-DropIn-0.1.0-UE5.8.zip sha256 8ddf7e3990fd5be87bfc3cf9d804c6edd01da9f7476e63133132d37031531c74

Close the editor first: Unreal reads Plugins/ once at startup and will not notice one that appeared while it was running. Then drop the folder in and reopen.

your project

<YourProject>/
├── Plugins/
│   └── ExtractorSDK/     <- from the release zip
└── Content/

3. Point it at the platform

In the Unreal toolbar, click Raid State and paste your development key. It is stored per user and never enters your .uproject or source control.

Setting	Value	Why
Base URL	https://api.raidstate.com	Where the platform lives
Development key	ex_dev_…	Editor and PIE only
Item Data Table	/Game/…/DT_ItemData	Where item art is read from — your table, not ours

If you put the URL in an .ini, quote it

Unreal's config parser treats // as a comment, so an unquoted BaseUrl=https://api.raidstate.com silently becomes https:.

4. Push your catalogue

The platform needs to know what an item is before it can hold one. From Tools → Raid State → Push Item Definitions, point it at your item DataTable. It reads names, stack sizes and grid footprints by reflection, so your row struct does not have to match anything of ours.

Art stays in your project

Only definitions are pushed. Icons are read from your DataTable at draw time — your game already has the art at full quality, and sending it back down would be slower and worse.

5. Add the stash to a menu

Open the widget your menu lives in, search the palette for Raid State Stash Panel, and drop it anywhere a widget can go. The whole layout is built in C++, so there is nothing to wire up and no widget you have to name correctly.

Layout — Slots for a Rust-like run of equal squares, Grid for Tarkov-like footprints. Match your game.
Provider — anonymous while developing, steam when you ship.
Visibility — Visible, or the panel never receives a click.

6. Press play

The grid fills with whatever the platform holds for that player, at the positions it holds them, drawn with your icons. If it says something instead, the status line under the title is the error.