Learndash myCred Integration - Overview

Installation / Setup Instruction:

Following are the step by step instructions to setup Learndash myCred Addon.

  • Install Learndash plugin & activate it
  • Install myCred plugin & activate it
  • Install Learndash myCred integration add-on
  • Setup myCred add-on using the link under plugin’s menu named ”myCred setup.”Uploaded by Awesome Screenshot Extension
  • Reload WP-admin area; you will see a new menu named “points” (or with the name you wrote during setup). You are now ready to explore the addon
  • You can see a Learndash sub-menu under Points. From where you can configure your Learndash myCred addon settings

Note: It is essential to set up myCred default point type to have this addon working.

Hooks:

Navigate to Points (default point type) or any other point type then go to Hooks. You will find a LearnDash widget under Available Hooks for each one of your myCRED point types.

Drag and drop this widget to the Active Hooks section, this step is necessary for each one of your myCRED point  type . Make sure to repeat this step for all of your myCRED point types, to award points globally or on a per course/lesson/topic/quiz basis on the following LearnDash actions.

LearnDash myCRED integration addon

Then set the points for completing courses/lessons/topics/quizzes accordingly.

Note:  The points selected here will be global overall on this point type and only single course/lesson/topic/quiz page settings will override these points.

General Options:

Award Quiz score as myCred points:

This option is going to award the default Learndash quiz score points as myCred points.

Steps:

Following are the steps to award quiz score as myCred points.

  • From Default Points > Learndash > General Options > Award Quiz score as myCred points select any option from No, If quiz passed and Awards points in any case
  • Set Quiz score multiplier to 1 ( to award quiz score as it is )
  • Complete quiz from frontend and it will award earned score points as myCred points

NO: If the selected option is NO, then no quiz score points will be awarded after completing the quiz.

If quiz passed: If the selected option is If quiz passed, then quiz score points will be awarded when a quiz is passed.

Awards points in any case: If the selected option is Awards points in any case, then quiz score points will be awarded on passing as well as failing the quiz.

Note: Quiz score multiplier will multiply the score with the input number. For example, if quiz score is 50 and value in quiz score multiplier is 2, then it will award 100 points.

Delete User Creds:

Delete user creds deletes all the credits/points earned by the specific user and reset points to 0.

Steps:

Following are the steps to delete user creds.

  • Enable delete cred option from Default Points > Learndash > General Options > Delete User Creds
  • Now the plugin will delete user creds too when deleting course data permanently.

How to Delete User Creds:

Allow Multiple Creds:

If checked, it allows users to earn credits/points multiple times when re-attempting a course/lesson/topic/quiz.

Steps:

Following are the steps to allow multiple creds.

  • From Default Points > Learndash > General Options check this option Allow Multiple Creds
  • Go to users and open a specific user profile by clicking on the user
  • Check the option Permanently Deleted Course Data at the very bottom of the profile and select update (make sure that delete user cred option is unchecked)
  • It will award points to the user on completing the course again.

Note: User can earn credits/points multiple times on retake/restart quiz but deleting data for courses/lessons/topics course from the user profile is necessary as Learndash doesn’t allow to retake courses/lessons/topics.


Badges Options:

Activate myCred Badges addon before using badges option. Follow the steps below to enable badges.

Steps to enable Badges:

  • After installation/setup of the addon, You have to activate badges addon (built-in in myCred Plugin) from WP-admin  → Points → Add-onsUploaded by Awesome Screenshot Extension
  • After activating badges add-on, you can find badges sub-menu under Points main menu; here you can create new badges and its levels.
  • You can see your added badges on Courses, Lessons, Topics & Quizzes edit pages.

Allow student to earn badges at course completion:

This option allows the user to earn a badge on course completion.

Steps:

Follow the steps to award badges at course completion.

  • From Default Points > Learndash > Badges Options check this option Allow students to earn badges when a course is completed
  • Go to Add / Edit Course page and select badge from the right sidebar
  • The selected badge will be awarded to the user when that course is completed.

Allow students to earn badges at lesson completion:

This option allows the user to earn a badge on lesson completion.

Steps:

Follow the steps to award badges at lesson completion.

  • From Default Points > Learndash > Badges Options check this option Allow student to earn badges when lesson is completed
  • Go to Add / Edit Lesson page and select badge from the right sidebar
  • The selected badge will be awarded to the user when that lesson is completed.

Allow student to earn badges at quiz completion:

This option allows the user to earn a badge on quiz completion.

Steps:

Follow the steps to award badges at quiz completion.

  • From Default Points > Learndash > Badges Options check this option Allow student to earn badges when quiz is completed
  • Go to Add / Edit Quiz page and select badge from the right sidebar
  • The selected badge will be awarded at quiz completion or failure.

Allow student to earn badges at topic completion:

This option allows the user to earn a badge on topic completion.

Steps:

Follow the steps to award badges at topic completion.

  • From Default Points > Learndash > Badges Options check this option Allow student to earn badges when topic is completed
  • Go to Add / Edit Topic Page and select badge from the right sidebar
  • The selected badge will be awarded to the user when that topic is completed

Redeeming Options:

Allow unlocking courses using myCred points:

This option allows the user to make the course accessible, by using the myCred points.

Steps:

Follow the steps to enable course unlocking using myCred points.

  • From Default Points > Learndash > Redeeming Options check to Allow unlocking courses using myCred points
  • On Specific Course Add/Edit page check option Enable Course points
  • Insert points that will apply to open path in the option Course Points Access

Note: Course can be of any type i.e. open, free, closed, etc.

Allow users to redeem only remaining points:

If this option is enabled, Learndash points will be used for redeeming any remaining points from myCred points. Otherwise, all required points will be used from myCred points.

Steps:

Following are the steps to allow students/users to redeem all the remaining points.

  • From Default Points > Learndash > Redeeming options check option Allow students/users to redeem only remaining points
  • It will consider your Learndash points first and then add the remaining points from myCred points to fulfil the required amount of points to unlock courses.

Note: This option is only used with unlocking courses.

Allow students to buy courses using myCred points:

This option allows the user to buy courses by using only myCred points.

Steps:

Following are the steps to enabling the feature to buy courses using myCred points.

  • From Default Points > Learndash > Redeeming options check option Allow students to buy courses using myCred points
  • Make sure to Insert PayPal email in Learndash > PayPal settings.
  • On Edit Course page select Course type Buy Now
  • Insert points required to purchase this course on the right sidebar
  • Go to the course on frontend it will show Use myCred Points option on Take this course button

How to buy a course using myCred points:

Allow students to unlock drip lessons using myCred points:

This option helps the user to unlock the drip lesson feature with the help of myCred points.

Steps:

Following are the steps to enable drip lessons feature using myCred points.

  • From Default Points > Learndash > Redeeming Options check option Allow students to unlock drip lessons using myCred points
  • On Edit Lesson page Insert required points to the un-drip lesson on the right sidebar
  • Make sure it is a drip feed lesson with these options Make Lesson visible X Days After Sign-up or Make Lesson Visible on Specific Date

How to unlock drip lesson:

Exclude Point Type from Redeeming:

Excluded point types will not show in the points type drop down when unlocking or buying a course or unlocking drip lessons.

Steps:

Following are the steps to exclude point type from redeeming.

  • From Default Points > Learndash > Redeeming options > Exclude Point Type from Redeeming Type or Select the Point Types to be excluded from redeeming.

Note: Exclude point type option on specific course/lesson pages will override the global settings from Learndash myCred Settings.

Enabled Option to buy myCred point:

If this option is enabled, and the user has fewer points for unlocking/buying course than the required points, then Purchase now button will show in the pop-up, that will take the user to the purchase points page.

Steps:

Following are the steps to enabled option to buy myCred point.

  • From Default Points > Learndash > Redeeming Options check this option Enabled Option to buy myCred point

Note: To buy myCred points buyCRED add-on should be installed and activated.

Page for buying myCred points:

The user can buy myCred points on this page.

Steps:

Following are the steps for buying myCred points.

  • Create a page for buying myCred points
  • Insert this shortcode into the page [mycred_buy_form]
  • From Default Points > Learndash > Redeeming Options > Page for buying myCred points select your page

Note: To buy myCred points buyCRED Addon should be installed and activated.


License Options:

You can configure a license key from here. License keys can be found at your email address when you purchase the addon.

Place your license key in the field and click on Activate.

Course Page Settings:

To set the course points on completion, exclude point types and insert points to buy this course. Go to the single course and configure the settings in the meta box.

These settings will override the settings on hooks for the specified point type.

Lesson Page Settings:

To set the lesson points on completion, exclude point types and unlock lessons. Go to the single lesson and configure the settings in the meta box.

These settings will override the settings on hooks for the specified point type.

Topic Page Settings:

To set the topic points on completion, go to the single topic and configure the settings in the meta box.

These settings will override the settings on hooks for the specified point type.

Quiz Page Settings:

To set quiz points on quiz completion, awarding/deducting, failed quiz and Min % grade for Points go to the edit quiz and configure the following settings in the meta box.

These settings will override the settings on hooks for the specified point type.

Shortcodes:

  • [mycred_my_badges]- This shortcode displays the logged in user earned badges.
  • [mycred_badges]- This shortcode allows you to display all published badges. Note that this shortcode will show all badges and not just the badges a user has earned.