Configure Rules for Achievements (Service Configuration)

This topic provides procedures for adding and changing rules for achievements in the service configuration for a title.

For an overall introduction to the various elements of the service configuration, see Introducing Service Configuration.

Sections in this topic:

What is an achievement rule?

The criteria that determines when the achievement will unlock. An achievement’s rules are effectively the instructions Xbox Live runs when it processes incoming User Stat updates for a title.

Every achievement must have at least one achievement rule and may have up to 50 rules.

Each rule contains the following fields:

Field Description
Rule name A string with a maximum length of 44 characters that contains the name for the rule. It is not displayed.
Rule type The type of the rule. Currently, the only option is “Basic”.
Stat instance The stat instance(s) upon which the rule is based. You can configure up to 50 stat instances on an achievement rule, but string stat instances are not supported. For more info on stat instances, see Introducing Service Configuration.
Action The operator applied to the stat instance(s) for the rule. Possible values are “SUM”, “MIN”, and “MAX”.
Threshold The stat instance(s) target value against which the rule is evaluated. It is typically a numeric value.

Create a rule

To create a rule that unlocks an achievement

  1. On the Service Configuration Tasks page, click Achievements & Challenges.
  2. On the Achievements & Challenges page, under Achievements, click the achievement for which you want to create a new rule.

    Important Ensure that the achievement that you clicked is selected (highlighted) before you continue.

  3. Under Rules, click New.
  4. In the Add New Rule dialog box, in the following fields, specify the values that you want.
    • Rule Name - Enter the name of the achievement rule.
      This name is used only for display purposes only within the tool, and will not be visible to users.
      Maximum string length is 1024 characters.
    • Type - Select one of the following types:
      • Basic - Achievement is unlocked when the gamer achieves the specified threshold.
      • Leaderboard - Achievement is unlocked when the gamer is among the N best scores at the end of the challenge time window, where N is equal to the threshold.
        The Leaderboard option is supported only for challenge achievements.
    • Action - Select one of the following actions:
      • Min - Achievement is unlocked when gamer achieves getting below the defined threshold.
      • Max - Achievement is unlocked when gamer achieves getting above the defined threshold.
      • Sum - Achievement is unlocked when gamer achieves or surpasses the defined threshold.
    • Threshold - Enter the value for the threshold to be referenced by the selected Action.
    • Participation Type - This option is displayed only for challenges.
      Select one of the following participation types:
      • Individual - Only the individual user will contribute toward the completion of this rule.
      • Group - The title’s community of users will contribute toward the completion of this rule.
    • Add Statistic Instance to Rule - Specify the statistic instance or instances upon which the rule is based.
      If multiple statistic instances are selected for a single rule, then the action is treated as a logical OR. That is, the rule is satisfied as soon as any combination of the statistic instances meets the threshold.
      Click on Select an instance to launch the Add Stat Instance picker. You can use the drop-down list to select the statistic rule whose value will replace the token {#} when shown to the user. Click Add Stat Instance after you’ve selected the statistic rule.
      For information about selecting a statistic instance, see Selecting a Statistic Instance (Service Configuration).
      To add more statistic instances, use the same procedure.
      • Format - StatRuleName.[EventFieldA].[Literal]
      • Example - CurrentDifficulty OR EnemyDefeated.DifficultyLevelId.1

      For more information, please contact your developer account manager (DAM) or refer to the XDK documentation.

  5. When you have all of the fields and values for your new rule the way that you want them, click Add Rule to create the rule and close the dialog box.

Your new rule is now listed on the Achievements & Challenges page whenever its achievement is selected.

You can add more than one rule to an achievement.

Multiple rules in a single achievement are treated as a logical AND. That is, the achievement will only unlock when all rules have been satisfied.

Change an achievement rule

Important

After a title passes Final Certification, existing achievement rules in that title can no longer be changed or deleted.

To make changes to an existing rule:

  1. On the Achievements & Challenges page, under Rules , click the Edit icon for the achievement rule that you want to make changes to.
  2. In the Edit Rule dialog box, make the changes that you want.
  3. When all of the options are the way that you want them, click Save Rule, and then click the Close button in the upper-right corner of the dialog box.

Delete an achievement rule

Important

After a title passes Final Certification, existing events in that title can no longer be changed or deleted.

To delete an existing rule:

  1. On the Achievements & Challenges page, under Rules , click the Delete icon for the achievement rule that you want to delete.
  2. In the Delete Rule dialog box, confirm the deletion by clicking Delete Rule.

    Important Deletion of an achievement rule is a permanent action and cannot be undone or reversed.