Introduction
What ExyliaRewards is, its four modules, what it needs to run and how this documentation is organised.
ExyliaRewards gives players reasons to come back. Daily, weekly and monthly rewards with streaks, timed and one-time gifts, playtime milestones, login calendars and redeem codes; zones that pay players for staying in them; votes with a network vote party and piñatas; and referrals that pay both players once the new one has settled in.
Everything players earn is built and edited in game. Rewards, AFK zones, codes and piñatas are not kept in files: they are rows in the database, edited from menus, so a change made on one server reaches every server that shares the database.
It is a premium plugin, installed through a licence loader. See Installation.
The modules
Each module is switched on or off in config.yml under modules. A change needs a restart.
| Module | What it does |
|---|---|
rewards | Claimable rewards: daily, weekly, monthly, on a cooldown, once, after an amount of playtime, when a placeholder check passes, or as a login calendar. Streaks with bonus days, streak freezes, pick-one and mystery contents, requirements, auto-claim and ready notices. It also runs /redeem codes. |
afk-zones | Areas that pay players for staying inside them, on a ladder of tiers that pays more the longer they stay, with a boss bar countdown and an AFK top. |
votes | Votes arriving through NuVotifier: what every vote pays, daily vote streaks, reminders, and a network vote party with a countdown, milestones and an optional ExyliaMobs piñata. |
referrals | New players name who invited them, and both are paid once the new player has played long enough, idle time not counted. Milestones for referrers. |
What is included
The eight triggers, requirements, contents, streaks and freezes, notices and the reward editor.
Login calendarsA grid of days claimed one per day, with a completion bonus and paid catch-up of missed days.
Redeem codes/redeem codes with network and per-player caps, an expiry, a permission and a lockout.
Regions that pay on a timer, tiers that pay more the longer a player stays, and the AFK top.
Votesvotes.yml, vote streaks, reminders, the vote party and its piñatas.
/referral, the join window, settling in and referrals.yml.
One database for every server, Redis, boosters, rewards kept for later and the tables.
Requirements
| Requirement | Detail |
|---|---|
| Server | Paper 1.21.4 or newer, or a fork of it. Folia supported. |
| Java | 21 |
| Required dependency | ExyliaLib 1.344.0 or newer — installed for you if it is missing |
| Optional dependencies | PlaceholderAPI (placeholders in other plugins), NuVotifier (votes), ExyliaMobs (vote party piñatas) |
Configuration, menus and prompts, the reward lists and their editor, the economy, boosters, the database, the playtime tracker, regions and the Discord webhooks all come from ExyliaLib. ExyliaRewards is written on top of it and does not run without it, which is why the loader installs it on a server that lacks it.
Works with
| Plugin | What happens |
|---|---|
| Booster plugins | Money, items and experience paid by every module go through ExyliaLib's modifiers, so boosters multiply them. See Network and data. |
| ExyliaMobs | A vote party can send one of its mobs as a piñata. See ExyliaMobs. |
| ExyliaSurvivalCore | When installed, its missions and seasons can count what players do here: rewards claimed, playtime rewards, codes, AFK payouts, votes, piñata hits and referrals. Its old AFK zones, votes and referrals tables are read as they are. |
Languages
The plugin ships English, Spanish, French, Portuguese, Russian and Turkish (en, es, fr, pt, ru,
tr): every message and every menu. See Configuration.
Something missing on this page? Tell us on Discord