Config (List.yml)

list.yml

# ==============================================================
# Mystic Ore Restriction - Configuration File
# --------------------------------------------------------------
# This configuration file allows you to define item categories
# and set specific restrictions based on the player's skills and
# levels. Each category can have custom behavior, sounds, and
# particle effects when restrictions are applied.
# ==============================================================
# Note: All comments start with a '#' and are not processed by
# the plugin. They are included to help you understand how to 
# configure the plugin to suit your server's needs.
# ==============================================================

# --------------------------------------------------------------
# "DIAMOND CATEGORY" EXAMPLE PRECONFIGURED FOR DIAMOND
# --------------------------------------------------------------
# This category defines all the items related to diamond.
# Players must meet the requirements below to use, mine, or 
# craft items within this category.
# --------------------------------------------------------------
diamond:
  # Items that fall under the diamond category. These are 
  # the specific items that will be restricted based on the 
  # player's skill and level. You can add or remove items 
  # from this list as needed.
  items:
    - DIAMOND_SWORD           # Diamond Sword
    - DIAMOND_PICKAXE         # Diamond Pickaxe
    - DIAMOND_SHOVEL          # Diamond Shovel
    - DIAMOND_AXE             # Diamond Axe
    - DIAMOND_HOE             # Diamond Hoe
    - DIAMOND_HELMET          # Diamond Helmet
    - DIAMOND_CHESTPLATE      # Diamond Chestplate
    - DIAMOND_LEGGINGS        # Diamond Leggings
    - DIAMOND_BOOTS           # Diamond Boots
    - DIAMOND                 # Diamond (Item)
    - DIAMOND_BLOCK           # Block of Diamond
    - DIAMOND_ORE             # Diamond Ore
    - DEEPSLATE_DIAMOND_ORE   # Deepslate Diamond Ore
    - DIAMOND_HORSE_ARMOR     # Diamond Horse Armor
  
  # The required skill level a player needs in order to 
  # interact with the items in this category. This level 
  # corresponds to the player's level in the specified skill.
  categorylevel: 7

  # The AuraSkills skill required to interact with items in 
  # this category. You can specify any skill available in 
  # AuraSkills, such as MINING, FARMING, etc.
  skillRequire: MINING

  # Set to 'true' to enable mining restrictions for this 
  # category. If enabled, players will need to meet the 
  # required skill level to mine the items in this category.
  MiningRestriction: true

  # Set to 'true' to enable item usage restrictions for this 
  # category. If enabled, players will need to meet the 
  # required skill level to use items in this category.
  ItemUsageRestrictions: true

  # Set to 'true' to enable armor penalties for this category. 
  # If enabled, armor items in this category will take more 
  # damage when worn by players who do not meet the required 
  # skill level.
  ArmorPenalty: true

  # Set to 'true' to enable crafting restrictions for this 
  # category. If enabled, players will need to meet the 
  # required skill level to craft items in this category.
  CraftingRestrictions: true

  # The sound that will be played when a restriction is applied 
  # to a player interacting with items in this category. Choose 
  # from any valid Minecraft sound.
  Sound: BLOCK_ANVIL_LAND

  # The particle effect that will be displayed when a restriction 
  # is applied to a player interacting with items in this category. 
  # Choose from any valid Minecraft particle effect.
  ParticleEffect: VILLAGER_ANGRY


# --------------------------------------------------------------
# TEST CATEGORY
# --------------------------------------------------------------
# This test category is provided as an example to help you 
# understand how to configure new categories. You can use it 
# as a template or for testing purposes.
# --------------------------------------------------------------
test_category:
  # Example items in the test category. Replace these with 
  # any items you'd like to test or configure.
  items:
    - TEST_ITEM_1             # Example Item 1
    - TEST_ITEM_2             # Example Item 2
    - TEST_ITEM_3             # Example Item 3

  # The required skill level a player needs in order to 
  # interact with the items in this category.
  categorylevel: 5

  # The AuraSkills skill required to interact with items in 
  # this category. Replace with the skill you want to test.
  skillRequire: TEST_SKILL

  # Enable or disable mining restrictions for this category.
  MiningRestriction: true

  # Enable or disable item usage restrictions for this category.
  ItemUsageRestrictions: false

  # Enable or disable armor penalties for this category.
  ArmorPenalty: false

  # Enable or disable crafting restrictions for this category.
  CraftingRestrictions: false

  # The sound that will be played when a restriction is applied 
  # to a player interacting with items in this category.
  Sound: BLOCK_NOTE_BLOCK_PLING

  # The particle effect that will be displayed when a restriction 
  # is applied to a player interacting with items in this category.
  ParticleEffect: CRIT_MAGIC