Monthly Ranking

Every month the top farmpoint earners get posted to Discord, claim a reward in game, and the board starts over.

The cycle

  1. Players earn through the month
    Ranking points go up whenever farmpoints are earned. Spending does not lower them.

  2. The month rolls over
    Shortly after midnight on the first of the month, using the timezone from config.yml.

  3. The top list posts to Discord
    Through the webhook, if you set one up.

  4. Rewards are staged
    Each winner has their reward waiting, nothing is force-given.

  5. Ranking points reset to zero
    Balances are untouched.

  6. Winners claim
    /farmpoints ranking, then the claim button.

Balances survive the reset

Only ranking points go to zero. Players keep every farmpoint they have not spent.

Setting up the webhook

ranking:
  enabled: true
  top: 5
  auto-reset: true
  webhook:
    enabled: false
    url: ""
    username: "CoreJobs"
    avatar-url: ""

  1. Make a webhook in Discord
    Channel settings, Integrations, Webhooks, New Webhook, then copy the URL.

  2. Paste it into config.yml
    Set webhook.url and flip webhook.enabled to true.

  3. Set the name and avatar
    username and avatar-url are what the message shows as its author.

  4. Test it
    /corejobs resetranking confirm forces a reset and posts the current top list.

resetranking is not a dry run

It really resets. Ranking points go to zero and rewards are staged for whoever is on top right now. Test it before your first real month end, not during one.

Rewards per place

ranking:
  rewards:
    1:
      - "broadcast {player} finished #1 in the monthly farmpoints ranking!"
    2:
      - "say {player} finished #2"

Commands run from console when the player clicks claim. {player} is their name, {rank} is their position. top: 5 decides how many places get a reward and appear in the Discord post.

The ranking menu

Row What it shows
Header The current month and how the board works
This month Top heads with their points
Last month The previous month’s heads, for comparison
Claim Lights up when the viewing player has a reward waiting

display.hide-last-month-until-set: true in config.yml hides the last month line until a month has actually rolled over, so a fresh install does not show everyone a row of zeroes.

Time zone

timezone: system

system follows the server machine’s clock. Set a time zone id like Europe/Paris if your host runs on UTC but you think in local time, so the month change lines up with your calendar. A bad value warns in console and falls back to system.

Turning it off

Key Effect
ranking.enabled: false No ranking at all
ranking.auto-reset: false Board keeps running, resets only when you run the command
webhook.enabled: false Ranking runs, nothing posts to Discord

Placeholders

%corejobs_topmonthly_1_name%      this month's leader
%corejobs_topmonthly_1_points%
%corejobs_toplastmonth_1_name%    last month's leader
%corejobs_toplastmonth_1_points%

Both sets exist so a scoreboard can carry this month and last month side by side. See Placeholders.

Previous Shop Next Boosts