Step 1: Achievement settings

This is the first page you land on when you press the Create action button to start creating an Achievement. Fill in the Achievement Name, State and Description. Some fields are mandatory, others are optional. The tutorial provides all the information needed to fill out all Achievement creation fields. The Settings Section provides basic information on the state, visual display icon, name, description and status of an achievement.

You can check more about the achievements model in our API documentation Achievements.

SETTINGS fields

EXAMPLES

» Status Enum: Draft, Live

Mandatory

The status of the Achievement.
  • Draft – not shown to the public and can be edited
  • Live – public and cannot be edited.

An achievement in Live state cannot be edited.

» Icon String

Mandatory

An icon to visually display the Achievement

Icons need to be pre-uploaded. Documentation on how to pre-upload icons can be found here.

» Name String

Mandatory

The name of the Achievement that a player sees when it is received.

 

» Description String

Optional

The Achievement description visible to players previewing an achievement.

 

» Initial state Enum: 1, 0

Mandatory

The state of the achievement:
  • Revealed
  • Hidden (the user is not shown how to get the Achievement)

 

This feature for front-end implementation indicates to your developers if an Achievement will be displayed or not.

APP Example:

StatusDraft
Icon
NameWelcome back
DescriptionDaily login
Initial stateRevealed

API Example:

{
    "jsonClass": "Achievement",
    ...
    "achievementLiveStatus": "Draft",
    "icon": "07PbzGUBOmEkXOJnaWOs",
    "name": "Welcome back",
    "description": "Daily login",
    "initialState": 0,
    ...
}

The API example provides only a simplified version of the POST body. A full example of POST Achievement can be found in the Achievements APP API documentation here.

MISSING ENTRIES
If any mandatory fields are missing, the field is shown in red as in the example below.

CONTINUE – Click Next and continue to the next step.

Back To Top