Skip to main content

VoidChest Type Configuration

๐Ÿงพ Overviewโ€‹

Each VoidChest type is defined by a separate YAML file (e.g., default.yml) located in:

./plugins/VoidChest/voidchests/

You can create new types by duplicating and renaming default.yml (e.g., gold.yml, diamond.yml) and adjusting the configuration as needed.

These configurations allow you to customize VoidChest behavior per type, independently of global plugin settings.


โš™๏ธ Mechanicsโ€‹

OptionTypeDescription
blockStringMinecraft block used for the VoidChest
boosterDoubleBoost multiplier for item value (price * booster * other boosts)
shift click openStringInteraction on shift+right-click (MENU, CHEST, NONE, CONTAINER)
right click openStringInteraction on right-click (MENU, CHEST, NONE, CONTAINER)
enable when owner offlineBooleanWhether chest functions while owner is offline
linksBooleanAllow linking to external containers

๐Ÿšซ Prevent Sectionโ€‹

Control restrictions related to placement and interaction:

OptionTypeDescription
chest near voidchestsBooleanBlock placing chests adjacent to VoidChests
voidchests near chestsBooleanBlock placing VoidChests near normal chests
placing voidchests in same chunkBooleanRestrict multiple VoidChests in the same chunk
creative mode interactionBooleanBlock interaction in Creative Mode
placing other voidchests nearBooleanBlock placing VoidChests near other VoidChests
voidchest from explodingBooleanPrevent explosion destruction (e.g., TNT, creepers)

๐Ÿช“ Break Sectionโ€‹

Configure behavior when VoidChests are broken:

OptionTypeDescription
failed otherBooleanBlock breaking chests owned by others
permission denyBooleanBlock breaking without permission
successfulBooleanNotify player on successful break
store statsBooleanRetain stats when broken/replaced
drop voidchest on explosionBooleanDrop chest if exploded

๐Ÿ“ฆ Placement Optionsโ€‹

OptionTypeDescription
permission denyBooleanBlock placement without permission
successfulBooleanNotify player on successful placement
delay checkBooleanAdvanced delay check before allowing placement
limitIntegerMaximum number of chests a player can place

๐Ÿ”ง Default Featuresโ€‹

These are enabled by default when a new VoidChest is placed:

  • auto sell: Automatically sells items inside the chest
  • purge items: Removes invalid/non-sellable items
  • chunk collector: Collects items from nearby chunks
  • charge: Enables charge/fuel system
  • hologram: Enables floating holographic display
  • bank: Sends income to bank instead of balance

๐Ÿ” Options Sectionโ€‹

Selling & Profitโ€‹

OptionTypeDescription
sell intervalIntegerDelay in ticks between sell attempts
profit calculatorListPlugin priority list for item pricing

Supported plugins: VoidChest, ShopGUIPlus, Essentials, CMI, EconomyShopGUI, DynamicShop, and Custom.


Soundsโ€‹

EventConfig Key
Placesound.place
Breaksound.break
Upgrade Successsound.upgrade.success
Upgrade Failuresound.upgrade.failure

OptionTypeDescription
linksIntegerMax containers linked to this VoidChest

Forced Disable Optionsโ€‹

OptionTypeDescription
auto sell force disableBooleanGlobally disables auto selling
purge items force disableBooleanGlobally disables item purging
bank force disableBooleanGlobally disables banking

Chunk Collectorโ€‹

OptionTypeDescription
modeStringCHUNK or BOUNDINGBOX
force disableBooleanDisables chunk collection entirely
transfer non sellablesBooleanAllow collecting non-sellable items
filtersBooleanEnable/disable filtering system

Inventory Loreโ€‹

Customize item tooltips and inventory display:

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

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 System (Fuel)โ€‹

OptionTypeDescription
force disableBooleanDisables the charge system
break persistentObjectSave charge data when broken
max timeIntegerMaximum charge time in seconds
renewal timeIntegerSeconds added per fuel item
priceIntegerCost of renewing fuel
hologram.no fuelStringPlaceholder when chest runs out of fuel (hologram)
placeholder.no fuelStringPlaceholder when chest runs out of fuel (UI)

โœจ Hologram Displayโ€‹

OptionTypeDescription
force disableBooleanDisables hologram rendering
heightDoubleVertical offset for floating text
textListLines displayed above the chest

Example:

text:
- '&c&l%voidchest% VoidChest'
- '&fOwner: &c%owner%'
- '&fBoost: &b%booster%x'
- '&fMoney made: &a$%money%'

๐ŸŽ Item Settingsโ€‹

OptionTypeDescription
drop straight to inventoryBooleanSend broken item to inventory instead of dropping
nameStringCustom item name
loreListDescription shown in item tooltip
inventory custom nameBooleanShow custom name in inventory
inventory loreListDescription in chest UI (supports MiniMessage/legacy)
inventory links custom nameBooleanShow custom name for links
inventory links loreListDescription in links UI

๐Ÿ›  Creating New VoidChest Typesโ€‹

To define other VoidChest types:

  1. Duplicate default.yml.
  2. Rename the file (e.g., gold.yml).
  3. Customize the contents (e.g., different block, booster, filters, limits).

Each file represents an independent type with its own behavior, permissions, and rules.