Installation
The loader jar and the licence, dependencies, the files the plugin writes, the preset rewards and updating.
Getting the plugin
ExyliaRewards is a premium plugin, bought on BuiltByBit. It ships through the Lukittu loader, so the file you install is the
loader jar, Exylia-Rewards-Loader.jar. Bought on BuiltByBit, the licence is embedded in that jar: there is no key to enter. The loader checks the licence on every start and then
hands over to the plugin.
Before you start
| Plugin | What for |
|---|---|
ExyliaLib | Required, version 1.344.0 or newer. Configuration, menus and prompts, reward lists, the economy, boosters, the database, playtime, regions and webhooks. |
The loader's plugin.yml names ExyliaLib under softdepend on purpose: the loader is what installs it, so
the loader has to be allowed to start without it. On a server without ExyliaLib it downloads the newest
release into plugins/ and asks for a restart. On a server running an older release it stages the newest
one and says so in the console; restart once more to apply it.
Optional plugins
| Plugin | What it adds |
|---|---|
PlaceholderAPI | The plugin's placeholders in other plugins: scoreboards, tab, holograms. See Placeholders. |
NuVotifier (or Votifier) | Votes from vote sites. Without it the votes module still runs, but votes only arrive through /voteadmin fake, and the console says so. |
ExyliaMobs | The mobs a vote party sends as piñatas. Without it a party set to send one pays instead. |
| An economy | Money rewards, streak freezes for sale and paid calendar catch-up go through ExyliaLib's economy: ExyliaEconomy, or Vault with an economy plugin, or PlayerPoints. |
Installing
Drop in the jar
Exylia-Rewards-Loader.jar into plugins/, with NuVotifier, ExyliaMobs or PlaceholderAPI if you want
what they add.
Start the server
The loader checks the licence embedded in the jar and hands over to the plugin. The loader installs ExyliaLib if it is missing; if it had to, restart once more.
Let it generate
The plugin writes config.yml, votes.yml, referrals.yml, discord.yml, its messages and menus,
and creates its tables. On a fresh install it also writes seven preset rewards. The console ends with
ExyliaRewards enabled.
Make it yours
Open /rewardsadmin to edit the presets or build your own, replace the vote site URLs in votes.yml,
and create AFK zones with /afkzonesadmin. Players can already open /rewards.
The preset rewards
A fresh install starts with rewards so /rewards works out of the box:
| ID | Trigger | Pays |
|---|---|---|
daily | Daily | 100 money; a 7-day streak cycle whose day 7 adds 500 money and 2 diamonds. Ready notice on. |
weekly | Weekly | 750 money and 2 golden apples. |
monthly | Monthly | 2500 money and 4 diamonds. |
playtime_1h | Playtime, 1 hour | 150 money. |
playtime_5h | Playtime, 5 hours | 500 money. |
playtime_24h | Playtime, 24 hours | 2000 money. |
playtime_100h | Playtime, 100 hours | 7500 money. |
They are written once. A file in the data folder, .presets-seeded, records that they were offered, so a
server that deletes every reward does not get them back on the next start; a server that already has
rewards or claims stored is not given them either. /rewardsadmin presets adds the ones whose IDs are free,
whenever you want them back.
Generated files
All of them live in plugins/ExyliaRewards/.
| File | Contents |
|---|---|
loader.yml | Written by the loader: license_key, and version (auto keeps the plugin on the newest release). |
config.yml | The language, the module switches, the reset clock, notices, streak freezes, AFK zone sounds, votes and the vote party, referral rules, the /redeem lockout and the price currency. See Configuration. |
votes.yml | The vote sites and what a vote, a vote streak and the vote party pay. See Votes. |
referrals.yml | What the new player, the referrer and referral milestones pay. See Referrals. |
discord.yml | Optional Discord announcements. Off until switched on. See Configuration. |
database.yml | Where rows are stored. Written by ExyliaLib. |
lang/<language>/messages.yml | Every chat line, label, prompt, title and boss bar. |
lang/<language>/menus/user/ | The player screens: rewards, reward_list, reward_preview, reward_calendar, afk_zones, afkzone_preview and vote. They are yours: an update only adds what is missing. |
lang/<language>/menus/admin/ | The editors. They are regenerated from the jar on every start; do not edit them. |
.presets-seeded | The marker that the preset rewards were offered. |
votes.yml and referrals.yml are yours too: what you change is never overwritten, keys a later version
adds appear on their own, and a changed default waits in /exylialib updates.
Updating
Replace the loader jar and restart, or leave version: auto in loader.yml. Your files are kept; new keys
are added with their defaults.
Something missing on this page? Tell us on Discord