=== Gamilu Leaderboards ===
Contributors: okmultimedia
Tags: leaderboard, ranking, gamification, points, gamilu
Requires at least: 6.5
Tested up to: 7.1
Requires PHP: 7.4
Requires Plugins: gamilu
Stable tag: 0.1.1
License: GPLv2 or later
License URI: https://www.gnu.org/licenses/gpl-2.0.html

Rankings of your most active users for Gamilu Gamification: this week, this month or all time, with a podium for the top three.

== Description ==

**Who is earning the most points?** Gamilu Leaderboards turns the points of [Gamilu Gamification](https://wordpress.org/plugins/gamilu/) into a ranking your users will want to climb.

= What you get =

* **Three periods:** this week, this month or all time.
* **A podium** for the top three, in the Gamilu style.
* **"Your position"** for the logged-in user, even when they are not in the top list.
* **Avatars and levels** next to each name, if you want them.
* **Block, shortcode and widget:** place it on any page, in a sidebar or inside your page builder.
* **One-click page:** create a ready "Leaderboard" page from Gamilu > Leaderboards.
* **Privacy friendly:** only display names are shown, administrators can be left out, and any user can hide from the rankings in their profile. No tracking, no external calls.

This is an add-on: it needs the free Gamilu Gamification plugin.

= Shortcode =

`[gamilu_leaderboard]`

Options:

* `period` – `week`, `month` or `all` (default `week`)
* `number` – how many users, from 3 to 50 (default 10)
* `title` – your own title
* `podium`, `avatars`, `levels`, `you` – `yes` or `no`

Example: `[gamilu_leaderboard period="month" number="5" podium="no"]`

== Installation ==

1. Install and activate Gamilu Gamification.
2. Install and activate Gamilu Leaderboards.
3. Go to Gamilu > Leaderboards and click "Create leaderboard page", or add the "Gamilu: leaderboard" block to any page.

== Frequently Asked Questions ==

= When does the week start? =

On the day set in Settings > General > Week Starts On, using your site's time zone.

= Can a user stay out of the rankings? =

Yes. Each user can tick "Do not show me in the leaderboards" in their profile. They keep earning points and badges as usual.

= Are administrators shown? =

Not by default. You can change it in Gamilu > Leaderboards.

= What happens if I delete the add-on? =

Its settings are removed. Points, badges and the leaderboard page you created stay where they are.

== Screenshots ==

1. A leaderboard with the podium.
2. The block settings in the editor.
3. Gamilu > Leaderboards.

== Changelog ==

= 0.1.1 =
* Users blocked with Gamilu Fair Play no longer show in the rankings while the block lasts.

= 0.1.0 =
* First version.
