> For the complete documentation index, see [llms.txt](https://wiki.mercuryservice.fr/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://wiki.mercuryservice.fr/mercuryrewards/description.md).

# Description

MercuryRewards is a fully configurable daily reward plugin. It is one of the most complete and optimized rewards plugins on the market.

## Features

* JSON storage.
* Compatibility with PlaceholdersAPI.
* Fully configurable.
* Edit rewards directly in-game without reboot.

## Commands and Permissions

|                Command                |             Aliases             |                        Description                        |           Permission           |
| :-----------------------------------: | :-----------------------------: | :-------------------------------------------------------: | :----------------------------: |
|            /rewards toggle            |               none              |               Enable/Disable rewards module               |      mercuryrewards.toggle     |
| /rewards addcommand \<day> \<command> |               none              |      Add command to execute on a specific reward day.     |    mercuryrewards.addcommand   |
|            /weekly additem            |               none              |                Add Item to weekly rewards.                | mercuryrewards.weekly.additems |
|                /rewards               | reward, recompense, recompenses |                      Open rewards GUI                     |              none              |
|                /weekly                |   weeklyreward, weeklyrewards   |                   Get the weekly rewards                  |      mercuryrewards.weekly     |
|   /rewards create \<day> \<commands>  |               none              |      Create rewards for a specific day with command.      |      mercuryrewards.create     |
|         /rewards create \<day>        |               none              | Create rewards for a specific day with item in inventory. |      mercuryrewards.create     |
|             /rewards edit             |               none              |                   Open Edit rewards GUI                   |       mercuryrewards.edit      |
|     /rewards set \<player> \<day>     |               none              |           Set players to a specific rewards day           |       mercuryrewards.edit      |
|             /rewards help             |               none              |                   Get more informations                   |       mercuryrewards.help      |

## Placeholders

```
%mercuryrewards_next_reward% - Return the delay before next reward 
with format : XX:XX:XX.

%mercuryrewards_available_reward% - Return messages to check the availability 
of rewards.

%mercuryrewards_current_reward% - Return the current day of the reward.

%mercuryrewards_max_days% - Return the max amounts of rewards.
```