TDXDevelopment
TDX LeaderboardsConfiguration

monthly

The reset schedule. Monthly, weekly or biweekly periods, when each one ends, and what happens at the reset.

The monthly block decides how long a leaderboard period lasts. Despite the name, it supports weekly and biweekly periods too.

Quick example

plugins/TDXLeaderboards/config.yml
monthly:
  enabled: true
  reset-period: monthly   # monthly | weekly | biweekly
  broadcast-reset: true   # tell everyone online when a period resets
  archive-history: true   # keep past periods for /leaderboard history

When a period ends

The reset follows the calendar, in your server's timezone:

reset-periodResets at
monthlyMidnight on the 1st of each month.
weeklyMidnight every Monday.
biweeklyMidnight every second Monday (the start of an odd ISO week).

The plugin checks every five minutes and once on startup, so a reset fires within five minutes of the boundary. If the server was offline when a period ended, the reset runs on the next start instead. Nothing is lost, because the final standings are read from storage.

reset-day and reset-hour are still in config.yml, but they have done nothing since v1.9.8. The reset happens at the calendar boundary above, not at a day and hour you pick. From v1.9.19 the countdown in the GUI and the %tdxleaderboards_reset_time% placeholder count down to that same moment. Before that they used the two unused settings, so anything but the defaults showed the wrong time.

Reference

KeyTypeDefaultNotes
enabledbooleantrueTurns the automatic reset on. With false no period is ever closed out on its own.
reset-periodstringmonthlyOne of monthly, weekly, biweekly.
broadcast-resetbooleantrueSends the reset messages to everyone online.
archive-historybooleantrueSaves each period's final standings so they can be browsed later.
reset-dayinteger1Not used. See the warning above.
reset-hourinteger0Not used. See the warning above.

What happens at a reset

In this order:

  1. The final standings of the period that ended are read from storage.
  2. Rewards from the rewards block are paid. A winner who is offline gets their commands the next time they join.
  3. The standings are archived, if archive-history is on.
  4. The Discord webhook posts the results, if it is set up.
  5. The ended period's data is cleared. Every board starts the new period from zero.
  6. Players who are online get a fresh starting point on DELTA boards. Everybody else gets theirs the next time they join.

Rewards and the archive are each marked as done for that period, so a reset that runs twice never pays or archives a second time.

/lbadmin reset confirm is not this. It wipes the current period and starts it again from zero, with no rewards and no archive. To close out a past period that was missed, use /lbadmin archive <period> confirm. See Commands.

A biweekly period is numbered from the ISO week, so a year with 53 weeks ends on a period that is only one week long. 2026 is one of those years: the last period runs from 28 December 2026 to 3 January 2027.