1. Documentation
  2. Getting Started
  3. Achievement Types

Achievement Types

GamiPress lets you to define unlimited achievements to award to your users named achievement types. You can configure as many achievement types as you like: Badges, Quests, etc, and in each achievement type you can configure unlimited achievements to award your users for interacting with your site.

Configuring an achievement type

When you create an achievement type you can set up the singular and plural name to be used when GamiPress works with this achievement type.

Also there is a special field named slug. The slug field is used for internal references, as some shortcode attributes, to completely differentiate this achievement type from any other. The slug follows the same workflow as WordPress so if you set up an achievement type like “My Achievement Type” the slug for this achievement type should be “my-achievement-type”. Leave this field blank to let to GamiPress generate one based on the singular name.

Adding an achievement

After adding a new achievement type a new menu will appear in your admin area named Achievements. Inside the achievements menu will appear new sub menus with each achievement type registered to let you manage the achievements similar to WordPress default posts or pages.

On the achievement edit screen you have the Achievement Data box that includes some useful options to configure the way an achievement will work. The available options are:

Points Awarded:
The amount of points to award to the user for earn the achievement (Optional).

Points Type:
The points type of the amount of points to award (Optional).

Earned by:
To define how this achievement can be earned. Choosing “Completing steps” will add a new box to configure the steps required. To find more information about how this steps work visit this page.

Sequential Steps: (Only if achievement is set up to earned by completing steps)
Checking this option will force users to complete the steps in order.

Minimum Points Required: (Only if achievement is set up to earned by a minimum number of points)
The fewest amount of points required to earn the achievement.

Points Type Required: (Only if achievement is set up to earned by a minimum number of points)
The points type of the amount of points required to earn the achievement (Optional).

Rank Type Required: (Only if achievement is set up to earned by reaching a rank)
The rank type of the rank required to earn the achievement (Used to quickly filter the options showed at rank required field).

Rank Required: (Only if achievement is set up to earned by reaching a rank)
The rank required to earn the achievement.

Show Earners:
Checking this option will add a list of users who have earned this achievement on the achievement single view.

Congratulations Text:
The text displayed after achievement is earned.

Maximum Earnings:
Maximum number of times a user can earn the achievement. You can leave it empty for no maximum.

Hidden:
Checking this option will hide the achievement on frontend.

Allow unlock with points:
Checking this option will allow users to unlock this achievement by expend an amount of points.

Points to Unlock:
Amount of points needed to optionally unlock this achievement by expending them.

Points Type to Unlock:
Points type of points required to unlock this achievement by expending them (optional).

For each achievement you create you can configure an unlimited number of required steps to be considered complete. For more information about how this steps work visit this page.

Manually award or revoke an achievement


Administrators that meet the minimum role to administer GamiPress can award or revoke any achievement or step from the user edit profile screen. Automatically this action will be registered on GamiPress logs using the “Achievement Awarded” log pattern.

Was this article helpful to you? Yes 2 No

How can we help?