Configuration Files

These are the configuration files generated by default when the newest version of Custom Items first launches.

config.yml armor.yml inventories.yml

config.yml

# The prefix for messages sent to players on your server
#
# default: "[CustomItems]"
prefix: "[CustomItems]"


# Minecraft items that are excluded from the permissions
# customitem.info.native and customitem.inspect.native
# this should likely be set to nothing, but is currently
# set to diamond and emerald as an example.
nativeItemPermissionExclusions:
  - DIAMOND
  - EMERALD


# How custom blocks can be stored. Valid options are "CustomItems", "sqlite", "mysql", and "yaml"
#
# --
# "CustomItems" will store all custom blocks in CustomItem's custom block storage. THIS IS WHAT YOU SHOULD BE USING.
# THIS REQUIRES NO ADDITIONAL SETUP
# --
#
# --
# "yaml" will store all custom blocks in the file blocks.yml. THIS IS NOT RECOMMENDED.
# YAML IS MUCH SLOWER THAN SQLITE, AND SQLITE TAKES NO ADDITIONAL SETUP.
# SLOWEST OPTION
# --
#
# --
# "sqlite" will store all custom blocks in an SQLite database.
# THIS IS MUCH BETTER THAN YAML, but you should use "CustomItems" instead
# MEDIUM-SPEED OPTION
# --
#
# --
# "mysql" will store all custom blocks in a MySQL database. You
# must provide the credentials for this database below under blockStorageMySQL
# ONLY USE THIS IF YOU NEED TO HAVE YOUR BLOCKS IN A MySQL DATABASE
#
# IF YOUR DATABASE DOESN'T HAVE ENOUGH MEMORY (RAM), OR A GOOD CONNECTION,
# THIS CAN AND WILL SLOW DOWN YOUR SERVER, A LOT
# --
#
# If you were previously using YAML storage and would like to switch to MySQL,
# change this to MySQL and enter the information under blockStorageMySQL below.
# Then, restart your server, and run the command "customitems blockstorage migrate YAML MySQL" FROM THE CONSOLE.
# Once you verify that you would like to migrate from YAML to MySQL, everything will be migrated.
# Likewise, to migrate from MySQL to YAML, run "customitems blockstorage migrate MySQL YAML" from the console.
# Be careful! Migrating will slow down your server a lot, and could crash it if you don't have enough RAM allocated.
#
# Likewise, to migrate from YAML to SQLite, you can run "customitems blockstorage migrate YAML SQLite"
# And from SQLite to MySQL you can use "customitems blockstorage migrate SQLite MySQL"
#
# default: CustomItems
blockStorageFormat: CustomItems

# Information about the SQLite database for storing blocks
# This is only used when blockStorageFormat above is set to "sqlite"
# You don't need too change any of these values, if you don't want to
blockStorageSQLite:
  database: CustomItems
  table: CustomItemBlocks

# Information about the MySQL Server for storing blocks
# This is only used if blockStorageFormat above is set to "mysql"
blockStorageMySQL:
  #IP, port, and credentials to connect to the MySQL server
  ip: localhost
  port: 3306
  username: username
  password: password

  # The database and table to store the custom items
  database: database
  table: CustomItemsBlocks

  # The number of times to reconnect to the database after
  # the connection fails or times out.
  #
  # If you experience errors with your MySQL server timing
  # out, you should increase this number.
  #
  # Default: 4
  maxReconnects: 4


# Set to true if you want your server to crash if one of your item yml files is invalid
# This is NOT RECOMMENDED, and should only be used when a custom item being
# treated as a normal Minecraft item, or one of the custom items not working,
# would have dire consequences.
#
# default: false
forceCrashOnInvalidItem: false


# Set to true if you want your server to crash if it can not connect to your MySQL server.
# This is NOT RECOMMENDED, and should only be used when a custom block being
# treated as a normal Minecraft block, or one of the custom blocks not working
# would have dire consequences.
#
# default: false
forceCrashOnInvalidMySQL: false

# Set to true if you want your server to crash if CustomItems can't load a block storage file
# This is NOT RECOMMENDED, and should only be used when a custom block being
# treated as a normal Minecraft block, or one of the custom blocks not working
# would have dire consequences.
#
# default: false
forceCrashOnInvalidBlockStorage: true

# The language the plugin should use (some things may still be in english)
# Valid languages as of now are "en" (english), "cn" (chinese), "tk" (turkish), "fr" (french), "it" (italian), "de" (german), and "cz" (czech)
#
# default: en
language: en

# Only has an effect for Minecraft versions 1.14 and up
#
# Before Minecraft 1.14, custom textures were added to items by giving
# the items a custom damage value. However, in Minecraft 1.14, a new, better
# way to do this was introduced. Set this to true if you want to use the old,
# pre- Minecraft 1.14 resource pack format.
# It is recommended that you keep this as "false";
#
# default: false
useOldResourcePackFormat: false


# Whether or not to force the user to download your server's resource pack
#
# Set this to true to automatically kick players from your server if they
# decline or your resource pack or the download fails.
# Keep in mind that this may have an adverse effect on your playerbase.
#
# Players with the permission customitems.resourcepack.ignore will not
# be kicked
#
# default: false
forceResourcePack: false

# The message to send when a player declines your server's
# Resource pack. You can use &color codes
#
# default: "You must accept the resource pack request"
resourcePackDeclinedKickMessage: "You must accept the resource pack request"

# The message to send when a player accepts your server's
# resource pack, but the download fails. You can use &color codes
#
# default: "The resource pack did not successfully download. Please check your internet connection and try again in a few seconds. If you believe this is an error, please contact the server administrators."
resourcePackDownloadFailedKickMessage: "The resource pack did not successfully download. Please check your internet connection and try again in a few seconds. If you believe this is an error, please contact the server administrators."

# Whether or not to enable fallback block textures
#
# Set this to true to and players who do not have your resource pack downloaded
# Will see the fallback Minecraft texture for custom textured blocks
#
# You can set a block's fallback texture under "fallback" in the "texture" section of the "blocks" section in your item yml file
# Like this:
# # in myBlock.yml
# item: #...
# block:
#  texture:
#    textureID: 42
#    fallback: "minecraft:COBBLESTONE"
# end of myBlock.yml
#
# default: false
doFallbackTextures: false

# The default fallback texture for blocks
#
# If "doFallbackTextures" is "true", and a custom-textured block doesn't have a fallback texture,
# players will see the block like this Minecraft block instead.
#
# You can ONLY set this to a Minecraft block (like "minecraft:GOLD_BLOCK" or "minecraft:COBBLESTONE") - it CAN NOT be
# an non-placeable item.
#
# default: NULL
defaultFallbackTexture: NULL

armor.yml

# This file configures your armor categories!
# To set custom armor's category, set "category" to the
# category under "armor" in the item's yml file, like this:
#
# # in items/myArmor.yml
# armor:
#   category: myArmorCategory

# and then add the category in here, like this
#
# categories:
#   myArmorCategory:
#     #... options...
#   myOtherArmorCategory:
#     # ...
#
# See the wiki for more info on configuring this

categories: 
  myArmorCategory:
    # handlers for this armor category
    handlers:
  
      # if the player is wearing a full set of armor in this category, do this:
      fullSet:
  
        # give the player the following potion effects while they are wearing the full set
        # of armor
        effects:
          -
            potion: "GLOWING"
          -
            potion: "INCREASE_DAMAGE"
            strength: 2
            particles: false
            showIcon: true
  myOtherArmorCategory:
    # ...

inventories.yml

# The items that will be used in item GUIs,
# such as when running /cui inspect or /cui info
#
# You could set these to custom items to get some cool effects
# (see "referencing items" in either items/compressedCobblestone.yml or on the wiki at
# https://github.com/jojodmo/CustomItems/wiki/Custom-Item-Reference if you're unsure how to do this)
#
# For example, you could make a new custom item that looks like a back button, and use
# that for previousMenu

menuItems:
  previousMenu: "minecraft:OBSIDIAN"
  information: "minecraft:PAPER"
  making: "minecraft:ENDER_EYE"
  crafting: "minecraft:CRAFTING_TABLE"
  obtaining: "minecraft:COMPASS"
  usage: "minecraft:DIAMOND_PICKAXE"
  downArrow: "minecraft:GLASS_PANE"
  upArrow: "minecraft:GLASS_PANE"
  noPermission: "minecraft:RED_STAINED_GLASS_PANE"
  craftingResultArrow: "minecraft:LIME_STAINED_GLASS_PANE"
  relatedItemsLeftArrow: "minecraft:BLUE_STAINED_GLASS_PANE"
  relatedItemsDownArrow: "minecraft:WHITE_STAINED_GLASS_PANE"
  relatedItemsRightArrow: "minecraft:BLUE_STAINED_GLASS_PANE"

# Whether or not categories should be enabled. Set to "true" to enable categories
categoriesEnabled: false

# Item Categories along with the items that represent them
# You can add items to categories by setting "category" in
# the item's YML file.
#
# Any item that doesn't have a category will be put in the
# "miscellaneous" category by default.
#
# The format is
#
#   [category]:
#     itemName: [...]
#     item: [...]
#     itemOrder: (...)
#
# Where the item is the item that represents this category.
# This can be a Minecraft item or a Custom Item. See referencing
# items above.
#
# itemName is the name that appears in the Custom Item list inventory
# You can use &color codes in this name
#
# If you want to order the items in the category's item list view, you can
# set itemOrder. Items will be added in the order that they appear in itemOrder.
# Keep in mind that you STILL NEED TO REGISTER THE ITEM INTO THE CATEGORY IN THE
# ITEM'S YML FILE. Any items that aren't in the list but are in the category will
# be added to the inventory after the ordered items.
categories:
  miscellaneous:
    itemName: "&dMiscellaneous"
    item: "minecraft:DIAMOND_PICKAXE"
    itemOrder:
      - "myFirstCustomItem"
      - "mySecondCustomItem"
      - "myThirdCustomItem"


# The order you want your categories to show up in the category inventory.
# Anything that isn't included here will be put at the end of the inventory,
# in an undefined order.
categoryOrder:
   - "myFirstCategory"
   - "miscellaneous"

# Whether or not item list permissions should be enabled.
#
# if this is set to "true", players will need certain permissions to see certain categories or items
# customitems.list.category.myCategory | gives the player permission to view the "myCategory" category when running /cui list
# customitems.list.category.* | gives the player permission to view all of the categories when running /cui list
# customitems.list.item.category.myCategory | gives the player permission to view ALL of the items in the myCategory category.
# REMEMBER: YOU MUST STILL GIVE THE PLAYER THE PERMISSIONS customitems.list.category.myCategory TO ALLOW THEM TO SEE THE CATEGORY
# customitems.list.item.myCustomItem | gives the player permission to see the myCustomItem item when running /cui list
# customitems.list.item.* | gives the player permission to see all of the items, or, if you're using categories, gives
# the player permission to view all of the items in the categories they're allowed to see.
#
# customitems.list.* | gives the player permission to see all items and categories
#
# It is recommended that if you set this to "true", you give all players who have the permission customitems.list.category.myCategory
# the permission customitems.list.category.myCategory.items as well, for all items. However, this isn't necessary -- it just might make things easier.
#
# Default: false
listPermissionsEnabled: false