Missions and seasons

Missions and seasons count nothing themselves. Every module already adds to a stat counter when a player does something — a block broken in a mine, a crate opened, a vote paid — and a mission or a season is a target or a ranking over one of those counters. Both need the stats module; with it off every counter reads zero, and each module says so once in the log.

Which counters can be named

A mission's stat and a season's counter are counter keys, such as mines.blocks, farming.harvested, kills.players, kills.mobs, crates.opened, market.sold, votes.total or missions.completed. The full list, with what each one counts, is in Statistics.

• Keys are lower-cased, so Mines.Blocks is mines.blocks.
• Nothing checks that a key exists. A key nothing counts reads 0 forever: its mission never finishes and its season never ranks anyone. No warning is logged.
• The ids in modules/stats/stats.yml that are not counters — kills, deaths, kdr, playtime and the other INTERNAL, COMPUTED, PAPI and VAULT stats — are not counter keys and read 0 here. Use kills.players, not kills.

Missions

A player holds a set of daily missions and a set of weekly ones. /missions shows them; a finished one is collected from there.

How a set is chosen

• Which missions a rotation asks for, and the target of a mission with a range, are drawn from a generator seeded on the rotation itself. Everyone on the server gets the same missions with the same numbers, and they survive a restart.
• daily-count and weekly-count missions are drawn from the pool of that rotation. A pool with fewer missions than that hands out all of them.
• Progress is the counter now minus what it read when the mission was handed out. What a player did before never counts, and the baseline is only taken once their counters have loaded.
• Rotations are worked out from the clock. A player is handed the new set on join, on opening /missions, and on the next check while online. A set that replaces an older one plays missions-rotated and sends the New missions message; a first ever set does not.

A mission's row is keyed by the player, the rotation and the mission, so a player cannot hold the same mission twice in one period on any server.

missions.yml

modules/missions/missions.yml. A missions section left in config.yml by an older version is moved here on start.

missions:
  daily_mine:
    display-name: 'Deep Shift'
    icon: IRON_PICKAXE
    description:
      - 'Break blocks in any of the server mines.'
    stat: 'mines.blocks'
    amount: 250-600
    pool: DAILY
    money: 60
    commands: []

A block with no stat, an amount that is not a positive number or range, or a pool that is neither is skipped with a warning. /sc reload re-reads the file. The shipped file has seven daily and six weekly missions.

Collecting

A finished mission is collected by clicking it, or by Collect everything. The row is marked collected before anything is paid, so a double click pays once.

• money goes through money boosters for missions — see Economy — and needs an economy.
• commands get %player%, %player_name%, %mission%, %target% and %money%, the money actually paid or, when nothing was, the configured amount.
• It counts missions.completed, missions.daily.completed or missions.weekly.completed, and missions.earned for the money paid.

Every check-interval-seconds the plugin looks for missions that have just been finished. With auto-claim: false the player is sent Mission complete once per session, and a weekly one is broadcast to players with mission-announcements on in /settings. With auto-claim: true it is collected there and then.

A mission removed from missions.yml while a player holds it is drawn as Retired mission and cannot be collected. /missionsadmin reset is how an admin hands them a fresh set.

The screen

modules/missions/menus/missions.yml. The Reward line shows the configured money before boosters; a mission that pays only commands reads Items, whatever the commands give. The buttons are survivalcore:missions_open, survivalcore:missions_claim <row> and survivalcore:missions_claim_all.

Settings

modules/missions/config.yml:

Commands

/missionsadmin runs from the console.

Placeholders

Seasons

A season is a ranking over one counter for a day, a week or a month. When it ends, the best places are paid and the next season opens.

How a season counts

While a season is open, every addition to its counter is also added under a key of its own, seasons.<season>.<period>. Its ranking is that key's leaderboard, so only what is counted while the season is open ranks in it, and a reload does not reset a season that is running.

Closing, once across servers

Every server checks once a minute, the first time ten seconds after start. When a season's period is over and close-delay-minutes more have passed:

1. Every server tries to delete the season's row; the one that succeeds is the only one that goes on.
2. It ranks the top leaderboard-size places, or as many as the prizes pay if that is more. A score of 0 is not placed.
3. It stores the results, pays the prizes, opens the next season and deletes the season's counter.
4. Every server announces the top three to players with season-announcements on in /settings.

What is counted during the close delay still counts for the season that is closing. A prize for a player online on the closing server is given there and then with You finished #N; anyone else, offline or on another server, gets it on their next join. The announcement travels on the seasons channel, which on a network needs Redis.

A season with no open row is opened by the first server that notices, straight away on a first start and after five minutes otherwise, so a server between closing and reopening is not raced.

Periods and time zone

All of it is read in settings.timezone.

seasons.yml

modules/seasons/seasons.yml is yours to edit; keys a later version adds appear on their own, and /sc reload re-reads it.

seasons:
  voters:
    display-name: '{primary}&lTOP VOTERS'
    description: 'Votes cast for the server'
    icon: PAPER
    counter: 'votes.total'
    period: MONTHLY
    format: NUMBER
    prizes:
      '1':
        - type: ECONOMY
          value: '1500'
        - 'boostersadmin give %player_name% money 2 2h'
      '2':
        - type: ECONOMY
          value: '900'

The shipped file ranks miners and farmers weekly and voters monthly.

Prizes

Each key under prizes is a place, '1', or a range, '4-10', and its value is an Exylia reward list. A place covered by two keys takes the first one written. A key that is not a place is reported and skipped. Prize money is not multiplied by boosters.

Settings

modules/seasons/config.yml:

Screens and commands

modules/seasons/menus/seasons.yml lists every season with its top three and the player's place and score; clicking one opens season_board.yml, the full ranking with each place's prize and the last season's winners. Rankings on screen are at most a minute old. The buttons are survivalcore:seasons_open and survivalcore:seasons_board <season>.

/seasonsadmin close runs from the console. The season it opens runs to the normal end of the period, so closing a weekly season on Thursday leaves a short one until Monday.

Placeholders

A season id with underscores is read whole; in the top_ ones the place comes first.