Your first reward
Create a daily reward from the admin screen, then claim it as a player. About five minutes, no files to edit.
You will create a daily reward called welcome-gift, open /rewards as a player and claim it. Everything happens in game, in menus.
Before you start#
- ExyliaRewards is installed and the console ended with
ExyliaRewards enabled. See Installation. - You are an operator, or you hold
exyliarewards.admin. See Permissions. - A fresh install already writes seven preset rewards, so
/rewardsis not empty. You will add one of your own next to them.
Steps#
Open the reward editor
Run /rewardsadmin. It lists every reward on the server. Click Rewards ▸ Create reward.
Choose when it can be claimed
The first question is "When can it be claimed?". Pick Daily: once a day, from the reset hour. The other choices are Weekly, Monthly, Cooldown, Once, Playtime, Condition and Calendar. See Rewards.
Name it
Type the ID welcome-gift: lowercase, no spaces. Players never see it. Then type the display name, for example Welcome gift, and confirm the summary.
Pick an icon
Choose the item that represents the reward in menus, for example a chest.
Add what it gives
The contents editor opens. Click add and choose What does it give?: an item, money, commands, experience or a potion. For a first test, add a diamond or two. Money needs an economy plugin; see Installation. Save when you are done.
Check the overview
The reward screen shows a card for each part: Status, General, When, Requirements, Rewards, Options, Stats and Player view. A new reward starts enabled, with unlimited claims. Nothing else is required.
Check that it works#
Open the hub as a player
Run /rewards. Click Rewards ▸ Periodic rewards. Your Welcome gift is drawn as ready.
Claim it
Left-click it. What you added lands in your inventory and the reward turns to used, with a countdown to the next reset. Right-click shows what it gives without claiming.
Test again
As an admin, run /rewardsadmin reset <your name> welcome-gift to forget your claim and claim again. Or run /rewardsadmin give <your name> welcome-gift to be paid at once.
If a player sees nothing, the reward may be disabled, locked behind a permission, or still loading. See Common problems.
Going further#
- Make it a streak. Open the reward, then Options, and set a streak cycle: a bonus on day 7, for example. See Rewards.
- Make it a rank perk. In Requirements set a permission and give it only to VIP with your permissions plugin.
- Show it on a scoreboard.
%exyliarewards_welcome-gift_cooldown%shows the time left. See Placeholders.
Something missing on this page? Tell us on Discord