Configuration
VoidChest Plugin Configuration Documentation
Overview
This document provides a comprehensive guide to the configuration options for the VoidChest plugin. The configuration file is written in YAML format and allows you to customize various aspects of the plugin's behavior. Below, you will find detailed explanations for each configuration option, along with examples and additional information where necessary.
Configuration File Structure
Detailed Configuration Options
debug
debug
Type: Boolean
Default:
false
Description: Enables or disables debug mode. When enabled, the plugin will output detailed debug information to the console, which can be useful for troubleshooting issues.
Example:
proxy
proxy
Type: Boolean (currently unused)
Default:
false
Description: Enables or disables proxy support. This option is useful if your server is running behind a proxy like BungeeCord.
Example:
secret
secret
Type: String (currently unused)
Default:
"SECRET HERE"
Description: A secret key used for secure communication between the plugin and external services. Replace
"SECRET HERE"
with your actual secret key.Example:
locale
locale
Type: String
Default:
"en_US"
Description: Specifies the language locale for the plugin's messages. The locale should be in this format.
Example:
load delay
load delay
Type: Integer
Default:
2
Description: The number of seconds the plugin should wait before loading data (e.g., void chests, player data). This delay helps ensure that worlds and other plugins are fully loaded before VoidChest attempts to load its data, preventing potential issues.
Example:
experimental features
experimental features
Type: Boolean
Default:
false
Description: Enables or disables experimental features. These features are not fully tested and may be unstable. Use at your own risk.
Example:
metrics
metrics
Type: Boolean
Default:
true
Description: Enables or disables the collection of anonymous usage data. This data helps the developers improve the plugin.
Example:
discord
discord
Type: Boolean (currently unused)
Default:
false
Description: Enables or disables Discord integration. This allows the plugin to send notifications to a Discord server.
Example:
updater
updater
Type: Map
Default:
Description: Configures the plugin updater. When enabled, the plugin will automatically check for updates and notify you if a new version is available.
Example:
commands
commands
Type: Map
Default:
Description: Enables or disables specific commands provided by the plugin. Currently, only the
voidchest
command is configurable.Example:
database
database
Type: Map
Default:
Description: Configures the database type and connection details. The plugin supports multiple database types, including
File
,SQLite
,MySQL
,PostgreSQL
, andMongoDB
.Example:
time format
time format
Type: Map
Default:
Description: Defines the text format for time units. This affects how time is displayed in various parts of the plugin.
Example:
money format
money format
Type: String
Default:
"##.####"
Description: Specifies the format for displaying monetary values. The format string uses
#
to represent digits.Example:
economy
economy
Type: Map
Default:
Description: Configures the economy system used by the plugin. The plugin supports multiple economy plugins, including
Vault
,TheNewEconomy
,VoidChest
, andCustom
.Example:
void chest economy mode
void chest economy mode
Type: String
Default:
"EXP"
Description: Defines the economy mode for void chests. Available modes are
EXP
andLEVELS
.Example:
stacker
stacker
Type: String
Default:
"None"
Description: Specifies the stacker plugin to use for stacking items. Available options include
WildStacker
,UltimateStacker
,SpaceStacker
,RoseStacker
,zItemStacker
,CloudSpawners
, andNone
.Example:
bank
bank
Type: String
Default:
"None"
Description: Specifies the bank plugin to use for handling bank transactions. Available options include
SuperiorSkyblock2
,FabledSkyBlock
,SaberFactions
,MysqlEconomyBank
,RoyaleEconomy
,Custom
, andNone
.Example:
bank tnt
bank tnt
Type: String
Default:
"None"
Description: Specifies the bank plugin to use for handling TNT transactions. Available options include
SaberFactions
,SupremeFactions
,FactionsUUID
,Custom
, andNone
.Example:
hologram
hologram
Type: Map
Default:
Description: Configures the hologram plugin used by the VoidChest. The plugin supports multiple hologram plugins, including
VoidChest
,HolographicDisplays
,Holograms
,CMI
,DecentHolograms
, andFancyHolograms
.Example:
ignore item meta
ignore item meta
Type: Boolean
Default:
true
Description: Determines whether the plugin should ignore item metadata when processing items. If enabled, items with different metadata (e.g., enchantments, lore) will be treated as the same item.
Example:
single task
single task
Type: Boolean
Default:
false
Description: Specifies whether all void chests should share a single sell interval. If set to
false
, each void chest can have its own sell interval.Example:
sell interval
sell interval
Type: Integer
Default:
10
Description: The interval (in seconds) at which void chests will sell items. This value is used if the interval is not specified in the void chest's configuration file or if
single task
is enabled.Example:
chunk see
chunk see
Type: Map
Default:
Description: Configures the visibility and effects of chunks. The
Y central
,Y up
, andY down
values determine the vertical range of chunk visibility. Theeffect
section configures the visual effect displayed in the chunks.Example:
sell message
sell message
Type: Map
Default:
Description: Configures the messages displayed when void chests sell items. The
enabled
option determines whether sell messages are shown. Theinterval
specifies the interval (in seconds) between sell messages. Theoffline
section configures messages for offline players.Example:
Last updated