Discourse Gamification

[Discourse]

	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)

• Add chat-events scoring (requires Discourse Chat)

• 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 available on our Business and Enterprise plans Gamification | Discourse - Civilized Discussion

Last edited by @JammyDodger 2024-07-04T11:44:13Z

Check document

Perform check on document:

[JammyDodger]

Just a note to say the gamification scoring for posts_created has been adjusted to account for a few extra things:

FIX: Update post_created scoring

[geoffau (Geoff)]

This is great. A feature suggestion is to allow different scorable settings for each board so every board could be used for a separate community-driven competition.

For example, a board for most posts this month would have the post created score value set to 1 while all others are 0. Where a best like of the month board would have like given score value set to 1 and all others set to 0.

[Moin]

@geoffau

Where a best like of the month board would have like given score value set to 1 and all others set to 0

Like this /u?order=likes_given&period=monthly?

[geoffau (Geoff)]

Yes, that is a similar idea but as part of the Gamification board, not the default user listing layout.

The discourse user list (/u) can be displayed in different ways, such as the user card directory theme component which is good for the global site user list but does not look as good for a user ranking page. So the suggestion to have each gamification board use a separate setting is valid and makes more sense than using the discourse user list in this situation.

[JonahAragon1 (Jonah Aragon)]

How do I remove this leaderboard link from my sidebar? It seems to be automatically added, since it isn’t in the custom section links settings where I’d like it to be in order to move it to the More menu.

I see Meta has figured this out, but I don’t see a configurable setting anywhere on my end.

[ondrej]

As an admin on a site, you should be able to customise this section.

[JonahAragon1 (Jonah Aragon)]

Exactly, I would think it should be listed there.

[ondrej]

You should be able to use the = to drag it into the ‘More’ section.

Sorry I misread your post

[Kartoon]

@Discourse

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

I just noticed this has apparently been added at some point…how does one do this?

[NateDhaliwal]

@Kartoon I think this is what you are looking for:

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

Since we launched Discourse Gamification a year ago, one of the most requested features from our roadmap has been the ability to make it possible to integrate Discourse Gamification with external gamification system . Examples are plenty: Integrate with existing gamification programs in companies ability to award points for events that happen outside of Discourse, like IRL events, or elsewhere online, like being a customer in a community, or buying a product. the ability to allow users …

[albert_vu (Albert Vũ)]

Hi @Discourse,

I’m just wondering if the events that award cheers can be “undone”. For example, when I mark a reply of one of my forum members as a solution, they’d receive 5 cheers. However, later I decide that said reply wasn’t a solution and unmark it, then would they lose the 5 cheers that were awarded to them?