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 integrates with Vault to provide economy functionality for island banks, allowing players to deposit and withdraw money from their island’s shared bank account.

Overview

The Vault integration enables:
  • Island Bank System - Shared economy accounts for islands
  • Deposit & Withdrawal - Transfer money between personal and island banks
  • Transaction Validation - Automatic error handling and balance limits
  • Multi-Economy Support - Works with any Vault-compatible economy plugin

Setup

1

Install Vault

Download Vault from SpigotMC and place it in your plugins folder.
2

Install Economy Plugin

Install a Vault-compatible economy plugin such as:
  • EssentialsX
  • CMI
  • CraftConomy
  • Any other Vault economy provider
3

Restart Server

Restart your server to load all plugins.
4

Verify Integration

Check your console for:
[SuperiorSkyblock2] Using Vault as an economy provider.
Vault alone does not provide economy functionality. You must install a separate economy plugin that Vault can hook into (like EssentialsX).

Features

Island Bank

Each island has a shared bank account that all members can access based on their permissions. Commands:
  • /is bank - Open the island bank interface
  • /is deposit <amount> - Deposit money into the island bank
  • /is withdraw <amount> - Withdraw money from the island bank
  • /is balance - Check the island bank balance
Permissions:
  • superior.island.deposit - Deposit money
  • superior.island.withdraw - Withdraw money
  • superior.island.balance - View balance

Transaction Handling

The Vault integration includes robust transaction processing:
Player accounts are automatically created if they don’t exist when accessing the economy system.
Transactions respect bank limits configured per island:
  • Configurable maximum bank capacity
  • Upgrade-based limit increases
  • Permission-based limit bonuses
Clear error messages for:
  • Insufficient funds
  • Bank capacity exceeded
  • Transaction failures
  • Invalid amounts
All transactions use 3 decimal place precision to ensure accurate balance tracking.

Configuration

Bank Settings

Configure island bank behavior in config.yml:
config.yml
islands:
  bank:
    # Default bank limit for new islands
    default-limit: 1000000.0
    
    # Enable bank interest payments
    interest:
      enabled: true
      percentage: 5.0
      interval: 3600  # seconds

Bank Limit Upgrades

Define bank limit upgrades in upgrades.yml:
upgrades.yml
bank-limit:
  levels:
    1:
      cost: 10000
      commands: []
      permission: ''
      price-multiplier: 2.0
      bank-limit: 5000000.0
    2:
      cost: 50000
      bank-limit: 10000000.0

Admin Commands

Manage island economies with admin commands:
# Deposit money into an island's bank
/is admin deposit <player> <amount>

# Withdraw money from an island's bank  
/is admin withdraw <player> <amount>

# Set an island's bank limit
/is admin setbanklimit <player> <limit>

# Add to an island's bank limit
/is admin addbanklimit <player> <amount>
Required Permission: superior.admin.*

API Usage

Developers can interact with the Vault economy integration:

Getting the Economy Provider

import com.bgsoftware.superiorskyblock.api.SuperiorSkyblockAPI;
import com.bgsoftware.superiorskyblock.api.hooks.EconomyProvider;
import com.bgsoftware.superiorskyblock.api.wrappers.SuperiorPlayer;
import java.math.BigDecimal;

SuperiorPlayer player = SuperiorSkyblockAPI.getPlayer(uuid);
EconomyProvider economy = SuperiorSkyblockAPI.getHookManager().getEconomyProvider();

// Get player's balance
BigDecimal balance = economy.getBalance(player);

// Deposit money
EconomyProvider.EconomyResult depositResult = economy.depositMoney(player, 1000.0);
if (depositResult.getErrorMessage() == null) {
    // Success
    double deposited = depositResult.getTransactionMoney();
} else {
    // Error occurred
    String error = depositResult.getErrorMessage();
}

// Withdraw money
EconomyProvider.EconomyResult withdrawResult = economy.withdrawMoney(player, 500.0);
if (withdrawResult.getErrorMessage() == null) {
    // Success
    double withdrawn = withdrawResult.getTransactionMoney();
}

Island Bank Operations

import com.bgsoftware.superiorskyblock.api.island.Island;
import com.bgsoftware.superiorskyblock.api.island.bank.IslandBank;

Island island = player.getIsland();
IslandBank bank = island.getIslandBank();

// Get bank balance
BigDecimal balance = bank.getBalance();

// Deposit to bank
bank.depositMoney(1000.0);

// Withdraw from bank
bank.withdrawMoney(500.0);

// Get bank limit
BigDecimal limit = island.getBankLimit();

Economy Placeholders

Display economy information with PlaceholderAPI:
PlaceholderDescriptionExample
%superior_island_bank%Formatted bank balance1,234,567
%superior_island_bank_format%Fancy formatted balance1.23M
%superior_island_bank_int%Balance as integer1234567
%superior_island_bank_raw%Raw balance value1234567.89
%superior_island_bank_limit%Formatted bank limit10,000,000
%superior_island_bank_limit_format%Fancy formatted limit10M
%superior_island_bank_next_interest%Time until next interest5h 30m
%superior_island_bank_last_interest%Time since last interest30m ago
See PlaceholderAPI Integration for more details.

Supported Economy Plugins

Any Vault-compatible economy plugin works with SuperiorSkyblock2:

EssentialsX

Most popular economy plugin with extensive features

CMI

All-in-one plugin with built-in economy

CraftConomy

Multi-currency economy system

iConomy

Classic economy plugin

Troubleshooting

Issue: Console doesn’t show Vault integration messageSolutions:
  • Ensure Vault is installed and enabled (/plugins)
  • Verify an economy plugin is installed
  • Check that the economy plugin registered with Vault
  • Restart the server in the correct order: Vault → Economy → SuperiorSkyblock2
Issue: Transactions fail with errorsSolutions:
  • Check player has sufficient funds for deposits
  • Verify island bank hasn’t reached its limit
  • Ensure player has the required permissions
  • Check the economy plugin is functioning (/balance)
Issue: Can deposit beyond configured limitSolutions:
  • Check config.yml for correct bank limit settings
  • Verify upgrade levels are configured properly
  • Ensure raw_bank_limit values are set correctly
  • Use /is admin setbanklimit to manually set limits
Issue: Money values don’t match expected amountsSolutions:
  • SuperiorSkyblock2 uses 3 decimal precision
  • Check if the economy plugin has different precision
  • Verify no other plugins are interfering with transactions
  • Review transaction logs for rounding issues

Best Practices

Set Appropriate Limits

Configure bank limits to match your server’s economy scale and prevent inflation.

Enable Interest

Use bank interest to encourage players to save money in their island banks.

Tiered Upgrades

Create progressive bank limit upgrades to give players long-term goals.

Monitor Transactions

Regularly review bank transactions to detect exploits or economy issues.

Build docs developers (and LLMs) love