menus.yml
Every menu CoreJobs opens, laid out slot by slot.
Glass frame
Every menu can use the same three-part glass frame. border fills the outer ring, corners replaces its four corners, and interior fills unused inner slots. Real menu items always win when they share a frame slot. Set enabled: false or remove frame to keep a legacy menu using only filler.
frame:
enabled: true
hide-tooltip: true
border:
material: GRAY_STAINED_GLASS_PANE
name: " "
corners:
material: LIGHT_GRAY_STAINED_GLASS_PANE
name: " "
interior:
material: BLACK_STAINED_GLASS_PANE
name: " "
hide-tooltip removes the pane name and lore when a player hovers it. The bundled frame is neutral. A server setup can change the three pane materials without changing code.
Shared item fields
Every item in this file takes the same fields:
| Field | What it does |
|---|---|
material |
Minecraft material name, like DIAMOND or OAK_LOG |
amount |
Stack size, defaults to 1 |
name |
Display name, with colour codes |
lore |
List of lore lines |
custom-model-data |
Resource pack model id, 0 to ignore |
itemsadder |
Namespaced id like myitems:job_head, wins over material |
head-texture |
Base64 texture, only used when the material is PLAYER_HEAD |
Slots are 0-indexed. A six row menu has slots 0 to 53.
Any name, lore line, or title written as lang:some.route is looked up in the player’s language file. A lore line pointing at a list expands into all of that list’s lines. CoreJobs placeholders work inside the route itself, so lang:menu.hub-title-{job_id} works. PlaceholderAPI also expands every title, name, and lore line for the viewer before colours are applied.
The six blocks
| Block | Menu |
|---|---|
jobs-menu |
The /jobs grid |
job-hub-menu |
A single job’s hub |
job-tier-menu |
The tier and rewards page |
boosts-menu |
Active boosts |
shop-menu |
The farmpoints shop |
ranking-menu |
The monthly ranking |
jobs-menu
jobs-menu:
title: "lang:menu.jobs-title"
rows: 6
frame: ...
profile:
slot: 4
material: PLAYER_HEAD
use-player-head: true
claim-all:
slot: 45
material: CHEST
shop:
slot: 47
material: SUNFLOWER
boosts:
slot: 53
ranking:
slot: 51
material: PLAYER_HEAD
close:
slot: 49
material: BARRIER
material: EXPERIENCE_BOTTLE
job-prestige:
show: prestiged
lines:
- "lang:menu.job-prestige-lore"
Job icons themselves live in jobs.yml under each job’s icon and menu-slot.
Job icons and every item in the two per-job menus also take {job_id}, the job block key such as miner, alongside {job}.
job-prestige adds lines under a job icon carrying the prestige the viewer has in that job and what it is worth, so the grid shows it without opening the job. show takes prestiged (only a job this player has prestiged), always (every job with prestige turned on), or never. The lines take {prestige}, {maxprestige}, {prestige_pay}, {prestige_farmpoints}, {prestige_drops}, and {prestige_xp_cost} on top of the usual job placeholders.
job-tier-menu
job-tier-menu:
rows: 6
tier-slots: [10, 11, 12, 13, 14, 15, 16, 25, 24, 23, 22, 21, 20, 19]
achieved:
material: LIME_STAINED_GLASS_PANE
current:
material: YELLOW_STAINED_GLASS_PANE
locked:
material: RED_STAINED_GLASS_PANE
reward-claimable:
material: LIME_STAINED_GLASS_PANE
reward-claimed:
material: GRAY_STAINED_GLASS_PANE
reward-locked:
material: RED_STAINED_GLASS_PANE
claim-all:
slot: 51
material: CHEST
previous-page:
slot: 45
material: ARROW
next-page:
slot: 53
material: ARROW
back:
slot: 47
close:
slot: 49
material: BARRIER
material: BARRIER
tier-slots is the list of slots the level panes fill, in order. Shorten it for a tighter page or extend it to show more levels at once.
Reward states
A level that carries a reward in rewards.yml shows one of three states instead of the plain locked pane, picked by how far the viewer has gotten.
| Key | When it shows |
|---|---|
reward-locked |
The level is not reached yet |
reward-claimable |
Reached, reward not claimed. Clicking it claims |
reward-claimed |
The reward was claimed |
Each state is a normal item, and each takes an itemsadder id like any other item. The state item is what shows on the page: set a different ItemsAdder icon on each of the three to change the look per state, while the reward’s icon in rewards.yml keeps its name and description on top of it, with the state’s own lore under that.
Paging
One page holds as many levels as tier-slots has slots, so a job with more levels than that is paged. previous-page and next-page are the two buttons that move between pages, and each takes the same fields as any other item.
| Key | Default slot | When it shows |
|---|---|---|
previous-page |
45 | Anywhere but the first page |
next-page |
53 | While there are levels left to show |
A button is left off the page it has nothing to do on, so the first page has no previous arrow. Keep both slots out of tier-slots, or a level pane covers the arrow.
claim-all claims every reward earned in this job, back returns to the job hub, and close closes the menu.
job-hub-menu
| Button | Default slot | What it shows |
|---|---|---|
leaderboard |
10 | Top players in the job. entries sets how many, capped by leaderboards.size. top-player-head: true puts the #1 player’s skin on it when the material is PLAYER_HEAD |
how-to-earn |
12 | The block or mob list, generated from jobs.yml |
progress |
14 | The viewing player’s level, xp, and pay |
prestige |
16 | Requirement lines, ticked or crossed |
rewards |
31 | Opens the tier page |
back |
38 | Returns to the /jobs grid |
close |
40 | Closes the menu |
Generated lines sit between lore-header and lore-footer, so you control what wraps them.
Per-job looks
Each job can replace the hub or rewards title and any part of an item look without copying the whole menu. Empty titles keep the shared menus.yml title. An override field wins, while missing fields still come from the shared menu. This also works inside frame, so frame.border.material can differ by job.
menu-titles:
hub: "lang:menu.hub-title-{job_id}"
rewards: ""
menu-items:
hub:
filler:
material: AIR
back:
itemsadder: "mypack:miner_back"
rewards:
reward-locked:
itemsadder: "mypack:miner_lock"
frame:
enabled: false
AIR decorations make the slot look empty, but the menu listener still locks that slot. Clicks, shift-clicks, number keys, drags, and double-click collection cannot move items through it.
The how-to-earn list prints each block or mob with its real rate from jobs.yml, harvest blocks included, then one menu.earn-other line for whatever pays the base rate. Names come from the names section of the language file.
Leaderboard heads use the skin each player last joined with, stored when they join. A player who has not joined since 1.6.0 shows the server’s own lookup until they do.
Writing the how-to-earn lines yourself
how-to-earn.lines replaces the generated block and mob list with your own lines, for every job at once:
how-to-earn:
slot: 12
lore-header:
- "lang:menu.how-to-earn-header"
- ""
lines:
- "&7Break anything this job lists."
- "&7Pay: &a{money}&7 each"
lore-footer: []
Leave it empty for the generated list. {job}, {money} and {xp} work in a line, and so does a lang: route. A job can override this for itself with its own how-to-earn list in jobs.yml, which wins over both.
Written lines are static text. They do not recalculate per block the way the generated list does.
Prestige button states
| Key | When it shows |
|---|---|
lore-ready |
Every requirement met |
lore-locked |
Something still missing |
lore-maxed |
At the highest prestige |
lore-disabled |
The job has prestige off and show-when-disabled is true |
show-when-disabled: false hides the button entirely for a job with no prestige. disabled-material is the greyed-out material used when it is shown.
Placeholders in those lore lines: {prestige} {nextprestige} {maxprestige} {level} {maxlevel} {cost_money} {cost_xp_levels} {cost_farmpoints} {pay_bonus} {xp_cost_extra}.
ranking-menu
ranking-menu:
rows: 6
header:
...
entry-slots: [11, 12, 13, 14, 15]
entry:
...
last-entry-slots: [20, 21, 22, 23, 24]
last-entry:
...
claim:
slot: 51
material: CHEST
name: "lang:menu.ranking-claim-name"
lore-available:
- "lang:menu.ranking-claim-available"
lore-none:
- "lang:menu.ranking-claim-none"
entry-slots holds this month’s heads and entry is the template each one is built from. last-entry-slots and last-entry do the same for the previous month’s row. Trim either list to show fewer places, or empty last-entry-slots to show only the current month. Both templates take {rank}, {player} and {points}.
Claim button states
The claim button has one name and two sets of lore, picked per viewer.
| Key | When it shows |
|---|---|
lore-available |
The viewer has an unclaimed reward from last month. {rank} is the position they finished |
lore-none |
Nothing to claim |
Clicking only does something in the first state, so a player who finished outside the rewarded places sees the button but gets nothing from it.
shop-menu and boosts-menu
shop-menu carries the balance icon, frame, back button, and close button. Item slots come from shop.yml.
boosts-menu uses entry-slots for active boosts, an entry template, an entry-paused template for a boost waiting its turn, a none item for when nothing is running, and a back button. Both templates take {multiplier}, {type}, {job} and {remaining}, where {type} is the category. The entries redraw while the menu is open, so the time left ticks down on screen; the rate is feedback.boost-menu-refresh-ticks in config.yml.
Running boosts fill the slots first and waiting ones follow, so a player holding more boosts than there are entry-slots sees the running ones.
external is one item per category another plugin is boosting through the Developer API, filled into its own slots list in order, and only for a category reporting more than 1.0. Its lines take {type}, {multiplier} and {source}, where the source is the name that plugin gives itself. Nothing is drawn when no such plugin is registered, which is the normal case.
The line asks about all jobs, so a plugin boosting one job in particular reports its all figure here. The placeholders can still be asked per job.
Working on a layout
A slot of 50 in a three row menu is out of range. Rows times nine is the slot count, so three rows stop at slot 26.