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.

​
Installing SuperiorSkyblock2

Get SuperiorSkyblock2 up and running on your Minecraft server in minutes.

​
Prerequisites

Server Requirements
  • Minecraft Server: Spigot or Paper 1.13+
  • Java: Java 8 or higher
  • RAM: Minimum 2GB allocated (4GB+ recommended)
  • Permissions Plugin: Optional (Vault + LuckPerms recommended)

​
Installation Steps

1

Download SuperiorSkyblock2

Download the latest version of SuperiorSkyblock2:The plugin file will be named something like SuperiorSkyblock2-VERSION.jar.
2

Stop Your Server

If your server is running, stop it before installing:
stop
Wait for the server to fully shut down before proceeding.
3

Install the JAR File

Place the downloaded SuperiorSkyblock2-VERSION.jar file into your server’s plugins folder:
your-server/
└── plugins/
    └── SuperiorSkyblock2-VERSION.jar
4

Install Dependencies (Optional)

For enhanced functionality, install these optional plugins:Economy & PermissionsPlaceholdersPerformance & Features
SuperiorSkyblock2 supports 20+ plugins. See the full list in plugin.yml under class-depends.
5

Start Your Server

Start your server to generate the default configuration:
java -Xmx4G -jar server.jar
The plugin will create the following directory structure:
plugins/SuperiorSkyblock2/
├── config.yml          # Main configuration
├── blockValues.yml     # Block worth values
├── schematics/         # Island schematics
├── lang/               # Language files
├── menus/              # GUI configurations
└── modules/            # Module configs
    ├── bank/
    ├── generators/
    ├── missions/
    └── upgrades/
6

Verify Installation

Check that the plugin loaded successfully:
plugins
You should see SuperiorSkyblock2 in green, indicating it’s enabled.Test the main command:
island help

​
Database Configuration

By default, SuperiorSkyblock2 uses SQLite (no setup required). For larger servers, configure MySQL/MariaDB: 
database:
  type: SQLite
  backup: true
Important: Always backup your database before switching from SQLite to MySQL/MariaDB. Set backup: true to enable automatic backups on startup.

​
Initial Configuration

Edit config.yml to customize your server:

​
Main Command

Customize the island command and aliases:
config.yml
# Set the main command of the plugin
# Add aliases by separating them with commas
island-command: 'island,is,islands'

​
World Settings

Configure which dimensions are available:
config.yml
worlds:
  default-world: normal  # normal, nether, or the_end
  world-name: SuperiorWorld
  
  normal:
    enabled: true
    unlock: true  # Unlocked by default
    biome: PLAINS
  
  nether:
    enabled: false  # Disabled by default
    unlock: true
    biome: NETHER_WASTES
  
  end:
    enabled: false  # Disabled by default
    unlock: false  # Requires unlock
    biome: THE_END

​
Island Defaults

Set starting values for new islands:
config.yml
max-island-size: 200  # Maximum island size

default-values:
  island-size: 20      # Starting size
  team-limit: 4        # Max members
  coop-limit: 8        # Max co-op players
  warps-limit: 3       # Max warps
  
  # Block/entity limits
  block-limits:
    HOPPER: 8
  entity-limits:
    MINECART: 4
  
  # Multipliers
  crop-growth: 1
  spawner-rates: 1
  mob-drops: 1
  
  # Cobblestone generator
  generator:
    normal:
      COBBLESTONE: 95
      COAL_ORE: 5

​
Spawn Location

Set the spawn point (where players go when kicked/disbanded):
config.yml
spawn:
  # Format: world, x, y, z, pitch, yaw
  location: SuperiorWorld, 0, 100, 0, 0, 0
  protection: true
  size: 200
You can set the spawn location in-game using /is admin setspawn while standing at the desired location.

​
Performance Tuning

Optimize for your server size:
config.yml
# Disable redstone on offline islands
disable-redstone-offline: true

# Automatic block tracking (worth calculation)
auto-blocks-tracking: true

# Block count save threshold (higher = better performance)
block-counts-save-threshold: 100

# Auto calculation interval (0 = disabled, recommended)
calc-interval: 0

# Recalc timeout in seconds
recalc-task-timeout: 10

​
First-Time Setup

1

Set Spawn Location

Teleport to your desired spawn point and run:
/is admin setspawn
2

Create Island Schematics

SuperiorSkyblock2 comes with default schematics. To add custom schematics:
  1. Build your island template in-game
  2. Select the area with WorldEdit
  3. Use /is admin schematic create <name>
Schematics are saved to plugins/SuperiorSkyblock2/schematics/
3

Configure Block Values

Edit blockValues.yml to set worth values for blocks:
blockValues.yml
DIAMOND_BLOCK:
  worth: 1000
  level: 500

EMERALD_BLOCK:
  worth: 2000
  level: 1000
4

Test Island Creation

Join your server and create a test island:
/island create MyIsland
Verify that:
  • The island generates correctly
  • You can teleport to it
  • Commands work as expected
5

Reload Configuration

After making changes, reload the plugin:
/is admin reload
Some config changes (like max-island-size and island-command) require a full server restart.

​
Troubleshooting

​
Plugin Won’t Load

  • Check Java Version: SuperiorSkyblock2 requires Java 8+
  • Check Server Type: Must be Spigot or Paper 1.13+
  • Review Console Errors: Look for missing dependencies or conflicts

​
Islands Not Generating

  • Verify worlds.world-name in config.yml
  • Check that the world exists or can be created
  • Ensure sufficient disk space for world files

​
Database Errors

  • SQLite: Ensure write permissions in the plugin folder
  • MySQL: Verify connection details and database exists
  • Connection Issues: Check firewall and useSSL settings

​
Permission Issues

  • Install Vault for permission management
  • Grant players superior.island.* for all island commands
  • Admins need superior.admin.* for admin commands

​
Next Steps

Quick Start Guide

Learn how to create and manage your first island

Configuration Guide

Deep dive into advanced configuration options

Build docs developers (and LLMs) love

Get started for freeTalk to us