Build ranks, farming milestones and reclaims
Write the rank ladder with requirements and prestige, pay players for farming and mob kills, and set up /reclaim sections per rank. Playtime rewards live in ExyliaRewards.
Three modules give players something to climb: a rank ladder with prestige (rankup), rewards for farming
(farming) and a /reclaim command for perks bought outside the game (reclaim). Each is switched on in
config.yml (Switch modules on and off).
Rankup#
Add a rank#
Open the ladder file
Edit modules/rankup/ranks.yml. Each block under ranks: is one rank, and its key is the id used by
/rankup and the placeholders.
Order it and set requirements
Give it an order (the position on the ladder) and a list of requirements.
Say what it gives
Put console commands under reward.commands (%player% is the player), plus an optional
broadcast and sound.
Reload
Run /survivalcoreadmin reload.
ranks:
member:
display-name: "&7Member"
icon: IRON_INGOT
order: 1
description: []
requirements:
- type: money
amount: 250
- type: playtime
time: 2h
reward:
commands:
- lp user %player% parent set member
broadcast: ""
sound: ENTITY_PLAYER_LEVELUP|1.0|1.0
auto-rankup: false/rankup opens the ladder, showing what is met and what is not; /rankup claim takes the next rank when
everything is satisfied. settings.auto-rankup in modules/rankup/config.yml promotes without asking, and
a per-rank auto-rankup does the same for one rung. settings.notify-on-login tells a player on join when
they can rank up.
Choose the requirements#
A requirement is a type and one field. Any entry may also carry display, the line shown in the menu
instead of a generated one.
type | Field | Meaning |
|---|---|---|
money | amount (and an optional currency) | A balance, through the economy. currency is an id from ExyliaLib's economy.yml; left out, the default currency |
playtime | time | Time played: 30m, 1h, 5h |
placeholder | condition | A PlaceholderAPI comparison, for example %player_level% >= 30 |
permission | node | A permission node they must hold |
A requirement with any other type is reported in the console and ignored, so a rank whose only requirement
has an unknown type costs nothing. See Economy for currencies.
Every rank-up, by /rankup claim or automatic, takes the same path: RankUpEvent fires first (a cancelled
one costs nothing), then every money requirement is charged, one currency after another or none of them,
then the reward runs. If the promotion loses a race, the charge is refunded.
There is no playtime module or /playtime command here any more: playtime tiers are
ExyliaRewards. Time played is tracked by ExyliaLib's playtime service, which
the playtime rank requirement and the PLAYTIME stat read.
Let players prestige#
A player at the top of the ladder prestiges with /rankup prestige or the star in the corner of the
/rankup menu. It charges the prestige cost, takes their rank away, raises their prestige level by one and
runs the prestige rewards. They then climb the ladder again from the first rank.
Every money requirement is multiplied by prestige.cost-multiplier once per prestige level (default 1.5:
a $1,000 rank costs $1,500 on prestige 1 and $2,250 on prestige 2), and the menu shows the amount they
actually need. Set 1.0 to keep the ladder the same.
A prestige is refused when it is disabled, when the player is not on the last rank, when they are already
at max-level, and when they cannot pay, including when cost is above 0 and no economy is available.
Prestige settings (modules/rankup/config.yml)
| Setting | Default | What it does |
|---|---|---|
enabled | true | Whether anyone can prestige |
max-level | 0 | Highest prestige level. 0 means no limit |
cost | 25000 | Money charged to prestige. 0 is free |
cost-currency | empty | The currency cost is charged in: an id from ExyliaLib's economy.yml. Empty is the default currency |
cost-multiplier | 1.5 | See above |
reward-commands | lp user %player% parent set member | Console commands. %player% is the player, %level% the level just reached |
reward-sound | ENTITY_PLAYER_LEVELUP|0.6|1.0 | Played to the player. Empty for none |
The prestige announcement is the prestige-broadcast line of modules/rankup/messages.yml; it goes to
everyone with rank-up announcements on, and empty means none. %exyliasurvivalcore_rankup_can_prestige%
answers yes or no.
/rankupadmin (alias /rua, survivalcore.rankup.admin) has set <player> <rank> to move a player around
the ladder, prestige <player> <level> to set a prestige level directly, and info <player>; set and
prestige need survivalcore.rankup.admin.set. A rank id that is not in the file is refused. Wiping a
player's progress is /exylialib resetplayer.
Farming#
While ExyliaJobs is installed, this module stays off and Jobs pays for the same actions. It loads again if Jobs is removed.
The farming module counts blocks broken or mobs killed, and pays every N and at milestones.
Reward a farming category#
Edit the categories
Open modules/farming/categories.yml. Each block under categories: is one category, and its key is
the id used by /farming and the placeholders.
Say what counts
Set type (BLOCK for breaking, ENTITY for killing) and tracked (material or entity type
names).
Say what it pays
Set reward-every and a reward block, then add milestones for one-off rewards.
Reload
Run /survivalcoreadmin reload.
categories:
wheat_farming:
type: BLOCK
display-name: "&eWheat"
icon: WHEAT
tracked: [WHEAT]
require-max-growth: true
count-above: false
reward-every: 50
reward: { money: 2, message: "", actionbar: "", sound: "" }
milestones:
novice: { display-name: "Novice Farmer", required-count: 100, money: 10 }
infinite-milestone:
enabled: true
interval: 1000
money: 50Blocks a player placed never count, however long ago they were placed. /farming shows progress.
/farmingadmin (alias /fa) has set, reset and info, all behind survivalcore.farming.admin; the two
that write also need survivalcore.farming.admin.set. settings.notify-on-login in
modules/farming/config.yml sends a short summary on join.
Category keys
| Key | What it does |
|---|---|
type | BLOCK for breaking, ENTITY for killing |
tracked | The materials or entity types that count |
require-max-growth | Only fully grown crops count |
count-above | For stacking plants such as sugar cane and bamboo, count the blocks above too |
reward-every | Pay every N. 0 turns the per-N reward off |
milestones | One-off rewards at a required-count |
infinite-milestone | Keeps paying every interval after the named milestones run out |
ignored-spawn-reasons | For ENTITY, spawn reasons whose mobs do not count. Left out, SPAWNER is ignored; an empty list counts all |
Every reward block (reward, each milestone and infinite-milestone) takes money, commands, message,
actionbar and sound. Leave one out to skip it. money is paid in the default currency and multiplied by
money boosters for farming (see Economy). Another currency is written
money: {amount: 50, currency: gems}, an id from ExyliaLib's economy.yml. Placeholders: %player%,
%count%, and %money% (what was paid, after boosters).
Reclaim#
/reclaim hands a player a reward set tied to a permission, such as a donor kit or a monthly crate. It
needs exyliasurvivalcore.reclaim (granted to everyone), and each section also asks for its own node.
Add a reclaim section#
Open the sections
Edit modules/reclaim/config.yml. Each block under sections: is one section, named whatever you like.
Choose who and how often
Set permission, priority and each.
List what they get
Fill rewards and, for anything a reward cannot express, commands.
Reload and grant the node
Run /survivalcoreadmin reload, then grant the section's permission to the group that should have it.
sections:
vip:
permission: exyliasurvivalcore.reclaim.vip
priority: 1
each: "7d"
broadcast: true
rewards:
- type: ITEM
itemSnapshot: DIAMOND
itemAmount: 5
- type: ECONOMY
value: "50"
commands: []Sections are sorted by priority, highest first, and the first one whose permission the player holds is
the one that runs. A VIP gets the VIP section and nothing else, not both. A player holding no section node
is told there is nothing for them, so grant exyliasurvivalcore.reclaim.default only to the group that
should have the default section.
each is how often a section may be run: -1 means once ever, and anything else is a duration such as
7d, 12h, 30m or 45s. rewards is the standard Exylia reward list (see
Rewards); items that do not fit are kept for the player instead of dropped.
commands are console commands run as well, with %player% substituted. broadcast: true announces the
claim to players whose purchase announcements setting is on.
/reclaimadmin resetsection <player> <section> (exyliasurvivalcore.reclaim.admin) clears one section's
claim record.
Commands, permissions and placeholders#
These tables also list the missions, seasons, projects and reputation commands, which have their own pages.
| Command | What it does | Permission |
|---|---|---|
/rankup | Opens the rank ladder | exyliasurvivalcore.rankup |
/rankup claim | Claims a pending rank reward | exyliasurvivalcore.rankup |
/rankup prestige | Prestiges, when the ladder allows it | exyliasurvivalcore.rankup |
/rankupadmin | Prints the usage line | survivalcore.rankup.admin |
/rankupadmin set <player> <rank> | Puts a player on a rank | survivalcore.rankup.admin.set |
/rankupadmin prestige <player> <level> | Sets a player's prestige level | survivalcore.rankup.admin.set |
/rankupadmin info <player> | Shows a player's rank and prestige | survivalcore.rankup.admin |
/farming | Opens the farming progress menu | exyliasurvivalcore.farming |
/farmingadmin | Prints the usage line | survivalcore.farming.admin |
/farmingadmin set <player> <category> <count> | Sets a player's count in a category | survivalcore.farming.admin.set |
/farmingadmin reset <player> <category> | Resets one category for a player | survivalcore.farming.admin.set |
/farmingadmin info <player> | Shows a player's counts and levels | survivalcore.farming.admin |
/reclaim | Opens the reclaim menu | exyliasurvivalcore.reclaim |
/reclaimadmin | Prints the usage line | exyliasurvivalcore.reclaim.admin |
/reclaimadmin resetsection <player> <section> | Lets a player claim that section again | exyliasurvivalcore.reclaim.admin |
/missions | Opens your daily and weekly missions | exyliasurvivalcore.missions |
/seasons | Opens the seasons menu | exyliasurvivalcore.seasons |
/seasonsadmin close <season> | Closes a season | exyliasurvivalcore.seasons.admin |
/project | Opens the current community project | exyliasurvivalcore.projects |
/project give | Hands over everything the project still needs from your inventory | exyliasurvivalcore.projects |
/projectadmin reset <project> [confirm] | Resets a project's progress | exyliasurvivalcore.projects.admin |
/reputation [player] | Shows a reputation card | exyliasurvivalcore.reputation |
/reputation rate <deal> <up|down> | Rates a deal; the target of the buttons in a deal prompt | exyliasurvivalcore.reputation |
/reputation pending | Lists your deals waiting for a rating | exyliasurvivalcore.reputation |
| Permission | Who has it | What it allows |
|---|---|---|
exyliasurvivalcore.stats | Everyone | Your own statistics with `/stats` |
exyliasurvivalcore.stats.others | Everyone | Other players' statistics |
exyliasurvivalcore.rankup | Everyone | The rank menu, ranking up and prestige |
exyliasurvivalcore.farming | Everyone | `/farming` |
exyliasurvivalcore.missions | Everyone | `/missions` |
exyliasurvivalcore.boosters | Everyone | `/boosters` |
exyliasurvivalcore.reputation | Everyone | `/reputation` |
exyliasurvivalcore.projects | Everyone | `/project` |
exyliasurvivalcore.seasons | Everyone | `/seasons` |
exyliasurvivalcore.reclaim | Everyone | `/reclaim` |
| Placeholder | Shows | Example |
|---|---|---|
%exyliasurvivalcore_rankup_rank% | Current rank's display name, or a grey `None` | Miner |
%exyliasurvivalcore_rankup_rank_id% | Its id, or `none` | miner |
%exyliasurvivalcore_rankup_rank_order% | Its position on the ladder, `0` with no rank | — |
%exyliasurvivalcore_rankup_next_rank% | The next rank's display name, or a green `Max rank reached!` | Digger |
%exyliasurvivalcore_rankup_next_rank_id% | Its id, or `none` | — |
%exyliasurvivalcore_rankup_prestige% | Prestige level | 1 |
%exyliasurvivalcore_rankup_can_prestige% | `yes` when prestige is on, the player sits on the last rank and has not reached the prestige cap; `no` otherwise | — |
%exyliasurvivalcore_rankup_can_rankup% | `yes` / `no` | yes |
%exyliasurvivalcore_rankup_ranks_total% | Ranks configured | 12 |
%exyliasurvivalcore_rankup_requirements_total% | Requirements the next rank asks for | 3 |
%exyliasurvivalcore_rankup_requirements_met% | How many of those are already met | 2 |
%exyliasurvivalcore_rankup_progress_bar% | Those two drawn as a bar; full when there is no next rank | — |
Counters these modules feed
They count into the stats counters that leaderboards, missions and seasons read; see Statistics.
| Counter | What it counts |
|---|---|
rankup.ranks | Ranks taken, by hand or automatically |
rankup.prestiges | Prestiges taken |
farming.harvested | Every block or mob a farming category counted |
farming.<category>.harvested | The same, for one category |
reclaim.claimed | Reclaim sections run |
reclaim.<section>.claimed | The same, for one section |
Something missing on this page? Tell us on Discord