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.

SuperiorSkyblock2 provides a comprehensive configuration system that allows you to customize every aspect of your skyblock server. All configuration files are located in the plugins/SuperiorSkyblock2/ directory.

​
Configuration Files

The plugin uses several YAML configuration files to manage different aspects of the server:

​
Main Configuration Files

config.yml

Main plugin configuration including database settings, island defaults, world settings, and gameplay features

plugin.yml

Plugin metadata and permission node definitions for all commands and features

Schematics

Island schematic files that define the default island layouts players can choose from

Menus

Customizable GUI menus for settings, upgrades, permissions, and more

​
Additional Configuration Files

  • heads.yml - Skull texture mappings for spawner display in menus
  • interactables.yml - Configurable block and entity interactions
  • safe_blocks.yml - Blocks that are safe from protection checks
  • lang/ - Language translation files for multi-language support
  • block-values/ - Block worth and level values for island calculations

​
Configuration Structure

plugins/SuperiorSkyblock2/
├── config.yml                 # Main configuration
├── plugin.yml                 # Plugin metadata
├── heads.yml                  # Spawner skull textures
├── interactables.yml          # Interaction settings
├── safe_blocks.yml            # Protected blocks list
├── schematics/               # Island schematic files
│   ├── normal.schematic
│   ├── mycel.schematic
│   └── desert.schematic
├── menus/                    # GUI configuration files
│   ├── settings.yml
│   ├── permissions.yml
│   ├── upgrades.yml
│   └── ...
├── lang/                     # Language files
│   ├── en-US.yml
│   └── ...
├── modules/                  # Module configurations
│   ├── missions/
│   ├── upgrades/
│   ├── generators/
│   └── bank/
└── block-values/            # Block worth definitions

​
Key Configuration Sections

Configure how SuperiorSkyblock2 stores data:
  • SQLite for local storage (default)
  • MySQL/MariaDB for remote database
  • Automatic backup on startup
See Database Settings for details.
Set default values for new islands:
  • Island size and limits
  • Team and coop limits
  • Generator rates
  • Block and entity limits
  • Island effects
See Default Values for details.
Configure island worlds:
  • Enable/disable Normal, Nether, and End dimensions
  • Custom world names
  • Biome settings
  • World difficulty
  • Dragon fight mechanics
See World Configuration for details.
Define role hierarchy and permissions:
  • Guest, Coop, Member, Moderator, Admin, Leader
  • Custom role permissions
  • Role weight system
  • Permission inheritance
See Island Roles for details.

​
Best Practices

Always backup your configuration files before making changes. Invalid YAML syntax can prevent the plugin from loading.
After modifying configuration files, use /is admin reload to apply changes without restarting the server. Some settings may require a full restart.

​
Configuration Tips

  1. Test changes incrementally - Make small changes and test them before proceeding
  2. Use YAML validators - Ensure your YAML syntax is valid before reloading
  3. Keep backups - The plugin automatically backs up the database, but manually backup configs
  4. Read comments - Configuration files include helpful comments explaining each option
  5. Check compatibility - Some settings require specific Minecraft versions (1.12, 1.13+, 1.16+, etc.)

​
Version-Specific Configurations

Many configuration files have version-specific variants:
  • 1_12.yml - Minecraft 1.12 and earlier
  • 1_13.yml - Minecraft 1.13-1.15
  • 1_16.yml - Minecraft 1.16-1.19
  • 1_20.yml - Minecraft 1.20+
  • 1_21.yml - Minecraft 1.21+
The plugin automatically loads the correct version based on your server.

​
Modules Configuration

SuperiorSkyblock2 supports modular features that can be configured independently:

Missions

Configure island missions and challenges for players to complete

Upgrades

Define island upgrade tiers and their costs/benefits

Generators

Customize cobblestone generator blocks and percentages

Bank

Configure island bank limits and transaction settings

​
Next Steps

Explore the detailed configuration guides:

Build docs developers (and LLMs) love

Get started for freeTalk to us