GroupeZ Docs

Effects Overview

Complete guide to all effects in zItems

Effects are powerful abilities that can be added to items. They trigger on specific events like breaking blocks, killing mobs, or interacting with the world.

How Effects Work

Effects are added to items in two ways:

  1. Built-in: Defined in the item configuration
  2. Applied: Added by players via Smithing Table or Applicator GUI

Effects are processed based on priority - lower priority numbers execute first.

Effect Configuration

All effects share common configuration options:

effects:
  - type: EFFECT_TYPE
    # Common options (optional)
    applicable-materials:    # Materials this effect can be applied to
      - DIAMOND_PICKAXE
      - NETHERITE_PICKAXE
    applicable-tags:          # Material tags this effect can be applied to
      - PICKAXES
    applicability-blacklisted: false  # If true, inverts the filter

Available Effects

EffectEventDescription
VEIN_MININGBlock BreakMine entire ore veins
HAMMERBlock BreakMine in 3x3 (or larger) area
MELT_MININGBlock BreakAuto-smelt mined blocks
XP_BOOSTBlock BreakMultiply XP drops
SILK_SPAWNERBlock BreakPick up spawners
AUTO_SELLBlock Break / Entity DeathAuto-sell drops
ABSORPTIONBlock Break / Entity DeathItems go to inventory
FARMING_HOEBlock Break / InteractArea harvest and plant
SELL_STICKPlayer InteractSell container contents
INFINITE_BUCKETBucket EventsUnlimited bucket uses
UNBREAKABLE-Prevent durability loss
ENCHANTS_APPLICATOR-Modify enchantments
ATTRIBUTES_APPLICATOR-Add/modify attributes

Effect Representation

Effects can have a physical item representation that players can obtain and apply:

effects:
  - type: VEIN_MINING
    block-limit: 32

    # Effect representation (item form)
    representation:
      material: EMERALD
      display-name: "<green>Vein Mining Rune</green>"
      lore:
        - ""
        - "<gray>Apply to a pickaxe</gray>"
        - "<gray>at a smithing table</gray>"

      # How the effect is applied
      applicator-type: SMITHING_TABLE  # or ZITEMS_APPLICATOR

      # For SMITHING_TABLE
      template:
        item: NETHERITE_UPGRADE_SMITHING_TEMPLATE

      # For ZITEMS_APPLICATOR
      ingredients:
        - item: DIAMOND
        - item: EMERALD

Applicator Types

TypeDescription
SMITHING_TABLEApply via vanilla smithing table
ZITEMS_APPLICATORApply via custom zItems GUI

Effect Incompatibilities

Some effects are incompatible with each other:

EffectIncompatible With
VEIN_MININGHAMMER
HAMMERVEIN_MINING
AUTO_SELLABSORPTION
ABSORPTIONAUTO_SELL

If you try to add an incompatible effect, it will be rejected.

Material Filters

Effects can be restricted to specific item types:

effects:
  - type: VEIN_MINING
    # Only these materials can have this effect
    applicable-materials:
      - DIAMOND_PICKAXE
      - NETHERITE_PICKAXE
      - GOLDEN_PICKAXE
      - IRON_PICKAXE

  - type: HAMMER
    # Use tags for groups of items
    applicable-tags:
      - PICKAXES
      - SHOVELS

  - type: AUTO_SELL
    # Blacklist mode - effect works on everything EXCEPT these
    applicable-materials:
      - WOODEN_SWORD
    applicability-blacklisted: true

Complete Example

# A pickaxe with multiple effects
ultimate_pickaxe:
  material: NETHERITE_PICKAXE
  display-name: "<gradient:#ff6b6b:#feca57>Ultimate Pickaxe</gradient>"
  lore:
    - ""
    - "<gray>The most powerful mining tool</gray>"
    - ""
    - "<yellow>Effects:</yellow>"
    - "<gray>- Vein Mining (64 blocks)</gray>"
    - "<gray>- Auto Smelt</gray>"
    - "<gray>- XP Boost x3</gray>"
    - "<gray>- Auto Sell</gray>"

  enchantments:
    - enchantment: EFFICIENCY
      level: 10
    - enchantment: FORTUNE
      level: 5
    - enchantment: UNBREAKING
      level: 5
    - enchantment: MENDING
      level: 1

  effects:
    # Mine entire veins
    - type: VEIN_MINING
      tags:
        - MINEABLE_PICKAXE
      block-limit: 64
      damage: 1

    # Auto-smelt drops
    - type: MELT_MINING

    # Triple XP
    - type: XP_BOOST
      boost: 3.0
      chance-to-boost: 100

    # Sell drops automatically
    - type: AUTO_SELL
      multiplier: 1.0

  # Don't allow more effects
  allow-additional-effects: false

Next Steps

Explore each effect in detail:

Item Configuration

Complete guide to creating custom items in zItems

Vein Mining

Mine entire ore veins at once

On this page

How Effects WorkEffect ConfigurationAvailable EffectsEffect RepresentationApplicator TypesEffect IncompatibilitiesMaterial FiltersComplete ExampleNext Steps
GroupeZ MCP

Documentation in your AI

MCP lets your AI search GroupeZ documentation and read current examples to help you configure your plugins.

Read-only · No documentation API key needed

1. Copy the server URL

Transport: HTTP (Streamable HTTP). Authentication: none. Your tool uses its own model and subscription limits.

  1. Open Plugins in ChatGPT on the web, then + → Add custom MCP server.
  2. Name it ‘GroupeZ Documentation’, paste the URL above and choose ‘No authentication’. Create and install the plugin.
  3. In a conversation, type @ and select the plugin before asking. If needed, enable search, get_page and list_pages in its settings.
Official setup guide

3. Ask a question

Use GroupeZ MCP to help me create a zMenu inventory. Search relevant pages, read the examples and cite your sources.
Other clients and troubleshooting

For clients using mcpServers, adapt this example to their format:

{
  "mcpServers": {
    "groupez-docs": {
      "url": ""
    }
  }
}

Available tools are search, get_page and list_pages. Refresh the connector’s tools after updates. If your AI cannot access them, check that the connector is enabled in the conversation and your account allows custom MCP servers. Opening the URL in a browser is not an MCP test.