Skip to main content

leaderboard points - Server Points Ranking Command

Command Title

/leaderboard points

Description

This command allows you to view the server's points leaderboard. You can filter the leaderboard by different time periods, set custom date ranges, and specify the number of members to display.

Usage

/leaderboard points [period] [date_range] [limit]

Parameters

Optional Parameters:

  • [period]: Specifies the time range for the leaderboard.

    • All: Displays the total points accumulated by users since they joined, minus any deductions or redemptions. This is the default.
    • Today: Shows points earned from 00:00 (server time zone) today until now.
    • This Week: (Premium) Shows points earned from Monday 00:00 (server time zone) of the current week until now.
    • This Month: (Premium) Shows points earned from the 1st of the current month 00:00 (server time zone) until now.
    • 7-Day: (Premium) Shows points earned over the last 7 rolling days from the current time.
    • 30-Day: (Premium) Shows points earned over the last 30 rolling days from the current time.
    • Custom: (Ultimate) Allows you to specify a custom date range using the date_range parameter.
    Important:
    • When period is set to All, the leaderboard displays each member's current point balance, including all points they have earned minus any points they have spent.
    • For all other periods (e.g., Today, This Week, Custom), the leaderboard shows the total amount of points earned by each member during that specific time period, regardless of their current balance.
  • [date_range]: This parameter is only used when period is set to Custom. It allows you to specify a single date or a date range for the leaderboard.

    • Single Day: Use the format YYYY-MM-DD,YYYY-MM-DD for a specific day (e.g., 2025-07-07,2025-07-07 for July 7, 2025).
    • Date Range: Use the format YYYY-MM-DD,YYYY-MM-DD to specify a range, including the start and end dates (e.g., 2025-07-01,2025-07-07).
    • Start Date to Present: Use the format YYYY-MM-DD (e.g., 2025-07-01) to show points from the specified start date up to the current time.
  • [limit]: Specifies the number of top members to display on the leaderboard. The maximum supported value is 100. The default is 10.

Examples

  • Example 1: View the overall points leaderboard showing the top 10 members.

    /leaderboard points
  • Example 2: View the points leaderboard for today, showing the top 10 members.

    /leaderboard points period:Today
  • Example 3: View the points leaderboard for this week, showing the top 20 members.

    /leaderboard points period:This Week limit:20
  • Example 4: View the points leaderboard for this month, showing the top 30 members.

    /leaderboard points period:This Month limit:30
  • Example 5: View the leaderboard for the past 7 days, showing the top 15 members.

    /leaderboard points period:7-Day limit:15
  • Example 6: View the leaderboard for July 1, 2025 only.

    /leaderboard points period:Custom date_range:2025-07-01,2025-07-01
  • Example 7: View the points leaderboard for the first week of July 2025, showing the top 50 members.

    /leaderboard points period:Custom date_range:2025-07-01,2025-07-07 limit:50
  • Example 8: View the points leaderboard from July 1, 2025 to now.

    /leaderboard points period:Custom date_range:2025-07-01

Notes

  • Only members with admin permissions can use the /leaderboard points command.
  • The "Refresh" button on the leaderboard is visible and clickable by all members, but there is a 5-minute cooldown between clicks.
  • The "My Rank" button is clickable by all members, but only their own rank will be displayed.
  • Certain period options (This Week, This Month, 7-Day, 30-Day) require a Premium plan.
  • The Custom period option requires an Ultimate plan.
  • The date_range parameter is only applicable when period is set to Custom.

FAQ

  • Q: Can regular members see the leaderboard?

    A: While only administrators can use the /leaderboard points command to generate the leaderboard, the "Refresh" and "My Rank" buttons on an existing leaderboard display are visible and clickable by all members.

  • Q: What is the maximum number of members I can display on the leaderboard?

    A: You can display up to 100 members on the leaderboard using the limit parameter.

  • Q: Do I need a special subscription to view leaderboards for specific time periods like "This Week" or "Custom"?

    A: Yes, "This Week," "This Month," "7-Day," and "30-Day" periods require a Premium plan. The "Custom" period requires an Ultimate plan.