Main Configuration (config.yml)

The config.yml file is the main configuration file for SuperiorSkyblock2. It controls core plugin behavior, island defaults, world settings, and gameplay features.

Database Settings

Configure how SuperiorSkyblock2 stores island data:

config.yml

database:
  # For local database, use "SQLite".
  # For remote database, use "MySQL" or "MariaDB"
  type: SQLite
  # Whether the datastore folder should be back-up on startup
  backup: true
  # Remote database information
  address: 'localhost'
  port: 3306
  db-name: 'SuperiorSkyblock'
  user-name: 'root'
  password: 'root'
  prefix: ''
  useSSL: false
  allowPublicKeyRetrieval: true
  waitTimeout: 600000
  maxLifetime: 1800000

Database Options

type: SQLite, MySQL, or MariaDB
backup: Automatically backup database on startup
address: Database server hostname (remote only)
port: Database server port (default: 3306)
db-name: Database name to use
prefix: Table prefix for multi-server setups
waitTimeout: Connection timeout in milliseconds
maxLifetime: Maximum connection lifetime in milliseconds

Island Command

Customize the main island command and its aliases:

config.yml

# Set the main command of the plugin.
# You can add aliases by splitting them with ","
# Requires a full restart to apply changes
island-command: 'island,is,islands'

Changing the island command requires a full server restart, not just a plugin reload.

Island Size & Spacing

config.yml

# Set the maximum island size. Island distances is 3 times bigger than the max size.
max-island-size: 200

# Set the islands height generation for islands
islands-height: 100

Island distance is calculated as max-island-size * 3. Do not change max-island-size while you have active islands!

Default values

Define default values for newly created islands:

Island Size

config.yml

default-values:
  # The default island size of all islands
  island-size: 20

Block Limits

Limit specific blocks per island:

config.yml

default-values:
  # Set the default block limits of all islands.
  # Materials list: https://bg-software.com/materials/
  block-limits:
    HOPPER: 8

Entity Limits

Limit entities per island:

config.yml

default-values:
  # Set the default entity limits of all islands.
  # Entities list: https://bg-software.com/entities/
  entity-limits:
    MINECART: 4

Team & Coop Limits

config.yml

default-values:
  # Default warps limit
  warps-limit: 3
  # Default team members limit
  team-limit: 4
  # Default coop players limit
  coop-limit: 8

Multipliers

config.yml

default-values:
  # Default crop-growth multiplier
  crop-growth: 1
  # Default spawner-rates multiplier
  spawner-rates: 1
  # Default mob-drops multiplier
  mob-drops: 1

Bank Limit

config.yml

default-values:
  # Default bank limit (-1 for unlimited)
  bank-limit: -1

Generator Rates

Configure cobblestone generator block percentages:

config.yml

default-values:
  # Set the default generator percentages of all islands.
  # Materials list: https://bg-software.com/materials/
  generator:
    normal:
      COBBLESTONE: 95
      COAL_ORE: 5
    nether:
      NETHERRACK: 100

Generator Configuration

Generator rates are defined as ratios. In the example above:

95 parts COBBLESTONE + 5 parts COAL_ORE = 100 total
This gives a 95% chance for cobblestone and 5% chance for coal ore

For 0.5% diamond block chance:

DIAMOND_BLOCK: 1
STONE: 199

Total: 200 parts = 1/200 = 0.5%

Island Effects

Apply potion effects to island members:

config.yml

default-values:
  # Set default island effects for all islands.
  # Valid effects: https://hub.spigotmc.org/javadocs/spigot/org/bukkit/potion/PotionEffectType.html
  island-effects:
    SPEED: 2
    JUMP: 1

World configuration

Configure island worlds (Normal, Nether, End):

config.yml

worlds:
  # The default world that will be used
  # Use normal, nether or the_end
  default-world: normal
  
  # Set the name of the islands world
  world-name: SuperiorWorld
  
  # Settings related to the normal world
  normal:
    enabled: true
    unlock: true
    schematic-offset: true
    biome: PLAINS
  
  # Settings related to the nether world
  nether:
    enabled: false
    unlock: true
    name: ''
    schematic-offset: true
    biome: NETHER_WASTES
  
  # Settings related to the end world
  end:
    enabled: false
    unlock: false
    name: ''
    schematic-offset: true
    biome: THE_END
    dragon-fight:
      enabled: false
      portal-offset: '0, 0, 0'
  
  # The difficulty of the island worlds
  difficulty: EASY
  
  # Set the sea level height for island worlds
  sea-level-height: 100

World Settings Explained

enabled: Whether this dimension is available
unlock: Whether dimension is unlocked by default for new islands
name: Custom world name (empty = auto-generated)
schematic-offset: Exclude schematic blocks from worth/level calculations
biome: Default biome for the dimension
dragon-fight: Enable per-island ender dragon fights (End only)

Island roles

Define island role hierarchy and permissions:

config.yml

island-roles:
  # Role for non-members
  guest:
    name: 'Guest'
    permissions: []
  
  # Role for coop players
  coop:
    name: 'Coop'
    permissions:
      - BREAK
      - BUILD
      - INTERACT
      - CHEST_ACCESS
      - PICKUP_DROPS
      # ... more permissions
  
  # Role ladder for island members
  ladder:
    member:
      id: 0
      name: 'Member'
      weight: 0
      permissions:
        - ANIMAL_SPAWN
        - CHEST_ACCESS
        - DEPOSIT_MONEY
        - FLY
        - ISLAND_CHEST
        - MONSTER_SPAWN
        - RANKUP
        - SPAWNER_BREAK
    
    mod:
      id: 1
      name: 'Moderator'
      weight: 1
      permissions:
        - BAN_MEMBER
        - CLOSE_ISLAND
        - DELETE_WARP
        - EXPEL_PLAYERS
        - INVITE_MEMBER
        - KICK_MEMBER
        - OPEN_ISLAND
        - SET_WARP
    
    admin:
      id: 2
      name: 'Admin'
      weight: 2
      permissions:
        - COOP_MEMBER
        - DEMOTE_MEMBERS
        - PROMOTE_MEMBERS
        - SET_BIOME
        - SET_HOME
        - SET_PERMISSION
        - SET_ROLE
        - SET_SETTINGS
    
    leader:
      id: 3
      name: 'Leader'
      weight: 3
      permissions:
        - ALL

Do not change role IDs! They are used internally to identify roles. Only modify names, weights, and permissions.

Each role inherits all permissions from roles with lower weight. For example, Moderator has all Member permissions plus their own.

Spawn Island

Configure the spawn island where players are teleported:

config.yml

spawn:
  # The spawn location (world, x, y, z, yaw, pitch)
  location: SuperiorWorld, 0, 100, 0, 0, 0
  
  # Should the spawn be protected?
  protection: true
  
  # Settings enabled at spawn
  settings:
    - CROPS_GROWTH
    - LAVA_FLOW
    - NATURAL_ANIMALS_SPAWN
    - SPAWNER_ANIMALS_SPAWN
    - TREE_GROWTH
    - WATER_FLOW
  
  # Permissions for spawn island
  permissions: []
  
  # Should a world border be displayed in the spawn?
  world-border: false
  
  # Set the radius of the spawn island
  size: 200
  
  # Should players get damage in the spawn?
  players-damage: false

Stacked Blocks

Configure the stacked blocks feature:

config.yml

stacked-blocks:
  # Enable/disable stacked blocks globally
  enabled: true
  
  # Custom name for stacked blocks
  custom-name: '&ex{0} {1}'
  
  # Worlds where blocks cannot stack
  disabled-worlds: []
  
  # Whitelisted blocks that can stack
  whitelisted:
    - 'DIAMOND_BLOCK'
  
  # Set limits to stacked blocks
  limits:
    EXAMPLE_BLOCK: 5
  
  # Should blocks get added directly into inventory?
  auto-collect: false
  
  # Deposit menu settings
  deposit-menu:
    enabled: true
    title: '&lDeposit Blocks'

Island Names

Configure island naming requirements:

config.yml

island-names:
  # Should island creation require a name?
  required-for-creation: true
  
  # Maximum and minimum name length
  max-length: 16
  min-length: 3
  
  # Blacklisted names
  filtered-names:
    - fuck
    - duck
    - hypixel
  
  # Enable color codes in names
  color-support: true
  
  # Show names on island-top?
  island-top: true
  
  # Prevent using player names as island names
  prevent-player-names: false

Teleportation Settings

config.yml

# Teleport on island creation?
teleport-on-create: true

# Teleport when accepting an invite?
teleport-on-join: false

# Teleport to spawn when kicked?
teleport-on-kick: true

# Teleport to spawn when leaving?
teleport-on-leave: false

# Teleport warmup delays (in milliseconds)
warps-warmup: 0
home-warmup: 0
visit-warmup: 0

Island Top Ordering

config.yml

# How should the island top be ordered by default?
# Use WORTH, LEVEL, RATING or PLAYERS
island-top-order: 'WORTH'

# How should the global warps be ordered?
global-warps-order: 'WORTH'

Crops Growth

Configure which crops are affected by the crop growth multiplier:

config.yml

# Frequency for crops task (in ticks)
crops-interval: 5

# List of crops affected by crop-growth multiplier
crops-to-grow:
  - 'WHEAT'
  - 'CARROT'
  - 'POTATO'
  - 'BEETROOTS'
  - 'NETHER_WART'
  - 'SUGAR_CANE'
  - 'CACTUS'
  - 'BAMBOO'
  - 'SAPLING'
  # ... more crops

Setting crops-interval to 0 disables the crops growth multiplier feature entirely.

Island Chests

config.yml

island-chests:
  # The chest title
  chest-title: '&4Island Chest'
  # Default amount of pages (0 = none)
  default-pages: 0
  # Default size (rows: 1-6)
  default-size: 3

Number & Date Formatting

config.yml

# Number formatting locale
number-format: "en-US"

# Date format pattern
date-format: "dd/MM/yyyy HH:mm:ss"

Performance Settings

config.yml

# Disable redstone on offline islands?
disable-redstone-offline: true

# AFK integrations (Essentials, CMI)
afk-integrations:
  disable-redstone: false
  disable-spawning: false

# Recalculate task timeout (seconds)
recalc-task-timeout: 10

# Block counts save threshold
block-counts-save-threshold: 100

Provider Settings

config.yml

# Spawners provider
# Providers: Auto, WildStacker, EpicSpawners, MergedSpawner, 
# PvpingSpawners, SilkSpawners, RoseStacker
spawners-provider: 'AUTO'

# Stacked-blocks provider
# Providers: Auto, WildStacker, RoseStacker
stacked-blocks-provider: 'AUTO'

Additional Settings

Confirmation GUIs

ban-confirm: true
disband-confirm: true
kick-confirm: true
leave-confirm: true
transfer-confirm: true

Worth & Level Calculation

# Formula to calculate block level from worth
block-level-formula: '{} / 2'

# Round island levels to integers?
rounded-island-level: false

# Rounding mode: UP, DOWN, CEILING, FLOOR, HALF_UP, HALF_DOWN, HALF_EVEN
island-level-rounding-mode: 'HALF_UP'

# Auto-track blocks on place/break?
auto-blocks-tracking: true

# Allow negative worth/level?
negative-worth: true
negative-level: true

Player Respawn

# Actions to perform on respawn (in order)
player-respawn:
  - ISLAND_TELEPORT
  - SPAWN_TELEPORT

Available actions:

BED_TELEPORT - Teleport to bed spawn
ISLAND_TELEPORT - Teleport to own island
SPAWN_TELEPORT - Teleport to spawn
VANILLA - Use vanilla spawn point

Default Settings

# Default language
default-language: 'en-US'

# Default world border enabled?
default-world-border: true

# Default blocks stacker enabled?
default-blocks-stacker: true

# Default panel toggled?
default-toggled-panel: false

# Default island fly?
default-island-fly: false

# Default border color: BLUE, GREEN, RED
default-border-color: BLUE

Full Config Reference

For the complete config.yml with all available options and comments, see the config.yml file on GitHub.

​Database Settings

​Island Command

​Island Size & Spacing

​Default values

​Island Size

​Block Limits

​Entity Limits

​Team & Coop Limits

​Multipliers

​Bank Limit

​Generator Rates

​Island Effects

​World configuration

​Island roles

​Spawn Island

​Stacked Blocks

​Island Names

​Teleportation Settings

​Island Top Ordering

​Crops Growth

​Island Chests

​Number & Date Formatting

​Performance Settings

​Provider Settings

​Additional Settings

​Full Config Reference

Database Settings

Island Command

Island Size & Spacing

Default values

Island Size

Block Limits

Entity Limits

Team & Coop Limits

Multipliers

Bank Limit

Generator Rates

Island Effects

World configuration

Island roles

Spawn Island

Stacked Blocks

Island Names

Teleportation Settings

Island Top Ordering

Crops Growth

Island Chests

Number & Date Formatting

Performance Settings

Provider Settings

Additional Settings

Full Config Reference