Configure Epic Games Store achievements in your product

If you publish your product on the Epic Games Store, you can enhance your product's user experience with Epic Games Store achievements. Epic Games Store achievements extend the functionality of Epic Online Services achievements. You can use them to reward your users with experience points (XP) and other benefits in their Epic Profile. Learn more about Epic Games Store achievements.

Ensure that your organization can publish to the Epic Games Store

You can only add Epic Games Store achievements to your product if your organization can publish to the Epic Games Store. If your organization is not set up to publish to the Epic Games Store, please request access.

Get your product ready for Epic Games Store achievements

Before you can add Epic Games Store achievements to a product, you must configure the product to use Epic Games Store achievements. Follow the on-screen three-step onboarding process:

  1. Sign the updated Developer Agreement.

    • You only need to do this once for your organization.

  2. Generate Dev and Stage sandboxes and deployments.

  3. Choose a deployment in each sandbox to be used by Epic Games Store achievements.

Step 1: Sign the updated Developer Agreement

The owner of your organization must read and sign the updated Developer Agreement. You cannot use Epic Games Store achievements until your organization owner accepts this agreement. Only your organization owner can follow this procedure.

To read and sign the agreement:

  1. As the organization owner, sign in to the Dev Portal.

    • If you are not the organization owner, ask them to follow this procedure.

  2. Go to Your Product > Game Services > Achievements > Epic Games Store achievements.

  3. Select Developer agreement.

  4. Read and sign the updated Developer Agreement.

Steps 2 and 3: Generate and choose sandboxes and deployments

To set up Epic Games Store achievements, you must first generate Dev and Stage sandboxes and deployments in your product. You must also choose one deployment in each of these sandboxes to be the deployment that's used by Epic Games Store achievements. Epic Online Services associates all user data for a product, including achievement data, with a specific deployment.

To generate and choose sandboxes and deployments:

  1. In the Dev Portal, go to Your Product > Game Services > Achievements > Epic Games Store achievements.

  2. If you have not already completed Step1: Sign the updated Developer Agreement, you will need to do so before you proceed.

  3. Select Generate to generate new Dev and Stage sandboxes, and the associated deployments.

    • You can skip this step if your product already has Dev and Stage sandboxes configured, with one or more deployments in each.

  4. Select a primary deployment for each sandbox. This deployment will contain your Epic Games Store achievements.

  5. Select Submit.

Create Epic Games Store achievements in your product

There are two ways to create Epic Games Store achievements in your product, as follows:

Upload Epic Games Store achievements in bulk

Use the bulk import feature to add multiple Epic Games Store achievements at the same time. You must do this in the deployment that is linked to Epic Games Store achievements in your Dev sandbox.

At the start of this process, you must do one of the following:

  • Method 1: Export your current Epic Online Services achievements from your Live deployment to a zip file. We recommend this method if you already have achievements defined for your product.

  • Method 2: Download the Epic Games Store achievements template CSV shown in the second screen below.

You can then define your achievements in the downloaded file and import the file back into the Dev Portal.

Method 1: export your current Epic Online Services achievements

  1. Go to Game Services > Achievements > Epic Online Services achievements.

  2. In the Deployment drop-down, switch to your Live sandbox.

  3. Select BULK IMPORT/EXPORT.

  4. Select EXPORT CURRENT ACHIEVEMENTS.

  5. Close the bulk exporter.

Now you can define and upload and upload your achievements.

Method 2: download the Epic Games Store achievements template

  1. Go to Game Services > Achievements > Epic Online Services achievements.

  2. In the Deployment dropdown, switch to your Dev sandbox.

  3. Select BULK IMPORT/EXPORT.

  4. Select NEXT.

  5. Select DOWNLOAD Epic Games Store achievementS ZIP TEMPLATE.

  6. Close the bulk exporter.

Now you can define and upload and upload your achievements.

Define and upload your achievements

No matter which of the above methods you used, you must now add your achievements to a csv file and then upload that file.

  1. On your computer, extract the zip file you downloaded.

  2. Open achievementDefinitions.csv.

  3. If the last column is not called user_epic_achievements_xp, add this column.

  4. Populate the file with the appropriate values for your achievements.

  5. (Optional) Edit achievementLocalizations.csv. In this file, you can add localized text and associate images with your achievements.

  6. Add the files, including your modified achievementDefinitions.csv' file, into a new zip archive. Place all the files at the root level of the zip archive.

  7. In the Dev Portal, go to Game Services > Achievements > Epic Online Services achievements.

  8. In the Deployment dropdown, switch to your Dev sandbox.

  9. Select BULK IMPORT/EXPORT.

  10. Select NEXT.

  11. Scroll down to read and agree to the warning message.

  12. Select CHOOSE FILE TO UPLOAD and select your zip archive.

Image: Example achievement definition in the CSV file Image: Example achievement definition in the CSV file.

Check your achievements import

After you import your achievements, you can check that they satisfy the criteria in XP (Experience Points) requirements for achievements.

To check your achievements import:

  1. In the Dev Portal, go to Your Product > Game Services > Achievements > Epic Games Store achievements.

  2. At the top of the screen, look at the PUSH TO STAGE button.

    • If the button is enabled, then your achievements passed validation. This means they satisfy the criteria in XP (Experience Points) requirements for achievements. Skip ahead to step 4 of this procedure.

    • If the button is disabled, then your achievements did not pass the criteria. Expand the message to view the details of how your achievements failed validation. Common errors are missing or incorrect XP values, an XP total that does not equal 1000, incorrect icon file sizes, and exceeding character limits. Learn more about XP requirements.

  3. Resolve the errors in your file, update your zip archive and then upload the zip archive with the bulk import process again.

You can validate your Epic Games Store achievements in your product before you push them to Stage. To do so, create a build of your product that uses the Dev sandbox and deployment associated with your achievements during SDK initialization.

If you push your achievements to Live, you can preview them on the Product Detail Page and Achievement Details Page. To do that, you first need to push your achievements to Stage for moderation review and approval.

Create and link a single Epic Games Store achievement

Note: This section explains how to create and link a single Epic Games Store achievement. If you already have Epic Online Services achievements in your product, we recommend that you instead bulk upload your Epic Games Store achievements.

When you create an Epic Games Store achievement, you link it to an Epic Online Services achievement and assign it an XP value. If you don't have an appropriate Epic Online Services achievement, you can quickly create one in the Dev Portal.

Create an Epic Online Services achievement corresponding to your Epic Games Store achievement

Note: If you already have an Epic Online Services achievement corresponding to your Epic Games Store achievement, then you can go right ahead to create your Epic Games Store achievement.

There are two ways to define Epic Online Services achievements:

  • Write some corresponding code in your product before you launch. Learn more about Epic Online Services achievements.

  • Base each Epic Online Services achievement on a stat. For example, if you want to create an achievement that rewards a user for traveling a certain distance in a game, then you first need to create a stat to track player travel distance. You then base the achievement on this stat.

To create an Epic Online Services achievement:

  1. Go to Game Services > Achievements > Epic Online Services achievements.

  2. In the Deployment dropdown, select the deployment associated with your Dev sandbox.

  3. Select CREATE NEW.

  4. If you want to base this achievement on a stat, select the stat.

    • For example, if you want the achievement to unlock when the product user collects a certain number of items, select the stat relating to the number of items collected.

  5. If you selected a stat in step 4, enter the stat value that unlocks the achievement.

    • For example, if you want the achievement to unlock when the product user collects five amulets, enter 5.

  6. Click NEXT.

  7. Enter settings for the achievement as follows:

    • Achievement ID: A unique value that identifies the achievement.

    • Select Locale: The locale to which the name and description applies. You can define a different set of Epic Games Store achievements for each language the Epic Games Store supports.

    • VISIBILITY: Determines whether the achievement is visible to product users before they unlock it.

    • UNLOCKED ICON: Upload an icon that the Epic Games social overlay or your product displays after a product user unlocks the achievement.

    • LOCKED ICON: An icon displayed to the product user before they unlock the achievement. Note: This icon does not display to your product users for the associated Epic Games Store achievement. Instead, users see a semi-transparent version of the unlocked icon.

    • Locked Display Name: The name displayed to the product user before they unlock the achievement.

    • Locked Description: The description displayed to the product user before they unlock the achievement.

    • Unlocked Display Name: The name displayed to the product user after they unlock the achievement.

    • Unlocked Description: The description displayed to the product user after they unlock the achievement.

    • Flavor Text Optional: Optional extra text that you can freely use in your product.

  8. Select CREATE.

Create and link an Epic Games Store achievement

Note: You must link each Epic Games Store achievement to an Epic Online Services achievement. If you don't have an appropriate Epic Online Services achievement, you can quickly create one in the Dev Portal.

To create a new Epic Games Store achievement:

  1. Go to Game Services > Achievements > Epic Online Services achievements.

  2. In the Deployment dropdown, select the deployment associated with your Dev sandbox.

  3. In the list of achievements, find the Epic Online Services achievement you want to link to your new Epic Games Store achievement.

  4. Select … > Link achievement.

  5. Enter an XP value for the achievement.

  6. Select CREATE LINK.

Edit an Epic Games Store achievement's XP value

You can edit the XP awarded by an Epic Games Store achievement.

Note: You cannot change an Epic Games Store achievement's XP value after you push the achievement to Live.

To edit the XP awarded by an Epic Games Store achievement:

  1. Go to Game Services > Achievements > Epic Online Services achievements.

  2. In the dropdown above your Epic Online Services achievements, select the deployment associated with your Dev sandbox.

  3. Select Epic Games Store achievements.

  4. Find the achievement whose XP you want to modify.

  5. Select ... > Edit XP.

  6. Enter a new XP value.

  7. Select SAVE.

Unlink and delete an Epic Games Store achievement

You can unlink an Epic Games Store achievement from the associated Epic Online Services achievement. When you do this, the following applies:

  • Your action deletes the Epic Games Store achievement.

  • Your action does not delete the associated Epic Online Services achievement.

Note: You cannot unlink an Epic Games Store achievement in the Dev Portal if the achievement is pushed to Live. To delete an achievement in this situation, contact Epic Games support.

To unlink and delete an Epic Games Store achievement:

  1. Go to Game Services > Achievements > Epic Online Services achievements.

  2. In the dropdown above your Epic Online Services achievements, select the deployment associated with your Dev sandbox.

  3. Select Epic Games Store achievements.

  4. Find the achievement you want to unlink and delete.

  5. Select ... > Unlink.

  6. Select REMOVE LINK.

View your live Epic Games Store achievements

To view your product details page and the new achievement details page for your product, first ensure the following:

  • You have pushed your product to Live.

  • Your product has a catalog item.

  • Your product has an offer.

To view the achievement details page, use the following URL. Replace <product-name> with the name of your product. /store/en-US/achievements/<product-name>

uea_pa_0.png Image: Example achievement details page.

You can now push your achievements to your Stage sandbox. For information, see Publishing, moderation, and approval.

Publishing, moderation, and approval

Note: After you make an achievement live, you cannot remove it or adjust its XP value. In order to change the text or images, follow the normal publishing flow as described in this section. If you need to delete an achievement, contact Epic Games support.

The publishing workflow

To make your achievements live, so that users can see them, follow the publishing workflow:

  1. In your Dev sandbox, create your achievements.

  2. Push your achievements to your Stage sandbox. Epic Games reviews the achievements as part of its moderation process.

  3. Push your achievements to your Live sandbox.

Note: When you push Epic Games Store achievements from one sandbox to another, they replace any achievements in the deployment linked to the destination sandbox.

Push your achievements to Stage

To push your achievements to Stage, select PUSH TO STAGE above your achievements list. If the button is not active, then there are errors that you must resolve first. An alert box on the page lists these errors.

Achievement moderation

During the moderation process, Epic Games looks for inappropriate content such as mature content, profanity, and asset flips.

Epic Games does not moderate unlinked achievements (in other words, Epic Online Services achievements). Epic Games only moderates Epic Games Store achievements.

If your Epic Games Store achievements fail moderation

If Epic Games rejects any of your Epic Games Store achievements, you see the message below in the Stage sandbox. uea_pma_2a.png

To view more information, select SEE DETAILS. uea_pma_2c.png

To fix the issues, switch to your Dev sandbox, make any necessary changes and then resubmit your achievements to Stage for approval.

Note:

  • When you push to Stage, you can make more changes at any time before product approval. To do so, cancel the push to Stage, make the changes in your Dev sandbox, and then push the product to Stage again.

  • When you make any changes to an achievement set, you must re-submit the full set of achievements to Stage for moderation.

When your achievements pass moderation

When Epic Games approves your achievements, you see a message at the top of your screen and a button to push them Live.

Push your achievements to Live

When you make an achievement live, the following limitations apply:

  • You cannot adjust a live achievement's XP.

  • To delete a live achievement, you must contact Epic Games support.

  • To change a live achievement's text or images, follow the normal publishing flow.

To make your achievements live:

  1. Switch to your Stage sandbox.

  2. Above the achievements list, select PUSH TO LIVE.

XP requirements for Epic Games Store achievements

Your Epic Games Store achievements' XP (Experience Points) must follow these requirements:

  • Each product must have exactly 1000 XP in total, regardless of how many achievements you define.

  • You will receive an error message if you try to add more or less than 1000 XP for a game.

  • You cannot push your achievements from Dev to Stage if your product's XP is more or less than 1000.

  • You can view your product's XP total in Game Services > Achievements > Epic Games Store achievements, above the achievements table.

  • The XP value for each achievement must be a multiple of 5 (such as 5, 10, 15, 100, 110, or 200).

  • The minimum XP for a single achievement is 5 and the maximum is 200.

  • Note: If you plan to add DLC with achievements, or require more than 1,000 total XP across your achievements, you should continue to use Epic Online Services achievements. Support for more than 1,000 XP is coming in a future release.

  • Note: Epic Games Store achievements are classified as bronze, silver or gold as follows:

    • 5-45 XP: bronze

    • 50-95 XP: silver

    • 100-200 XP: gold

    • There is an additional platinum tier achievement. The product user unlocks this achievement when they earn a total of 1000 XP in a product.