Skip to main content

# myCRED

Award points, badges and ranks to your users for various activities. Bimber includes a set of readymade hooks, badges and ranks that you can easily import.

### Installation

The plugin is available for free in wordpress.org repository. You can download it or install directly from the WP admin panel › Plugins › Add new panel.
After installing the plugin you will see the following notice:

myCRED needs your attention. Run Setup

at the top of the admin panel. Please perform the setup, it is necessary for the plugin to work.

### Activation problem

If you can't activate the plugin because of the error:

Plugin could not be activated because it triggered a fatal error.
Sorry but your WordPress installation does not reach the minimum requirements for running myCRED. The following errors were given: The mcrypt PHP library must be enabled in order to use this plugin! Please check your PHP configuration or contact your host and ask them to enable it for you!

You have to install on your server the PHP mcrypt library (myCRED uses it to encrypt data transmitted on the "front end" of your website to prevent tempering or abuse) or you can, for a development phase, disable the protection by adding the line below to your wp-config.php file:
`define( 'MYCRED_DISABLE_PROTECTION', true );`
After adding this line, you be able to active the plugin.

### Updates

As any other plugin from wordpress.org site, when new version of the plugin is available, you will be notified about it directly in your Dashboard.

### Official Documentation

Please refer to the official documentation for extensive information on the plugins functionalities.

### Basic Concepts

Hooks. The most important part. They are preset events that you can assign points for. Without defined hooks you won't gain any points, badges and finally ranks.
Example
If you enable the Publishing Content hook and set it to assign 10 points for a published post, a 10 points will be given to each user everytime they publish a post.

Points are awarded to a user for chosen actions, like adding content, leaving comments, posting on the forum etc. Every time points are added, an entry to points log is made, which contains the amount of points and the reference (action which was awarded with points)

Ranks are titles awarded to the user for getting a set number of points in total. They are displayed next to the avatar.

Badges are 'achievement' that are awarded for getting a set number of points for a chosen action. For example, you can get 'Forum Submissions' badge for getting 10 points for posting on the forum. Badges might have multiple levels.

### How to import Bimber content for MyCred?

1. Please go to WP admin panel › Appearance › Theme Options panel and choose the Tasks tab
2. In the Import MyCred section you can choose content you wish to import. The content is sorted by the associated plugins and also by the type of content (hooks, badges, ranks). Please notice, that some checkboxes might be disabled if the plugin is not active or if not all of the MyCred addons are turned on (in case of badges and ranks). Check section below to enable them.
3. Press Run Now to start the import. This might take up to a minute
4. You can clean all the MyCred content using the Reset MyCred task

### How to enable badges/ranks/notifications

1. Please go to WP admin panel › Points › Add-ons panel
2. Find the functionality you're interested in and click Activate

### How to get your first points and a badge?

After importing the content you can take a few quick steps to test the plugin with What's your reaction

1. Please go to WP admin panel › Points › Add-ons panel
2. Please enable the Notifications addon to see the notifications
3. Please go to a post and vote for a reaction. For each reaction you will receive 1 point.
4. You will receive a notification for getting points in your next page view.
5. After getting 10 points for reactions you will receive a level 1 Reactions badge.
6. You will receive a notification for getting the badge in your next page view.

### How to create a leaderboard, badges or ranks page (like on the demo)

1. Please go to WP admin panel › Pages panel and create a new page
2. Inside the page content please paste the following code: `[mycred_leaderboard template="page"]` to get the Leaderboard page
3. Inside the page content please paste the following code: `[mycred_badges]` to get the Badges page
4. Inside the page content please paste the following code: `[mycred_list_ranks]` to get the Ranks page

### How to display MyCred information in the BuddyPress profile header?

1. Please go to WP admin panel › Points › Settings panel
2. Inside the Ranks section set BuddyPress to include in the profile header
3. Inside the Badges section set BuddyPress to include in the profile header
4. Inside the BuddyPress section set Point Balance to include in the profile header

### How to customize the notifications?

1. Please go to WP admin panel › Points › Add-ons panel
2. Inside the Notifications section set Template to modify the format of the points notifications
3. Inside the Notifications section set Duration to modify the displaying time of the points notifications

### How to add my own Ranks?

1. Please make sure that the ranks addon is enabled (see above)
2. Please go to WP admin panel › Points › Ranks panel and press the 'add new' button
3. Set the title of the rank and add the rank image on the right
4. Set the point requirements (minimum and maximum), between which the rank will be awarded
5. Press publish
6. You can learn more here

### How to add my own Badges?

1. Please make sure that the badges addons is enabled (see above)
2. Please go to WP admin panel › Points › Badges panel and press the 'add new' button
3. Set the title of the badge and add the default image on the right (displayed for users without the badge, the 'locked' version)
4. You can create levels for the badge, each with it's own image, requirements and rewards
5. You can set the description to be used on the ranks page by setting the excerpt (you might have to enable it in the Screen Options at the top of the page)
6. You can change the order of rank display using the Order input on the right
7. Press publish
8. You can learn more here

### How to add my own Hooks?

1. Please go to WP admin panel › Points › Hooks panel and press the 'add new' button
2. You can choose and drag hooks like widgets to activate and deactivate them
3. For each hook you can manipulate their individual options. Please remeber to press save.
4. You can learn more here

### How to manually assign Badges and Points?

1. Please go to WP admin panel › Users panel and choose a user
2. You can give/reduce points in the Balances section
3. You can give/reduce badges in the Badges section
4. Please remember to save the changes

### How to recalculate Badges Ranks for users?

When you create or edit Badges or Ranks you might want to apply them to the users who already have fulfilled their requirements. To do this, please follow those steps:

1. Please go to WP admin panel › Points › Settings panel
2. In the Management section please press Assing Ranks to Users
3. Please go to WP admin panel › Points › Badges panel and go into the edition of the badge you wish to apply
4. Press Assing Badge. You have to do it for every badge individually

### How to use BuddyPress followers functionality?

To use this feature as seen on the demo, please install the BuddyPress Followers plugin from the WordPress repository.