Configuration

The configuration file for Nexal Backpacks. Located at plugins/Nexal Backpacks/config.yml.

config.yml

# Nexal Backpacks Configuration

# Storage settings
# To move data between JSON and SQL: /backpack admin export, change the type,
# restart the server, then /backpack admin import.
storage:
  type: json  # json (plugins/NexalBackpacks/data.json) or sql (MySQL/MariaDB)
  # Connection used when type is sql
  sql:
    host: localhost       # Database server address
    port: 3306            # Database server port
    database: minecraft   # Database (schema) the tables are created in
    username: root        # Database user
    password: ""          # Database password

# Auto-pickup settings
auto-pickup:
  # Combine multiple pickup notifications into one
  batch-notifications: true
  # Delay in ticks before sending batch notification (1 second = 20 ticks)
  batch-delay-ticks: 10

# Menu sounds are set in messages.yml (backpack-opened, backpack-closed, ...)

# Backpack types
# Each type defines a unique backpack with specific properties:
#   display-name        Item name (MiniMessage)
#   material            Item material
#   custom-model-data   Optional: custom model data for a resource pack model (0 = none)
#   lore                Item lore; %slots% shows the capacity
#   slots               Capacity, 1 to 540 (menus show 45 slots per page)
#   soulbound           Kept in the inventory on death
#   auto-pickup-default Whether auto-pickup starts enabled on a new backpack
#   whitelist           If not empty, only these materials are accepted
#   blacklist           These materials are never accepted
#   recipe              Crafting recipe (shaped or shapeless)
types:
  # Small backpack - basic starter backpack
  small:
    display-name: "<green>Small Backpack</green>"
    material: LEATHER
    lore:
      - "<gray>A compact storage solution</gray>"
      - "<gray>Capacity:</gray> <white>%slots% slots</white>"
      - ""
      - "<yellow>Right-click to open</yellow>"
    slots: 9
    soulbound: false
    auto-pickup-default: false
    whitelist: []  # Empty = all items allowed
    blacklist:
      - BEDROCK
      - BARRIER
      - COMMAND_BLOCK
      - CHAIN_COMMAND_BLOCK
      - REPEATING_COMMAND_BLOCK
    recipe:
      enabled: true
      type: shaped
      shape:
        - "LLL"
        - "LCL"
        - "LLL"
      ingredients:
        L: LEATHER
        C: CHEST

  # Medium backpack - standard storage
  medium:
    display-name: "<gold>Medium Backpack</gold>"
    material: CHEST
    lore:
      - "<gray>A standard backpack</gray>"
      - "<gray>Capacity:</gray> <white>%slots% slots</white>"
      - ""
      - "<yellow>Right-click to open</yellow>"
    slots: 27
    soulbound: false
    auto-pickup-default: false
    whitelist: []
    blacklist:
      - BEDROCK
      - BARRIER
    recipe:
      enabled: true
      type: shaped
      shape:
        - "III"
        - "IBI"
        - "III"
      ingredients:
        I: IRON_INGOT
        B: CHEST

  # Large backpack - advanced storage
  large:
    display-name: "<aqua><bold>Large Backpack</bold></aqua>"
    material: ENDER_CHEST
    lore:
      - "<gray>A spacious backpack</gray>"
      - "<gray>Capacity:</gray> <white>%slots% slots</white>"
      - ""
      - "<yellow>Right-click to open</yellow>"
    slots: 45
    soulbound: false
    auto-pickup-default: false
    whitelist: []
    blacklist: []
    recipe:
      enabled: true
      type: shaped
      shape:
        - "DDD"
        - "DBD"
        - "DDD"
      ingredients:
        D: DIAMOND
        B: ENDER_CHEST

  # Ender backpack - soulbound premium backpack
  ender:
    display-name: "<dark_purple><bold>Ender Backpack</bold></dark_purple>"
    material: ENDER_EYE
    lore:
      - "<gray>Bound to your soul</gray>"
      - "<gray>Capacity:</gray> <white>%slots% slots</white>"
      - ""
      - "<light_purple><italic>Soulbound - Kept on death</italic></light_purple>"
      - ""
      - "<yellow>Right-click to open</yellow>"
    slots: 54
    soulbound: true
    auto-pickup-default: true
    whitelist: []
    blacklist: []
    recipe:
      enabled: true
      type: shaped
      shape:
        - "OEO"
        - "EBE"
        - "OEO"
      ingredients:
        O: OBSIDIAN
        E: ENDER_PEARL
        B: ENDER_CHEST

  # Mining backpack - specialized for ores
  mining:
    display-name: "<red><bold>Mining Backpack</bold></red>"
    material: DIAMOND_PICKAXE
    lore:
      - "<gray>Specialized for mining</gray>"
      - "<gray>Capacity:</gray> <white>%slots% slots</white>"
      - ""
      - "<gray>Stores:</gray> <white>Ores, Deepslate, Stone</white>"
      - "<green>Auto-pickup enabled by default</green>"
      - ""
      - "<yellow>Right-click to open</yellow>"
    slots: 36
    soulbound: false
    auto-pickup-default: true
    whitelist:
      # Ores
      - COAL_ORE
      - DEEPSLATE_COAL_ORE
      - IRON_ORE
      - DEEPSLATE_IRON_ORE
      - COPPER_ORE
      - DEEPSLATE_COPPER_ORE
      - GOLD_ORE
      - DEEPSLATE_GOLD_ORE
      - REDSTONE_ORE
      - DEEPSLATE_REDSTONE_ORE
      - EMERALD_ORE
      - DEEPSLATE_EMERALD_ORE
      - LAPIS_ORE
      - DEEPSLATE_LAPIS_ORE
      - DIAMOND_ORE
      - DEEPSLATE_DIAMOND_ORE
      - NETHER_GOLD_ORE
      - NETHER_QUARTZ_ORE
      - ANCIENT_DEBRIS
      # Raw materials
      - RAW_IRON
      - RAW_COPPER
      - RAW_GOLD
      - COAL
      - DIAMOND
      - EMERALD
      - LAPIS_LAZULI
      - REDSTONE
      - QUARTZ
      # Stone types
      - COBBLESTONE
      - STONE
      - DEEPSLATE
      - COBBLED_DEEPSLATE
      - GRANITE
      - DIORITE
      - ANDESITE
      - TUFF
      - CALCITE
      - AMETHYST_SHARD
    blacklist: []
    recipe:
      enabled: true
      type: shaped
      shape:
        - "IPI"
        - "IBI"
        - "III"
      ingredients:
        I: IRON_INGOT
        P: DIAMOND_PICKAXE
        B: CHEST

  # Farming backpack - specialized for crops
  farming:
    display-name: "<dark_green><bold>Farming Backpack</bold></dark_green>"
    material: GOLDEN_HOE
    lore:
      - "<gray>Specialized for farming</gray>"
      - "<gray>Capacity:</gray> <white>%slots% slots</white>"
      - ""
      - "<gray>Stores:</gray> <white>Crops & Seeds</white>"
      - "<green>Auto-pickup enabled by default</green>"
      - ""
      - "<yellow>Right-click to open</yellow>"
    slots: 36
    soulbound: false
    auto-pickup-default: true
    whitelist:
      # Crops
      - WHEAT
      - CARROT
      - POTATO
      - BEETROOT
      - MELON_SLICE
      - PUMPKIN
      - SUGAR_CANE
      - COCOA_BEANS
      - NETHER_WART
      - SWEET_BERRIES
      - GLOW_BERRIES
      - CACTUS
      - BAMBOO
      - KELP
      # Seeds
      - WHEAT_SEEDS
      - BEETROOT_SEEDS
      - MELON_SEEDS
      - PUMPKIN_SEEDS
      - TORCHFLOWER_SEEDS
      - PITCHER_POD
      # Flowers
      - DANDELION
      - POPPY
      - BLUE_ORCHID
      - ALLIUM
      - AZURE_BLUET
      - RED_TULIP
      - ORANGE_TULIP
      - WHITE_TULIP
      - PINK_TULIP
      - OXEYE_DAISY
      - CORNFLOWER
      - LILY_OF_THE_VALLEY
      - SUNFLOWER
      - LILAC
      - ROSE_BUSH
      - PEONY
    blacklist: []
    recipe:
      enabled: true
      type: shaped
      shape:
        - "WHW"
        - "WBW"
        - "WWW"
      ingredients:
        W: WHEAT
        H: GOLDEN_HOE
        B: CHEST

  # Huge backpack - paginated backpack example
  huge:
    display-name: "<yellow><bold>Huge Backpack</bold></yellow>"
    material: SHULKER_BOX
    lore:
      - "<gray>Massive storage capacity</gray>"
      - "<gray>Capacity:</gray> <white>%slots% slots</white>"
      - "<gray>(Uses pagination)</gray>"
      - ""
      - "<yellow>Right-click to open</yellow>"
    slots: 90  # Will use 2 pages
    soulbound: false
    auto-pickup-default: false
    whitelist: []
    blacklist: []
    recipe:
      enabled: true
      type: shaped
      shape:
        - "SSS"
        - "SBS"
        - "SSS"
      ingredients:
        S: SHULKER_SHELL
        B: ENDER_CHEST

Configuration Options

Below is a reference of the main configuration sections:

storage

Nexal Backpacks Configuration

Storage settings To move data between JSON and SQL: /backpack admin export, change the type, restart the server, then /backpack admin import.

auto-pickup

Auto-pickup settings

types

Menu sounds are set in messages.yml (backpack-opened, backpack-closed, ...)

Backpack types Each type defines a unique backpack with specific properties: display-name Item name (MiniMessage) material Item material custom-model-data Optional: custom model data for a resource pack model (0 = none) lore Item lore; %slots% shows the capacity slots Capacity, 1 to 540 (menus show 45 slots per page) soulbound Kept in the inventory on death auto-pickup-default Whether auto-pickup starts enabled on a new backpack whitelist If not empty, only these materials are accepted blacklist These materials are never accepted recipe Crafting recipe (shaped or shapeless)