Skip to main content

Documentation Index

Fetch the complete documentation index at: https://mintlify.com/BG-Software-LLC/SuperiorSkyblock2/llms.txt

Use this file to discover all available pages before exploring further.

The top islands system provides competitive leaderboards that rank islands based on various metrics. Players can compete to reach the top and earn recognition for their achievements.

​
Viewing Top Islands

Open the top islands interface: 
/island top
This displays:
  • Top ranked islands
  • Island position
  • Sorting metric (worth, level, rating, or players)
  • Island owners and members
  • Your island’s current rank
The top islands panel is fully customizable through menu configuration files. Admins can change the layout, items, and display format.

​
Ranking Metrics

Islands can be ranked by different criteria:

​
By Worth

Total economic value of all blocks on the island:
  • Calculated from block worth values
  • Includes all placed blocks
  • Default sorting method

​
By Level

Island level derived from block values:
  • Based on block level values
  • Formula: block_worth / 2 (configurable)
  • Can be rounded or precise

​
By Rating

Average rating from player votes:
  • Players rate islands 1-5 stars
  • Average of all ratings
  • Requires player interaction

​
By Players

Number of members on the island:
  • Counts all island members
  • Excludes coop members
  • Simple membership metric
The default sorting method is configured in config.yml with the island-top-order setting.

​
Configuring Sort Order

Set the default sorting in config.yml: 
# How should the island top be ordered by default?
# Use WORTH, LEVEL, RATING or PLAYERS.
island-top-order: 'WORTH'
Valid values:
  • WORTH - Total island worth
  • LEVEL - Island level
  • RATING - Average player rating
  • PLAYERS - Member count

​
Island Worth Calculation

Island worth is calculated from block values:

​
Block Worth Values

Configured in block-values/worth.yml: 
DIAMOND_BLOCK: 10000
EMERALD_BLOCK: 15000
IRON_BLOCK: 1000
GOLD_BLOCK: 2000

​
Automatic Calculation

With auto-blocks-tracking enabled:
  • Worth updates when blocks are placed
  • Worth updates when blocks are broken
  • Real-time leaderboard updates
  • No manual recalculation needed

​
Manual Recalculation

Force a worth recalculation: 
/island recalc
This scans the entire island and recalculates:
  • Total worth
  • Island level
  • Block counts
  • Leaderboard position
Recalculation can take time for large islands. The process runs asynchronously to avoid server lag.

​
Island Level Calculation

Island level is derived from block values:

​
Level Formula

Configured in config.yml: 
# Use {} as a placeholder for worth
block-level-formula: '{} / 2'
Example:
  • Block worth: 10000
  • Formula: {} / 2
  • Block level: 5000

​
Level Rounding

Optionally round island levels: 
rounded-island-level: false
island-level-rounding-mode: 'HALF_UP'
Rounding modes:
  • UP - Always round up
  • DOWN - Always round down
  • CEILING - Round toward positive infinity
  • FLOOR - Round toward negative infinity
  • HALF_UP - Round to nearest, .5 goes up
  • HALF_DOWN - Round to nearest, .5 goes down
  • HALF_EVEN - Round to nearest even number
Level rounding affects display only. Internal calculations use precise values.

​
Rating System

Players can rate islands they visit:

​
Rating an Island

/island rate <player> <1-5>
Rating options:
  • 1 star - Poor
  • 2 stars - Below average
  • 3 stars - Average
  • 4 stars - Good
  • 5 stars - Excellent
Requirements:
  • superior.island.rate permission
  • Must have visited the island
  • Cannot rate your own island

​
Viewing Ratings

See all ratings for an island: 
/island ratings [player]
Displays:
  • Individual ratings from players
  • Average rating
  • Number of ratings received
Permissions:
  • superior.island.ratings - View ratings
  • RATINGS_SHOW privilege - Control who can see ratings (Moderator and above by default)
Encourage visitors to rate your island by creating impressive builds and features. Higher ratings improve your position when sorted by rating.

​
Ignoring Islands

Admins can exclude islands from the leaderboard: 
# Remove island from top islands
/admin ignore <player>

# Add island back to top islands
/admin unignore <player>
Use cases:
  • Test islands
  • Admin islands
  • Special event islands
  • Islands under investigation
Permissions:
  • superior.admin.ignore
  • superior.admin.unignore
Ignored islands don’t appear in leaderboards but function normally otherwise.

​
Leaderboard Updates

The top islands leaderboard updates:
  • Automatically: When island worth/level changes (if auto-tracking enabled)
  • On recalculation: When /island recalc is used
  • Periodically: Based on calc-interval setting (if configured)
  • On rating: When players rate islands

​
Calculation Interval

Configure automatic recalculation in config.yml: 
# Time in seconds between auto calculations
# Set to 0 to disable
calc-interval: 0
Automatic calculation of all islands can cause significant lag. It’s recommended to keep this disabled and use auto-blocks-tracking instead.

​
Viewing Your Rank

Check your island’s position: 
/island top
The menu shows:
  • Your current rank
  • Islands above and below you
  • Gap to next position
  • Current metric value

​
Competition and Rewards

Server administrators can create competitions using the top islands system: Timed Events
  • Set a time period (week, month)
  • Track top islands during that period
  • Award prizes to top positions
Milestone Rewards
  • Reward islands reaching certain levels
  • Bonus for first to achieve goals
  • Ongoing progression incentives
Seasonal Competitions
  • Reset island values periodically
  • Fresh starts for all players
  • Keep competition active
Use admin commands to track and reward top islands manually, or integrate with other plugins for automated rewards.

​
Admin Commands

Manage top islands and rankings: 
# Force recalculation for an island
/admin recalc <player>

# Set island worth manually
/admin setworth <player> <worth>

# Set island level manually
/admin setlevel <player> <level>

# Ignore island from leaderboard
/admin ignore <player>

# Unignore island
/admin unignore <player>

# Set player's rating of an island
/admin setrate <rater> <island> <rating>

# Remove all ratings by a player
/admin removeratings <player>
Permissions:
  • superior.admin.recalc
  • superior.admin.ignore
  • superior.admin.unignore
  • superior.admin.setrate
  • superior.admin.removeratings

​
Best Practices

1

Enable auto-tracking

Use auto-blocks-tracking: true for real-time leaderboard updates without manual recalculation.
2

Balance block values

Configure block worth and level values to create meaningful progression and competition.
3

Choose appropriate sorting

Select a default sorting method that matches your server’s focus (economy, building, community).
4

Encourage ratings

Promote the rating system to get player feedback and create another ranking dimension.

​
Integration with Other Features

Top islands integrate with: Global Warps
  • Warps can be sorted by island rank
  • Top islands get more visibility
  • Encourages quality builds
Island Upgrades
  • Higher levels unlock upgrades
  • Worth requirements for upgrades
  • Progression tied to ranking
Block Values
  • Worth and level from placed blocks
  • Incentivizes valuable builds
  • Creates economic gameplay
The top islands system uses the same sorting comparators as other features, ensuring consistency across the plugin.

Build docs developers (and LLMs) love

Get started for freeTalk to us