Package Exports

nodebb-plugin-magination-points

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (nodebb-plugin-magination-points) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

NodeBB: Points

Additional metrics for User Profiles. It's like experience in video games. Plugin is good for gamification of your board.

Version Dependencies bitHound Score Code Climate

Ranking Calculation
Themes
- Profile View
- Topic View
TODO
Changelog

Ranking Calculation

Ranking calculator is a function, that should accept 2 parameters - settings and raw points. Settings could vary from one calculator to another. Calculator must return object with properties listed below:

rank [Number] - user's rank, level
rankProgress [Number] - amount of points on current level
rankTotal [Number] - amount of points needed to level-up
total [Number] - raw amount of points

Example: Default Function

Themes

Plugin populates both: Profile and Topic views. Search for points property in corresponding entities.

Profile View

If you want points in Profile, do very basic changes to your theme:

Example: Vanilla Theme, /account/profile.tpl, edit template in package directory - node_modules

<div class="text-center account-stats">

    <div class="inline-block text-center">
        <span class="human-readable-number" title="{reputation}">{reputation}</span>
        <span class="account-bio-label">[[global:reputation]]</span>
    </div>

    <div class="inline-block text-center">
        <span class="human-readable-number" title="{postcount}">{postcount}</span>
        <span class="account-bio-label">[[global:posts]]</span>
    </div>

    <div class="inline-block text-center">
        <span class="human-readable-number" title="{profileviews}">{profileviews}</span>
        <span class="account-bio-label">[[user:profile_views]]</span>
    </div>

    <!-- IF points -->
    <div class="inline-block text-center">
        <span class="human-readable-number" title="{points}">{points}</span>
        <span class="account-bio-label">Points</span>
    </div>
    <!-- ENDIF points -->
    
</div>

Topic View

Every post will have additional field: points. If you want utilize points calculation feature in topic view, you should use theme that supports such type of integration.

TODO

Add Gifts: ability to add points through ACP with a notification
Add Transfers: user can transfer some of his points as a reward for some bounty or help or user generated competition
Add Points Grid: multipliers or raw values for different categories
Add Fresh Points: provide information for points that are earned today
Add Complexity to Point calculation: encourage tags in topic creation
Add Custom ranking calculators
Add ACP Panel for raw point rewards
Add API for raw point rewards
Add Custom Notifications for levels
Add Presets for ranking calculation
Add Sections to Overview page: all time, today, personal.
Add Utility for initial point calculation
Add Tests (Mocha/Tape)

Changelog

v2.1.0 - 10/8/2015

New posts now will be populated with points
Updated all package dependencies
Points section will show exactly 20 top users

v2.0.0 - 10/2/2015

Compatibility with v0.8.x forum
Improved support for themes, you don't need inject templates anymore
Improved Overview page

v1.2.0 - 5/10/2015

Use Posts filter
Added Settings to Topic View

v1.1.0 - 5/10/2015

Rank calculation moved to client-side

v1.0.0 - 4/26/2015

Very first release