Configuration
Configure CoreItems by editing the config.yml at:
Below is a breakdown of every setting in the file, its purpose, and its default value.
1. Namespaces
Controls how and where CoreItems loads your item definitions.
namespaces.enabled Enable or disable the entire namespace system. Default:
true
namespaces.load-on-startup Automatically scan and load every namespace folder on server start. Default:
true
namespaces.default-namespace The fallback namespace used when a command or reference omits one. Default:
"default"
namespaces.directory The name of the folder under
plugins/CoreItems/
where namespace folders live. Default:"customs"
2. Commands
Customize the main command and its aliases.
commands.main-command The root command players and admins will use. Default:
"coreitems"
commands.aliases Alternative names for the same root command (comma-separated list). Default:
["citems", "cit", "core", "cm"]
3. Item Interactions
Global settings that affect how custom items behave when used.
item-interactions.global-cooldown Minimum delay (in milliseconds) between any two item-triggered actions. This can be overridden per-item in your
customs.yml
with thecooldown
property. Default:500
Cooldown-message
Configures if the cooldown-message is enabled, what the message is, and the interval between sending it.
4. GUI Menu
Settings for the in-game browser that lets players view and obtain custom items.
gui.enabled Turn the GUI menu system on or off. Default:
true
gui.main-menu-title The window title for the namespace selection screen. Supports Minecraft color codes and the literal text
CoreItems: Namespaces
. Default:"CoreItems: Namespaces"
gui.items-menu-title The window title for the item browser inside each namespace. Use
{namespace}
to inject the current namespace name. Default:"CoreItems: {namespace}"
gui.border-item Material used to fill empty slots around the GUI border. Set to any valid Minecraft item (or
NONE
for no border). Default:"BLACK_STAINED_GLASS_PANE"
gui.namespaces-per-page How many namespace icons to display per page in the main menu. Default:
14
gui.items-per-page How many item icons to display per page in each namespace. Default:
21
5. Search Functionality
Enable and configure the built-in search feature.
search.enabled Turn the search button and menu on or off. Default:
true
search.timeout How many seconds the search input remains active before closing. Default:
30
search.button-material The item used as the “search” button in GUIs (e.g., signs, compasses). Default:
"OAK_SIGN"
search.results-title The title for the search results window. Use
{query}
to show the user’s search term. Default:"Search Results: {query}"
6. Player Data
Configure if the plugin should save item data of each player's items.
enabled
Enable saving player data.
Default: true
auto_scan
enabled Enable automatic scanning player items at a set interval
interval Interval between automatic scans.
Applying Your Changes
After saving any edits to config.yml, run:
in-game or from console to apply changes immediately. Check the server console for success or error messages whenever you reload.
Last updated