Game SDK
Achievements
Define achievements for your game in the developer portal, then unlock them from the game.
Define them
Open your game in the developer portal and add achievements under Achievements. Each has a key (used in your code), a name, a description, an XP reward, and a type:
| Type | How it unlocks |
|---|---|
| Unlocks once | Your game calls unlock(key). |
| Progress to a target | Your game calls setProgress(key, value). Progress only goes up; reaching the target unlocks it. |
Mark an achievement hidden to show it as "???" until a player unlocks it, or switch it off to stop new unlocks. Keys only have to be unique within your game.
Unlock them
await sdk.achievements.unlock('first_win');
await sdk.achievements.setProgress('coin_hoarder', coins); // e.g. 40, then 75, then 100
const list = await sdk.achievements.list(); // with this player's progress- Players must be signed in; guests get
NOT_SIGNED_IN. - ARCADE shows a toast, adds a notification and awards the XP once, the moment an achievement unlocks. Live XP events multiply it.
- Calls are limited to 10 a minute per player: call setProgress at milestones, not every frame.
- The server checks the game session, that the key belongs to your game and that the achievement is switched on. It does not run your unlock conditions; describe them so players and reviewers know.
- In local mode every key works, so you can build the calls before defining the achievements.
Without the SDK
Games that already use ARCADE's built-in bridge can make the same calls on window.__arcadeGameApi. Each resolves to { status, data?, error? } and never throws.
await window.__arcadeGameApi.unlockAchievement('first_win');
await window.__arcadeGameApi.setAchievementProgress('coin_hoarder', coins);
await window.__arcadeGameApi.listAchievements();