💻API Documentation

Welcome to the official bShop API documentation. This guide will help you integrate bShop into your plugins and extend its functionality.

Getting Started

Installation

Add bShop to your project using JitPack:

Maven

<repositories>
    <repository>
        <id>jitpack.io</id>
        <url>https://jitpack.io</url>
    </repository>
</repositories>

<dependency>
    <groupId>com.github.bumpier</groupId>
    <artifactId>bShop</artifactId>
    <version>1.2.0</version>
</dependency>

Gradle

repositories {
    maven { url 'https://jitpack.io' }
}

    dependencies {
            implementation 'com.github.bumpier:bShop:1.2.0'
    }

Plugin Dependencies

Add bShop as a dependency in your plugin.yml:

depend: [bShop]
# or
softdepend: [bShop]

Dependencies

bShop requires the following dependencies:

• Vault - For economy integration

• PlaceholderAPI (optional) - For placeholder support

Basic Usage

Getting the API Instance

import net.bumpier.bshop.BShopAPI;

public class MyPlugin extends JavaPlugin {
    
    private BShopAPI bShopAPI;
    
    @Override
    public void onEnable() {
        // Get the API instance
        bShopAPI = BShopAPI.getInstance();
        
        if (bShopAPI == null) {
            getLogger().severe("bShop not found! Disabling plugin.");
            getServer().getPluginManager().disablePlugin(this);
            return;
        }
        
        getLogger().info("Successfully connected to bShop API!");
    }
}

Accessing Core Components

// Get the main plugin instance
BShop plugin = bShopAPI.getPlugin();

// Get the shop manager
ShopManager shopManager = bShopAPI.getShopManager();

// Get the GUI manager
ShopGuiManager guiManager = bShopAPI.getShopGuiManager();

// Get the transaction service
ShopTransactionService transactionService = bShopAPI.getTransactionService();

// Get the multiplier service
MultiplierService multiplierService = bShopAPI.getMultiplierService();

Methods

Method	Return Type	Description
getInstance()	BShopAPI	Get the API instance
getPlugin()	BShop	Get the main plugin instance
getShopManager()	ShopManager	Get the shop manager
getShopGuiManager()	ShopGuiManager	Get the GUI manager
getTransactionService()	ShopTransactionService	Get the transaction service
getMultiplierService()	MultiplierService	Get the multiplier service

ShopManager

Manages all shops and their configurations.

Methods

Method	Return Type	Description
getShop(String shopId)	Shop	Get a shop by ID
getAllShops()	List<Shop>	Get all loaded shops
loadShops()	void	Reload all shops from configuration

Example

ShopManager shopManager = bShopAPI.getShopManager();

// Get a specific shop
Shop shop = shopManager.getShop("advanced_shop");
if (shop != null) {
    System.out.println("Shop found: " + shop.title());
}

// Get all shops
List<Shop> allShops = shopManager.getAllShops();
for (Shop shop : allShops) {
    System.out.println("Shop: " + shop.id() + " - " + shop.title());
}