The Epic Games Plus companion plugin extends Construct’s official Epic Games plugin with access to the native Epic Online Services (EOS) Stats and Achievements interfaces. It is currently supported with the Windows WebView2 export option.
It supports reading and updating current-user stats, checking achievement progress and unlock state, and accessing achievement details and linked stat requirements.
Configuration
Stats and achievements must first be configured in the Epic Games Developer Portal for the same product, sandbox and deployment used by the official plugin.
Use stat names and achievement IDs exactly as configured. EOS stats use signed 32-bit integer values and one of four aggregation types:
- SUM: Adds the new value to the existing value.
- LATEST: Replaces the existing value with the new value.
- MIN: Keeps the lower value.
- MAX: Keeps the higher value.
Achievements can use one or more stat thresholds to track progress and unlock automatically when their requirements are met.
If publishing achievements through the Epic Games Store, also follow Epic’s Epic Games Store achievement configuration requirements.
Stats
Call Query stats before reading stat values. Specify comma-separated stat names, or leave the parameter blank to query all stats. The optional start and end times can restrict the query to a period; use `-1` for no limit.
Ingest stat submits a value to a stat. How that value is applied depends on the stat’s configured aggregation type.
For example, with a SUM stat:
Ingest stat "ENEMIES_KILLED", 1
adds `1` to the existing value.
Ingest multiple stats can submit up to 64 stats at once using comma-separated NAME=AMOUNT entries, for example:
KILLS=1,SCORE=250,DAMAGE=900
After changing stats, query them again before reading updated values. Achievement progress may also have changed, so query player achievements again when updated progress is needed.
Achievements
Call Query achievement definitions to access achievement details such as names, descriptions, icons, hidden state and linked stat thresholds.
Call Query player achievements to access the current user’s achievement progress and unlock state.
The plugin automatically queries achievement definitions first when required. EOS normally omits locked hidden achievements from player-achievement queries unless definitions have already been queried.
Add achievement progress is a convenience action for stat-based achievements. It finds the stat linked to the selected achievement threshold and submits the supplied amount to that stat.
The threshold index is zero-based. An achievement with a single linked stat therefore uses threshold index `0`.
Checking achievement state
Check achievement state checks the current state of a specific achievement directly with EOS and completes through one of:
- On checked achievement is unlocked
- On checked achievement is locked
- On achievement state check error
Use this when the game needs to confirm whether an achievement has already been unlocked before attempting to unlock it. Achievements can be unlocked with the official Epic Games plugin’s Unlock achievement action.
Testing
To use Epic Games Plus:
- Add and configure Construct’s official Epic Games plugin.
- Configure the required stats and achievements in the Epic Games Developer Portal.
- Log the user in through the official Epic Games plugin.
- Check
Is available before using Epic Games Plus functionality.
- Export using Windows WebView2.
The Epic Games Launcher does not need to be running for normal EOS functionality.
Further documentation