VoidChest Configuration Documentation

This document provides a comprehensive guide to configuring the default.yml file for the VoidChest plugin. Each voidchest type must have its own YAML file (e.g., default.yml, Supreme.yml, Epic.yml, etc.). Below is a detailed explanation of each option available in the default.yml file, along with examples and additional information.

Table of Contents

1. Mechanics

2. Options

3. Inventory

4. Charge

5. Hologram

6. Item

---

Mechanics

block

• Description: Specifies the type of block that represents the voidchest.

• Type: String

• Default: CHEST

• Example:

  block: CHEST

booster

• Description: A multiplier that applies to the total income generated by the voidchest.

• Type: Float

• Default: 1.0

• Formula: (ItemPrice * boost * other boosts...)

• Example:

  booster: 1.0

shift click open

• Description: Defines the action when a player shift-clicks the voidchest.

• Type: String

• Available Modes: MENU, CHEST, NONE, CONTAINER

• Default: CHEST

• Example:

  shift click open: CHEST

right click open

• Description: Defines the action when a player right-clicks the voidchest.

• Type: String

• Available Modes: MENU, CHEST, NONE, CONTAINER

• Default: MENU

• Example:

  right click open: MENU

enable when owner offline

• Description: Determines if the voidchest should operate when the owner is offline.

• Type: Boolean

• Default: true

• Example:

  enable when owner offline: true

paginated inventory

• Description: Specifies whether the inventory should be paginated.

• Type: Boolean

• Default: false

• Example:

  paginated inventory: false

links

• Description: Determines if the voidchest can have container links.

• Type: Boolean

• Default: false

• Example:

  links: false

prevent

• Description: Configures various prevention settings for voidchest placement and interaction.

chest near voidchests

• Description: Prevents players from placing a chest next to other voidchests.

• Type: Boolean

• Default: false

• Example:

  chest near voidchests: false

voidchests near chests

• Description: Prevents players from placing a voidchest next to other chests.

• Type: Boolean

• Default: false

• Example:

  voidchests near chests: false

placing voidchests in same chunk

• Description: Prevents players from placing a voidchest in the same chunk as other voidchests.

• Type: Boolean

• Default: true

• Example:

  placing voidchests in same chunk: true

creative mode interaction

• Description: Prevents players from interacting with voidchests while in creative mode.

• Type: Boolean

• Default: true

• Example:

  creative mode interaction: true

placing other voidchests near

• Description: Prevents players from placing other voidchests near the current voidchest.

• Type: Boolean

• Default: false

• Example:

  placing other voidchests near: false

voidchest from exploding

• Description: Prevents voidchests from exploding.

• Type: Boolean

• Default: false

• Example:

  voidchest from exploding: false

break

• Description: Configures messages and behaviors when a voidchest is broken.

failed other

• Description: Sent when a player breaks a voidchest that belongs to someone else without permission.

• Type: Boolean

• Default: true

• Example:

  failed other: true

permission deny

• Description: Sent when a player attempts to break a voidchest without permission.

• Type: Boolean

• Default: true

• Example:

  permission deny: true

successful

• Description: Sent when a player successfully breaks a voidchest.

• Type: Boolean

• Default: true

• Example:

  successful: true

store stats

• Description: Stores statistics when a voidchest is broken and recovers them when placed again.

• Type: Boolean

• Default: false

• Example:

  store stats: false

drop voidchest on explosion

• Description: Determines if voidchests drop when exploded.

• Type: Boolean

• Default: false

• Example:

  drop voidchest on explosion: false

place

• Description: Configures messages and behaviors when a voidchest is placed.

permission deny

• Description: Sent when a player places a voidchest without permission.

• Type: Boolean

• Default: true

• Example:

  permission deny: true

successful

• Description: Sent when a player successfully places a voidchest.

• Type: Boolean

• Default: true

• Example:

  successful: true

delay check

• Description: Delays the check when placing a voidchest.

• Type: Boolean

• Default: false

• Example:

  delay check: false

limit

• Description: Limits the number of voidchests a player can place.

• Type: Integer

• Default: 5

• Example:

  limit: 5

auto sell

• Description: Enables or disables auto sell for a new voidchest by default.

• Type: Boolean

• Default: true

• Example:

  auto sell: true

purge items

• Description: Enables or disables the purge invalid items for a new voidchest by default.

• Type: Boolean

• Default: true

• Example:

  purge items: true

chunk collector

• Description: Enables or disables the chunk collector for a new voidchest by default.

• Type: Boolean

• Default: true

• Example:

  chunk collector: true

charge

• Description: Enables or disables the charge system for a new voidchest by default.

• Type: Boolean

• Default: true

• Example:

  charge: true

hologram

• Description: Enables or disables the hologram for a new voidchest by default.

• Type: Boolean

• Default: true

• Example:

  hologram: true

bank

• Description: Enables or disables the bank for a new voidchest by default.

• Type: Boolean

• Default: false

• Example:

  bank: false

---

Options

sell interval

• Description: Specifies how often the voidchest should attempt to sell items.

• Type: Integer

• Default: 10

• Example:

  sell interval: 10

profit calculator

• Description: Defines the priority of profit calculators.

• Type: List

• Default:

  profit calculator:
    - "VoidChest:1"
    # - "ShopGUIPlus:2"
    # - "Essentials:3"
    # - "CMI:4"
    # - "EconomyShopGUI:5"
    # - "DynamicShop:6"

sound

• Description: Configures sounds played when a voidchest is placed or broken.

place

• Description: Sound played when a voidchest is placed.

• Type: String

• Default: LEVEL_UP

• Example:

  place: 'LEVEL_UP'

break

• Description: Sound played when a voidchest is broken.

• Type: String

• Default: ANVIL_BREAK

• Example:

  break: 'ANVIL_BREAK'

upgrade

• Description: Sounds played during voidchest upgrades.

success

• Description: Sound played when an upgrade is successful.

• Type: String

• Default: ORB_PICKUP

• Example:

  success: 'ORB_PICKUP'

failure

• Description: Sound played when an upgrade fails.

• Type: String

• Default: VILLAGER_NO

• Example:

  failure: 'VILLAGER_NO'

links

• Description: Maximum number of links a voidchest can have.

• Type: Integer

• Default: 3

• Example:

  links: 3

auto sell force disable

• Description: Forcefully disables the auto sell system.

• Type: Boolean

• Default: false

• Example:

  auto sell force disable: false

purge items force disable

• Description: Forcefully disables the purge items system.

• Type: Boolean

• Default: false

• Example:

  purge items force disable: false

bank force disable

• Description: Forcefully disables the bank system.

• Type: Boolean

• Default: false

• Example:

  bank force disable: false

chunk collector

• Description: Configures the chunk collector settings.

mode

• Description: Specifies the mode of the chunk collector.

• Type: String

• Available Modes: CHUNK, BOUNDINGBOX

• Default: CHUNK

• Example:

  mode: CHUNK

force disable

• Description: Forcefully disables the chunk collector.

• Type: Boolean

• Default: false

• Example:

  force disable: false

transfer non sellables

• Description: Enables or disables the transfer of non-sellable items.

• Type: Boolean

• Default: false

• Example:

  transfer non sellables: false

instant collector

• Description: Configures the instant chunk collector.

enabled

• Description: Enables or disables the instant chunk collector.

• Type: Boolean

• Default: false

• Example:

  enabled: false

force disable

• Description: Forcefully disables the instant chunk collector.

• Type: Boolean

• Default: false

• Example:

  force disable: false

filters

• Description: Configures the filter settings.

allow mode

• Description: Enables or disables the allow mode for filters.

• Type: Boolean

• Default: false

• Example:

  allow mode: false

user allow mode

• Description: Allows players to set the filter to allow mode.

• Type: Boolean

• Default: false

• Example:

  user allow mode: false

force disable allow mode

• Description: Forcefully disables the allow mode.

• Type: Boolean

• Default: false

• Example:

  force disable allow mode: false

force disable

• Description: Forcefully disables the filter system.

• Type: Boolean

• Default: false

• Example:

  force disable: false

---

Inventory

title

• Description: Title of the voidchest inventory.

• Type: String

• Default: "&c&l%voidchest% Inventory (%currentPage%)"

• Example:

  title: "&c&l%voidchest% Inventory (%currentPage%)"

size

• Description: Size of the voidchest inventory.

• Type: Integer

• Available Sizes: 9, 18, 27, 36, 45, 54

• Default: 27

• Example:

  size: 27

paginated inventory

• Description: Configures the paginated inventory settings.

max pages

• Description: Maximum number of pages in the paginated inventory.

• Type: Integer

• Default: 5

• Example:

  max pages: 5

slots

• Description: Configures the slots in the paginated inventory.

0

• Description: Configures the first slot.

• Type: Map

• Example:

  '0':
    name: "&a&lBack"
    item: "PLAYER_HEAD"
    skull property: "eyJ0ZXh0dXJlcyI6eyJTS0lOIjp7InVybCI6Imh0dHA6Ly90ZXh0dXJlcy5taW5lY3JhZnQubmV0L3RleHR1cmUvOTIxMjE3ZDdmZWU5ZmFmMmZiYzc0MWUwYWRiNWRlNmE4NGVhN2Q1NTM2Y2JjY2QxZGJjOGEzMjNmOTViOTkwZCJ9fX0="
    action: "PREVIOUS_PAGE"
    lores:
      - "&7Go back to the previous page."

4

• Description: Configures the fifth slot.

• Type: Map

• Example:

  '4':
    name: "&c&lClose Menu"
    item: "PLAYER_HEAD"
    skull property: "eyJ0ZXh0dXJlcyI6eyJTS0lOIjp7InVybCI6Imh0dHA6Ly90ZXh0dXJlcy5taW5lY3JhZnQubmV0L3RleHR1cmUvNDQ2NjRlZGVhNzAxOTMzMjZhYTMxZjhmNTBmODBjMjkzN2I1YThmMDczNThhNWIwODQ5ZGRmNWI1YjJjOGMzNiJ9fX0="
    action: "CLOSE"
    lores:
      - "&7Close the VoidChest inventory."

8

• Description: Configures the ninth slot.

• Type: Map

• Example:

  '8':
    name: "&a&lNext"
    item: "PLAYER_HEAD"
    skull property: "eyJ0ZXh0dXJlcyI6eyJTS0lOIjp7InVybCI6Imh0dHA6Ly90ZXh0dXJlcy5taW5lY3JhZnQubmV0L3RleHR1cmUvMjc2YjM5NmEzNDZmYmQ1ZGM5OGRmOWMwNjA5N2JiNTkxZmVmZDc2OGVkNWIzYmI5MGJiMzJhZjg1ZWI5MTQwNiJ9fX0="
    action: "NEXT_PAGE"
    lores:
      - "&7Go to the next page."

shop item lore

• Description: Lore for shop items.

• Type: List

• Default:

  shop item lore:
    - '&7Price:&r &a$%price%'

filter item lore

• Description: Lore for filter items.

• Type: List

• Default:

  filter item lore:
    - "&7Amount:&r &a%amount%"
    - "&7Allow:&r &a%allow%"
    - "&7Ignore Item Metadata:&r &a%ignoreMetadata%"
    - "&7Ignore Item Amount:&r &a%ignoreAmount%"
    - "&8Right Click to Remove"

---

Charge

force disable

• Description: Forcefully disables the charge system.

• Type: Boolean

• Default: false

• Example:

  force disable: false

break persistent

• Description: Configures persistent charge settings when a voidchest is broken.

enabled

• Description: Enables or disables persistent charge.

• Type: Boolean

• Default: false

• Example:

  enabled: false

save time

• Description: Saves the charge time when a voidchest is broken.

• Type: Boolean

• Default: false

• Example:

  save time: false

hologram

• Description: Configures hologram placeholders.

no fuel

• Description: Placeholder text for no fuel.

• Type: String

• Default: 'No Fuel'

• Example:

  no fuel: 'No Fuel'

placeholder

• Description: Configures item placeholders.

no fuel

• Description: Placeholder text for no fuel.

• Type: String

• Default: 'No Fuel'

• Example:

  no fuel: 'No Fuel'

max time

• Description: Maximum charge time.

• Type: Integer

• Default: 172800

• Example:

  max time: 172800

renewal time

• Description: Charge time to be added.

• Type: Integer

• Default: 3600

• Example:

  renewal time: 3600

price

• Description: Charge price.

• Type: Integer

• Default: 20000

• Example:

  price: 20000

---

Hologram

force disable

• Description: Forcefully disables the hologram system.

• Type: Boolean

• Default: false

• Example:

  force disable: false

height

• Description: Height of the hologram.

• Type: Float

• Default: 3.9

• Example:

  height: 3.9

text

• Description: Text displayed on the hologram.

• Type: List

• Default:

  text:
    - '&c&l%voidchest% VoidChest'
    - ''
    - '&fOwner: &c%owner%'
    - '&fBoost: &b%booster%x'
    - '&fMoney made: &a$%money%'
    - '&fItems sold: &3%items_sold%'
    - '&fItems purged: &3%items_purged%'
    - '&fItems stored: &3%items_stored%'
    - '&7VoidChest timeleft: &e%timeleft%'
    - '&7VoidChest charge: &e%charge_hologram%'
    - ''
    - '&7&oRight-Click to Open VoidChest'

---

Item

drop straight to inventory

• Description: Determines if the voidchest item should drop directly into the player's inventory when broken.

• Type: Boolean

• Default: false

• Example:

  drop straight to inventory: false

name

• Description: Name of the voidchest item.

• Type: String

• Default: '&c&l%voidchest% VoidChest'

• Example:

  name: '&c&l%voidchest% VoidChest'

lore

• Description: Lore of the voidchest item.

• Type: List

• Default:

  lore:
    - '&7Automatically sell and or clear items that'
    - '&7are inside this voidchest. Gain money while being afk!'

---