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 block stacking system allows players to stack multiple blocks in a single location, reducing lag and saving space. This is especially useful for large farms and storage systems.

​
Enabling Block Stacking

Block stacking is controlled by both global and per-player settings:

​
Global Setting

Configure in config.yml: 
stacked-blocks:
  enabled: true
Set to false to completely disable the feature server-wide.

​
Per-Player Toggle

Players can toggle block stacking for themselves: 
/island toggle blocks
Requirements:
  • superior.island.toggle.blocks permission
  • Global stacked blocks must be enabled
When block stacking is toggled on, placing blocks of the same type on existing blocks will stack them instead of replacing.

​
How Block Stacking Works

1

Enable stacking mode

Toggle block stacking with /island toggle blocks.
2

Place blocks

Click on an existing block with the same block type to add to the stack.
3

View stack amount

A hologram appears above stacked blocks showing the quantity.
4

Break stacked blocks

Breaking removes one block from the stack. The stack decreases until depleted.
Stacked blocks automatically update their hologram display as you add or remove blocks from the stack.

​
Whitelisted Blocks

Only specific blocks can be stacked, configured in config.yml: 
stacked-blocks:
  whitelisted:
    - 'DIAMOND_BLOCK'
    - 'IRON_BLOCK'
    - 'GOLD_BLOCK'
    - 'EMERALD_BLOCK'
Benefits of whitelisting:
  • Prevents accidental stacking of unwanted blocks
  • Controls which blocks can be optimized
  • Maintains server balance
Players need the superior.island.stacker.* permission to stack blocks, or specific permissions like superior.island.stacker.DIAMOND_BLOCK for individual block types.

​
Stack Limits

Limit the maximum stack size for specific blocks: 
stacked-blocks:
  limits:
    DIAMOND_BLOCK: 1000
    IRON_BLOCK: 5000
When a limit is reached:
  • Additional blocks cannot be added to that stack
  • Players must create a new stack elsewhere
  • Helps prevent excessive stacking

​
Hologram Display

Stacked blocks show a hologram above them with:
  • Current stack amount
  • Block type name
  • Formatted numbers for readability

​
Custom Hologram Name

Configure the hologram format: 
stacked-blocks:
  custom-name: '&ex{0} {1}'
Placeholders:
  • {0} - Stack amount (raw number)
  • {1} - Block type name (capitalized)
  • {2} - Stack amount (formatted with commas)
Example output: &ex1000 Diamond Block
Use color codes in the custom name to make stacked blocks more visible. For example, &ex creates a light purple color.

​
Auto-Collect Feature

When breaking stacked blocks, items can go directly to inventory: 
stacked-blocks:
  auto-collect: true
Benefits:
  • Blocks don’t drop on the ground
  • Faster collection
  • Reduced item entities = less lag
  • Works with full inventories (excess drops normally)

​
Deposit Menu

Quickly deposit blocks into a stack: 
stacked-blocks:
  deposit-menu:
    enabled: true
    title: '&lDeposit Blocks'
1

Shift-click stacked block

Crouch and right-click a stacked block.
2

Deposit menu opens

A GUI appears allowing you to deposit blocks from your inventory.
3

Select amount

Choose how many blocks to add to the stack.
The deposit menu is especially useful for quickly adding large quantities from your inventory to an existing stack.

​
Disabled Worlds

Prevent block stacking in specific worlds: 
stacked-blocks:
  disabled-worlds:
    - 'world_pvp'
    - 'events'
Use cases:
  • Event worlds where stacking shouldn’t work
  • PvP arenas
  • Special game modes

​
Performance Benefits

Block stacking significantly reduces server load: Without Stacking:
  • 1000 diamond blocks = 1000 block entities to track
  • Increases chunk save/load times
  • More data to serialize
With Stacking:
  • 1000 diamond blocks = 1 stacked block entity
  • Faster chunk operations
  • Reduced memory usage
  • Less network traffic
Encourage players to use block stacking for large farms and storage areas to keep the server running smoothly.

​
Integration with Island Values

Stacked blocks are properly counted for:
  • Island worth calculation: Each block in the stack counts toward total worth
  • Island level: Stack amounts are included in level calculations
  • Block counts: /island counts shows accurate numbers including stacks
  • Block limits: Each stacked block counts toward island block limits
When island values are recalculated, stacked blocks are automatically detected and counted correctly.

​
Breaking Stacked Blocks

When you break a stacked block:
  1. One block is removed from the stack
  2. Stack count decreases by 1
  3. Hologram updates to show new amount
  4. If stack reaches 0, the hologram is removed
  5. Block drop follows normal drop rules (unless auto-collect is enabled)

​
Admin Commands

There are no specific admin commands for block stacking, but admins can:
  • Modify config.yml to change stacking settings
  • Grant or revoke superior.island.stacker.* permissions
  • Configure whitelisted blocks and limits
  • Disable stacking in specific worlds

​
Use Cases

Storage Systems
  • Stack valuable blocks in compact storage
  • Reduce chest clutter
  • Visual indicator of quantities
Large Farms
  • Stack crops for compact harvesting
  • Reduce entity count from drops
  • Easier inventory management
Building Materials
  • Store construction materials as stacks
  • Quick access to large quantities
  • Save space in build areas
Economy Systems
  • Create visually impressive currency displays
  • Stack valuable blocks in shops
  • Show stock quantities with holograms

​
Best Practices

1

Whitelist carefully

Only whitelist blocks that benefit from stacking. Avoid blocks with states or NBT data.
2

Set reasonable limits

Configure stack limits to prevent abuse while allowing legitimate use.
3

Enable auto-collect

Reduce lag from item drops by enabling auto-collect for stacked blocks.
4

Use deposit menu

Enable the deposit menu to make adding to stacks more convenient.

​
Troubleshooting

Blocks won’t stack:
  • Check if block type is whitelisted
  • Verify player has superior.island.stacker.* permission
  • Ensure block stacking is toggled on with /island toggle blocks
  • Confirm stack hasn’t reached its limit
Hologram not appearing:
  • Check that the stack has more than 1 block
  • Verify hologram service is running
  • Ensure the block is a valid stacked block
Performance issues:
  • Limit maximum stack sizes
  • Reduce whitelisted blocks
  • Enable auto-collect to reduce item entities
Do not stack blocks with complex NBT data (like chests with items, spawners with settings, etc.) as this can cause data loss.

Build docs developers (and LLMs) love

Get started for freeTalk to us