The Requirements UI (User Interface) is the common UI used to configure steps, points awards or deducts and rank requirements.
The first time you access to any edit screen where this UI is placed, you will see this box empty without any requirement. Clicking on the add new button you will add a new requirement:
Top controls
At top of each requirement you will find some useful controls to quickly manage your requirements:
Unsaved Changes
This indicator will appear when any requirement field has changed and this change hasn’t been saved. Clicking on the save all button will remove all indicators placed.
Enable/Disable
This control will toggle the availability of the requirement. When a requirement is disabled will not take in count by the awards engine. It means that if you have an achievement that requires 2 steps, disabling one of them will make the achievement unlockable by completing 1 step (the enabled one).
Note: Requirements disabled will not be shown at frontend.
Duplicate
This will duplicate the requirement into a new one with the same configuration.
Delete
This button will delete permanently the requirement.
Reordering the requirements
You can reorder the requirements by just drag and drop them.
This order will be applied at frontend when the requirements are shown.
Configuring the requirement
Every requirement has a set of fields that will let you configure it. There is an explanation of the common fields to almost every requirement, but depending of the event you set some fields could be added or removed, for example, GamiPress – Social Share add-on adds in some events the social network field.
Event
The event is the most important field of a requirement. It defines the action a user needs to perform to achieve this requirement. You can check the list of built-in events. Some add-ons (and much more our integrations) will add new events.
Attached Post
This is a common field present on all “specific” events. GamiPress normally offers a generic event (Comment on any post) and a specific event (Comment on a specific post).
This field will let you to configure to which post is the user restricted.
If you set the event “Comment on a specific post” and you set the “Sample Page” as attached post, to achieve this requirement user will need to comment specifically on “Sample Page”, comments in other pages will not take in count to achieve this one.
Note: Some times you will be noticed that specific events are related to “posts” but this not means that it will work just for WordPress “posts” (blog entries). WordPress offers the ability to register as many post types as you want, for example, WooCommerce register a post type named “product”. Our “Comment on a specific post” event will let you to set as attached post any post that his post type has support for comments.
Required Times
This field will define the number of times a user needs to perform the action to achieve this requirement.
If you set the event “Comment on any post” and you set this field to 5, will require to the user to comment 5 times on any post to achieve it.
Limits
There is a set of fields to define requirement achieve limitations. By default all requirements are set to “Unlimited” but changing its value will show to you a new field to set the time limitation of this requirement.
The available time limitations options are: Unlimited, Per minute, Per hour, Per day, Per week, Per month and Per year.
In addition, you can check the tutorial about how the awards engine works that will help you to understand how to configure requirements applying time limits with a few real world examples.
Label
The text that will be shown at frontend. When label is empty, GamiPress will auto-generate it based on the requirement setup. If label has any content, then GamiPress won’t generate it.
Required or Optional
This field (only for steps and rank requirements) lets you make this requirement required or optional to unlock the achievement or rank.
URL
Optional, adding a URL to this field will make the requirement to be displayed as a clickable link.
Note: Events related to a specific post will get displayed automatically as a link to the specific post, even if you do not enter anything in this field. Setting up a URL will override this internal URL giving priority to the URL entered in this field.
Controls for Points awards and deducts only
When editing points awards and deducts you will see a new line with two fields.
The first field let’s you to configure the amount of points that will be awarded or deducted.
Second field is to setup the maximum number of times that can be earned or deducted for a user. If you set this field to 0 points award/deduct will be applied unlimited times. If you set it to to 5 for example, every user will be able to get awarded/deducted 5 times.
Sequential (steps and rank requirements only)
When editing steps and rank requirements you will see a new control that will let you make them sequential at the top of the requirements list:
Enabling the sequential feature will force users to complete the requirements in order. The current order number will be placed at the top bar of each requirement:
Also, disabled requirements won’t take in count on sequential order and automatically the order will jump to the next number:
Sequential Order
You can reorder the requirements by drag and drop them. Also, it will affect the way a user can earn the achievement or rank.
Imagine an achievement with the next steps:
1 – Comment on a post 1 time
2 – Publish a new post 5 times
User will need first comment on a post and before publish 5 posts to earn the achievement, but if you change the order to:
1 – Publish a new post 5 times
2 – Comment on a post 1 time
User will need first publish 5 posts and before comment on a post to earn the achievement.
Sometimes the sequential order of requirements can has a great importance depending of the events configured. A common requirements to an achievement for authors will be publish their first post and before get comments on their posts.