# Overview

{% embed url="<https://www.youtube.com/watch?v=5VB39heYjp0>" %}
SoulStiker showcasing the plugin
{% endembed %}

SupreiorSkyblock is an all in one plugin for your Skyblock server. Every aspect of the plugin is configurable, and it's packed with a rich API that can let you change the way it behaves however you want. The plugin is very well optimized to ensure your server can hold as many players as possible!&#x20;

## Table of Contents

* [Overview](https://wiki.bg-software.com/superiorskyblock/overview)
  * [Supported Plugins](https://wiki.bg-software.com/superiorskyblock/overview#supported-plugins)
    * [Spawners Providers](https://wiki.bg-software.com/superiorskyblock/overview#spawners-providers)
    * [Skins Providers](#skins-providers)
    * [AFK Providers](#afk-providers)
    * [Vanish Providers](#vanish-providers)
    * [Permissions Providers](#permissions-providers)
    * [Placeholders Providers](#placeholders-providers)
    * [Stacked Blocks Providers](#stacked-blocks-providers)
    * [Prices Providers](#prices-providers)
    * [Additional Plugins](#general-plugins)
* [Commands and Permissions](https://wiki.bg-software.com/superiorskyblock/overview/commands-and-permissions)
  * [Player Commands](https://wiki.bg-software.com/superiorskyblock/overview/commands-and-permissions/player-commands)
  * [Admin Commands](https://wiki.bg-software.com/superiorskyblock/overview/commands-and-permissions/admin-commands)
  * [Permissions](https://wiki.bg-software.com/superiorskyblock/overview/commands-and-permissions/permissions)
* [Placeholders](https://wiki.bg-software.com/superiorskyblock/overview/placeholders)
  * [Global Placeholders](https://wiki.bg-software.com/superiorskyblock/overview/placeholders/global-placeholders)
  * [Island Placeholders](https://wiki.bg-software.com/superiorskyblock/overview/placeholders/island-placeholders)
  * [Player Placeholders](https://wiki.bg-software.com/superiorskyblock/overview/placeholders/player-placeholders)
  * [Chat Placeholders](https://wiki.bg-software.com/superiorskyblock/overview/placeholders/chat-placeholders)
* [Configuration Files](https://wiki.bg-software.com/superiorskyblock/overview/configuration-files)
  * [Directories Tree](https://wiki.bg-software.com/superiorskyblock/configuration-files#directories-tree)
  * [Configuration Files](https://wiki.bg-software.com/superiorskyblock/configuration-files#configuration-files)
* [Messages](https://wiki.bg-software.com/superiorskyblock/messages)
  * [Raw Messages](https://wiki.bg-software.com/superiorskyblock/messages#raw-messages)
  * [Complex Messages](https://wiki.bg-software.com/superiorskyblock/messages#complex-messages)
    * [Action Bars](https://wiki.bg-software.com/superiorskyblock/messages#action-bars)
    * [Titles](https://wiki.bg-software.com/superiorskyblock/messages#titles)
    * [Interactable Messages](https://wiki.bg-software.com/superiorskyblock/messages#interactable-messages)
  * [Custom language file](https://wiki.bg-software.com/superiorskyblock/messages#custom-language-file)
* [Island Flags](https://wiki.bg-software.com/superiorskyblock/island-flags)
  * [Built-in Flags](#table-of-contents)
  * [Create your own island flag](https://wiki.bg-software.com/superiorskyblock/overview/island-flags#create-your-own-island-flag)
* [Island Privileges](https://wiki.bg-software.com/superiorskyblock/overview/island-privileges)
  * [Built-in Privileges](https://wiki.bg-software.com/superiorskyblock/overview/island-privileges#built-in-privileges)
  * [Create your own island privilege](https://wiki.bg-software.com/superiorskyblock/overview/island-privileges#create-your-own-island-privilege)
* [Schematics](https://wiki.bg-software.com/superiorskyblock/overview/schematics)
  * [Creating your first schematic](https://wiki.bg-software.com/superiorskyblock/overview/schematics#creating-your-first-schematic)
  * [WorldEdit Schematics](https://wiki.bg-software.com/superiorskyblock/overview/schematics#worldedit-schematics)
  * [Adding your own schematic](https://wiki.bg-software.com/superiorskyblock/overview/schematics#adding-your-own-schematic)
* [Upgrades](https://wiki.bg-software.com/superiorskyblock/overview/upgrades)
  * [Creating your first upgrade](https://wiki.bg-software.com/superiorskyblock/overview/upgrades#creating-your-first-upgrade)
  * [Price Types](https://wiki.bg-software.com/superiorskyblock/overview/upgrades#price-types)
    * [Example](https://wiki.bg-software.com/superiorskyblock/overview/upgrades#example)
  * [Island Multipliers](https://wiki.bg-software.com/superiorskyblock/overview/upgrades/island-multipliers)
    * [Crop Growth](https://wiki.bg-software.com/superiorskyblock/overview/upgrades/island-multipliers#crops-growth)
    * [Spawner Rates](https://wiki.bg-software.com/superiorskyblock/overview/upgrades/island-multipliers#spawner-rates)
    * [Mob Drops](https://wiki.bg-software.com/superiorskyblock/overview/upgrades/island-multipliers#mob-drops)
* [Menus](https://wiki.bg-software.com/superiorskyblock/overview/menus)
  * [Editing the menu's style](https://wiki.bg-software.com/superiorskyblock/overview/menus#editing-the-menus-style)
  * [Editing items in the menu](https://wiki.bg-software.com/superiorskyblock/overview/menus#editing-items-in-the-menu)
  * [Giving sounds to items](https://wiki.bg-software.com/superiorskyblock/overview/menus#giving-sounds-to-items)
  * [Running custom commands](https://wiki.bg-software.com/superiorskyblock/overview/menus#running-custom-commands)
  * [Permissions Section](https://wiki.bg-software.com/superiorskyblock/overview/menus#permissions-section)
  * [Creating custom menus](https://wiki.bg-software.com/superiorskyblock/overview/menus#creating-custom-menus)
* [Missions](https://wiki.bg-software.com/superiorskyblock/overview/missions)
  * [How do missions work?](https://wiki.bg-software.com/superiorskyblock/overview/missions#how-do-missions-work)
  * [Default mission jars](https://wiki.bg-software.com/superiorskyblock/overview/missions#default-mission-jars)
  * [Missions file-structure](https://wiki.bg-software.com/superiorskyblock/overview/missions#missions-files-structure)
  * [Create your first mission](https://wiki.bg-software.com/superiorskyblock/overview/missions#create-your-first-mission)
  * [Create your own mission jar](#table-of-contents)
  * [BlocksMissions](https://wiki.bg-software.com/superiorskyblock/overview/missions/blocksmissions)
  * [BrewingMissions](https://wiki.bg-software.com/superiorskyblock/overview/missions/brewingmissions)
  * [CraftingMissions](https://wiki.bg-software.com/superiorskyblock/overview/missions/craftingmissions)
  * [EnchantingMissions](https://wiki.bg-software.com/superiorskyblock/overview/missions/enchantingmissions)
  * [FarmingMissions](https://wiki.bg-software.com/superiorskyblock/overview/missions/farmingmissions)
  * [FishingMissions](https://wiki.bg-software.com/superiorskyblock/overview/missions/fishingmissions)
  * [IslandMissions](https://wiki.bg-software.com/superiorskyblock/overview/missions/islandmissions)
  * [ItemsMissions](https://wiki.bg-software.com/superiorskyblock/overview/missions/itemsmissions)
  * [KillsMissions](https://wiki.bg-software.com/superiorskyblock/overview/missions/killsmissions)
  * [StatisticsMissions](https://wiki.bg-software.com/superiorskyblock/overview/missions/statisticsmissions)
* [Javascript Engine](https://wiki.bg-software.com/superiorskyblock/overview/javascript-engine)
  * [How to install an external scripts engine?](https://wiki.bg-software.com/superiorskyblock/overview/javascript-engine#how-to-install-an-external-scripts-engine)
* [API](https://wiki.bg-software.com/superiorskyblock/overview/api)
  * [Basic Usage](https://wiki.bg-software.com/superiorskyblock/overview/api#basic-usage)
  * [Creating your own command](https://wiki.bg-software.com/superiorskyblock/overview/api#creating-your-own-command)
  * [Register your own block-keys](https://wiki.bg-software.com/superiorskyblock/overview/api#register-your-own-block-keys)
* [Addons](https://wiki.bg-software.com/superiorskyblock/overview/addons)
  * [OneBlock Addon](https://wiki.bg-software.com/superiorskyblock/overview/addons#oneblock-addon)
  * [AcidIslands Addon](https://wiki.bg-software.com/superiorskyblock/overview/addons#acidislands-addon)
  * [Custom Script-Engines Addons](https://wiki.bg-software.com/superiorskyblock/overview/addons#custom-script-engines-addons)
    * [Nashron Engine](https://wiki.bg-software.com/superiorskyblock/overview/addons#nashron-engine)
    * [Rhino Engine](https://wiki.bg-software.com/superiorskyblock/overview/addons#rhino-engine)
    * [GraalVM Engine](https://wiki.bg-software.com/superiorskyblock/overview/addons#graalvm-engine)

## Supported Plugins

### Spawners Providers

The plugins listed below will have their correct spawner-types calculated towards top value, as well respecting of stacked spawners.

* [AdvancedSpawners](https://www.spigotmc.org/resources/75458/)
* [EpicSpawners](https://songoda.com/marketplace/product/13)
* [MergedSpawner](https://polymart.org/resource/189)
* [RoseStacker](https://www.spigotmc.org/resources/82729/)
* [SilkSpawners](https://www.spigotmc.org/resources/7811/)
* [UltimateStacker](https://songoda.com/marketplace/product/16)
* [WildStacker](https://bg-software.com/wildstacker/)

### Skins Providers

The plugins listed below will be used to get skins of players for player heads inside menus.

* [ChangeSkin](https://www.spigotmc.org/resources/21469/)
* [SkinsRestorer](https://www.spigotmc.org/resources/2124/)

### AFK Providers

The plugins listed below will be used to indicate afk players.

* [CMI](https://www.spigotmc.org/resources/3742/)
* [Essentials](https://www.spigotmc.org/resources/9089/)

### Vanish Providers

The plugins listed below will be used to indicate vanished players. Vanished players will not be shown in online status, online placeholders, etc.

* [CMI](https://www.spigotmc.org/resources/3742/)
* [Essentials](https://www.spigotmc.org/resources/9089/)
* [SuperVanish](https://www.spigotmc.org/resources/1331/)
* [VanishNoPacket](https://dev.bukkit.org/projects/vanish/)

### Permissions Providers

The plugins listed below will have direct usage of their API when checking for permissions of players.

* [LuckPerms](https://www.spigotmc.org/resources/28140/)

### Placeholders Providers

The plugins listed below will have placeholders registered to them.

* [MVdWPlaceholderAPI](https://www.spigotmc.org/resources/11182/)
* [PlaceholderAPI](https://www.spigotmc.org/resources/6245/)

### Stacked Blocks Providers

The plugins listed below will have their stacked blocks calculated towards top value.

* [RoseStacker](https://www.spigotmc.org/resources/82729/)
* [WildStacker](https://bg-software.com/wildstacker/)

### Prices Providers

The plugins listed below can be synced for worth value of blocks.

* [ShopGUIPlus](https://www.spigotmc.org/resources/6515/)

### Additional Plugins

* [CoreProtect](https://www.spigotmc.org/resources/8631/)\
  Stacked blocks will be logged to CoreProtect.
* [JetsMinions](https://www.spigotmc.org/resources/59972/)\
  Minions breaking blocks will automatically get detected.
* [LeaderHeads](https://www.spigotmc.org/resources/2079/)\
  Islands data will be synced with LeaderHeads to display top islands using the plugin.
* [Slimefun](https://github.com/Slimefun/Slimefun4)\
  \- Islands will be protected when trying to access Slimefun machines.\
  \- Android miners will automatically get detected.\
  \- Slimefun machines will get cleared when deleting islands.\
  \- Block placers will automatically get detected.
