NodeBB Awards

System for rewarding forum users. It allows admin to define set of awards that could be granted to users for special accomplishments.

• How does it work?
• ACP Look
• Themes
  • Profile template
  • Topic template
• TODO

How does it work?

Plugin introduces new entity for your board: Award. It could be anything: ribbon, medal, special rank, etc.

1. Visit Awards control panel in ACP
2. Create several awards, don't forget images.
3. Give awards to the users.
4. If you want to list users' awards, you can augment Profile page template - profile.tpl

ACP Look

Themes

Profile template

Use flex template - awards_profile_flex.tpl for Persona v4. Place it wherever you like.

<!-- IMPORT partials/awards_profile_flex.tpl -->

Use profile partial, it will add small panel with awards as list. Every award item will include: picture, name, reason and date.

Example Vanilla Theme, edit node_modules/nodebb-theme-vanilla/templates/account/profile.tpl:

<!-- IMPORT partials/awards_profile.tpl -->

Topic template

Use topic partial to show awards for every post. Award's metadata is the same as for Profile template.

Example Persona Theme, edit node_modules/nodebb-theme-persona/templates/partials/topic/post.tpl:

<!-- IMPORT partials/awards_topic.tpl -->

TODO

• Add Sections to categorise awards, like: Forum, One time event, etc.
• Add User Manager: manager user's award - order, overview
• Add Notifications
• Use NodeBB's alerts (app.alert)
• Add HTML to notifications, bold text, etc.
• ACP: Add Awarded Users statistics
• ACP: Add small avatar preview to dropdown when you are looking for users
• Create Profile template with popovers (currently It is a list)
• Add Achievements section, where rules can be specified, and same Awards could be granted automatically (auto-awards with progress, Ex: First 1000 posts -> Core Heart, Every 20 likes -> Lover, etc)
• Add Tests (Mocha/Tape)
• Beautify Create Award panel
• Handle multiple awards of the same type (Exapmle: medal x 8)
• Move Less styles under awards namespace
• Topic View: use Bootstrap tooltips
• Settings for CSS classes in topic view
• Grant Award View: indicate that zero users are selected
• Integration: add plugin hooks, so another plugins will be able to handle changes
• ACP: Change list style for award item from bootstrap grid to flex