Discourse Gamification

[Falco]

	Summary	Discourse Gamification adds customizable scoring (karma, kudos, points) and leaderboards to your instance.
	Repository Link	https://github.com/discourse/discourse-gamification
	Install Guide	How to install plugins in Discourse
	Demo	Leaderboard

As this is an official plugin maintained by the Discourse team, support, bug, ux, and feature requests can be made in the respective categories here on Meta, and tagged with the appropriate plugin tag. Click on a link below to get one started.

 Support  Bug  UX  Feature

Features

While Discourse ships, out of the box, with gamification features (badges, trust levels) some communities want to take it to another level. That’s where GitHub - discourse/discourse-gamification comes in.

This plugin allows admins to easily create and tweak community scoring contests, where points are awarded by participating in the community.

Points are automatically updated every 5 minutes for events of the day, and we re-calculate scores from the last 10 days once a day.

Cheers

Users are awarded “cheers” by performing certain actions on the community. Each user cheer score appear on their user card, user profile and can be enabled on the user directory.

Like the plugin but the name cheers isn’t the best for your community? You can rename it to anything using Customize all text in Discourse.

Leaderboards

Admins can create multiple leaderboards, and each one can have a custom:

• start date
• end date
• Competing users
• Leaderboard privacy

By default, we ship with a default leaderboard at /leaderboard that will list all users from the first day where scores started to be awarded.

You can see a demo of it at Discourse Meta

Scorables

Currently, the following events award cheers:

• Daily visits
• Flags accepted
• Likes given
• Likes received
• Posts created
• Posts read
• Solutions accepted (requires Discourse Solved (Accepted answer plugin))
• Time read
• Topics created
• User invites accepted

See roadmap for upcoming scorables.

Score backfill

You can run a backfill to calculate the historical scores through the UI using the ‘Recalculate Scores’ button on your /admin/plugins/gamification page:

This can also be used to recalculate the leaderboard if you make any changes to your scorables or eligible scoring categories. You can generate a rescore up to 5 times a day, and can select a range of time frames (or set a custom one):

Configuration

Global customizations are:

• each action score multiplier
• Restrict categories where points can be earned
• enable and disable the plugin

Those plugin-level settings live at /admin/site_settings/category/plugins?filter=plugin%3Adiscourse-gamification.

To create, delete and update leaderboards, admins can visit /admin/plugins/gamification.

Use as widget

This can also be displayed as a widget in a smaller format, inside the Right Sidebar Blocks theme component. More info to be found there.

Badges based on score

You can have automatic badges based on the gamification score using Enable Badge SQL

Here is an example badge when a user has over 9000 cheers:

SELECT user_id, current_timestamp AS granted_at 
FROM gamification_scores
WHERE (:backfill OR user_id IN (:user_ids))
GROUP BY 1
HAVING SUM(score) > 9000

Changelog

• 2022-05-02T03:00:00Z - Public Release
• 2022-05-10T05:00:00Z - Update roadmap with recent changes

Roadmap

(roughly ordered)

• Make leaderboard respect prioritize usernames in ux being disabled

• Use higher resolutions avatars in leaderboard podium

• Add custom per-badge scoring

• Add per-reaction score awarding (requires Discourse Reactions - Beyond Likes)

• Add chat-events scoring (requires Introducing Discourse Chat (BETA))

• Add poll events scoring (created poll, voted in poll)

• Add media events scoring (posted image, posted video, posted onebox)

Implemented:

• Fix i18n table title in custom score column on user directory
• Ignore staged users
• Ignore anonymized users (email match @anonymized.invalid)
• Style leaderboard edit form
• Leaderboard “you” link needs a larger offset to accommodate floating header…
• Fix highlight of own user on the leaderboard not working if own user position is > 100
• Add i18n thousands separator to user card / profile cheer score
• Add time period filters to leaderboards
• Add default time period filter to leaderboard settings
• Add excluded_groups_ids to leaderboard settings
• Allow admins to award/remove arbitrary points to users to allow integration with out-of-Discourse scorable events
• Make scores click link to leaderboard (both in user profile and user card)

Hosted by us? This plugin is avaliable on our Business and Enterprise plans Gamification | Discourse - Civilized Discussion

[fbpbdmin (bcqa)]

@Falco

Allow admins to award/remove arbitrary points to users to allow integration with out-of-Discourse scorable events

is this dropped or implemented ?
could not find settings or functions related to this ?
thanks.

[Falco]

See How to integrate Discourse Gamification with an external system (redeem and award points)

[danielabc (Daniela)]

Could Discourse Gamification have more options like the links below in the future? Showing the number of quotes the member received, how many people he quoted, the number of comments etc… And have tabs, showing other categories, such as a top of tags (Of the most commented) a top of comments and topic partitions, a top of most commented topics, a top of most influential members, all showing the options and also with a filter showing week, day and month, see some examples below

Pandlr Charts (pandlr-charts.pages.dev)

Pandlr Charts (pandlr-charts.pages.dev)

[Falco]

It could but most of that is very out of the plugin scope.

• Top topics is already baked in core, it’s the /top route

• Top tags and categories it’s a cool concept, but something that either core or a dedicated plugin should handle

• Top users of a week is already covered in the plugin today

• Top gifs is something that core could do

[albert_vu (Albert Vũ)]

Hi @Falco,

One of our forum members (Monty-Bagati) noticed a mismatch between their current ranking in the Month view, specifically the “You” part right beneath the top three with the Kudos amount of 123 compared to 132 further down the leaderboard.

Strangely, this does not happen in the other views (Day, Week, Quarter, etc.)

Any idea what may be the cause of this? Thanks!

[mateahk (Mateah)]

Can you clarify if points can be customized for each action? We can decide how many points are awarded for each event?

[Moin]

Yes

@Falco

Configuration

Global customizations are:

• each action score multiplier

For example the scoring here was changed recently Experimenting with some new scoring defaults on Meta

[Gavin_Hudson]

• Add excluded_groups_ids to leaderboard settings

It looks like this feature didn’t make it to development in 2022. At least, I don’t see it in the gamification plugin settings. Is there any way for people to individually be able to turn off participation in gamification? Alternately, is there a different way to exclude some users from gamification?

[ThunderThighs (Delanie Alcorn)]

Hi there. I believe you’d need to put them in a group. You can then exclude a group in the leaderboard settngs when you create a new leaderboard:

[haydenjames]

Is there any way to rename the leaderboard but make it link to the defaul “Global Leaderboard”?

What I’m trying to accomplish is:

• Show “Weekly leaderboard” in the sidebar,
• but when clicking the link, it takes users to another Leaderboard ID
  (ex. the default “Global Leaderboard” ID 1)

Or alternatively, where can I edit word “Rank” here:

Thanks!