menus.yml

Every menu CoreJobs opens, laid out slot by slot.

Shared item fields

Every item in this file takes the same fields:

Slots are 0-indexed. A six row menu has slots 0 to 53.

The six blocks

jobs-menu

jobs-menu:
  title: "lang:menu.jobs-title"
  rows: 6
  filler:
    material: GRAY_STAINED_GLASS_PANE
    name: " "
  profile:
    slot: 4
    material: PLAYER_HEAD
    use-player-head: true
  claim-all:
    slot: 48
    material: CHEST
  shop:
    slot: 49
    material: SUNFLOWER
  boosts:
    slot: 50
    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-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, 19, 20, 21, 22, 23, 24, 25]
  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: 48
    material: CHEST
  previous-page:
    slot: 45
    material: ARROW
  next-page:
    slot: 53
    material: ARROW
  back:
    slot: 49
    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.

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.

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, and back returns to the /jobs grid.

job-hub-menu

Generated lines sit between lore-header and lore-footer, so you control what wraps them.

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

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: [10, 11, 12, 13, 14, 15, 16]
  entry:
    ...
  last-entry-slots: [19, 20, 21, 22, 23, 24, 25]
  last-entry:
    ...
  claim:
    slot: 49
    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.

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, the filler, and the 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