Item Grouping

OverviewCopy Anchor Link

The item grouping system allows you to organize related items together for easier management and browsing. Through grouping, you can create a hierarchical item directory, making it simpler for players to find the items they need.

Basic ConceptsCopy Anchor Link

What is Item GroupingCopy Anchor Link

Item grouping refers to classifying and organizing items based on type, purpose, or other criteria. Each group can contain multiple items and can also include sub-groups, forming a tree-like structure.

Functions of GroupingCopy Anchor Link

• Item Organization: Manage a large number of items by categorizing them into groups
• Easy Browsing: Players can quickly find items through the group menu
• Hierarchical Management: Support multi-level grouping to create complex item directories

Creating Item GroupsCopy Anchor Link

Method 1: Folder-Based GroupingCopy Anchor Link

The simplest way to group items is by using a folder structure:

The system automatically creates groups based on the folder structure, with folder names serving as group names.

Method 2: Configuration File-Based GroupingCopy Anchor Link

Define custom groups using the __group__ node in YAML files:

# weapons.yml
__group__:
  name: 'Weapon & Armor'
  priority: 1
  display:
    icon: diamond_sword
    name: '&cWeapon & Armor'
    lore:
      - '&7Various powerful weapons'

# Items in the group
magic_sword:
  icon: diamond_sword
  name:
    item_name: '&6Magic Sword'

fire_bow:
  icon: bow
  name:
    item_name: '&cFlame Bow'

Group Configuration OptionsCopy Anchor Link

Basic ConfigurationCopy Anchor Link

Display ConfigurationCopy Anchor Link

__group__:
  name: 'Legendary Equipment'
  priority: 1
  display:
    icon: diamond_chestplate
    name: '&6Legendary Equipment'
    lore:
      - '&7Rare legendary-grade equipment'
      - '&7Click to view all items'

Group Hierarchical StructureCopy Anchor Link

Multi-Level GroupingCopy Anchor Link

You can create nested multi-level group structures:

The system automatically handles parent-child relationships and generates a complete path structure.

Group Menu SystemCopy Anchor Link

Auto-Generated Group MenuCopy Anchor Link

The system automatically creates a browsable menu interface for groups:

• Group Icon: Displays a representative icon for the group
• Item Count: Shows the number of items contained in the group
• Hierarchical Navigation: Supports switching between different levels

Using the Group MenuCopy Anchor Link

Players can open the group menu using the following commands:

# Open the root group menu
/zaphkiel list

# Open a specific group menu
/zaphkiel list weapons

Group Display IconsCopy Anchor Link

Auto-Generated IconsCopy Anchor Link

If no custom icon is configured, the system automatically generates a group icon:

• With Items: Randomly selects one item from the group as the icon
• Without Items: Uses the default minecart with chest icon
• Display Info: Automatically adds the group name and item count

Custom IconsCopy Anchor Link

You can customize the icon in the group configuration:

__group__:
  name: 'Magical Items'
  display:
    icon: enchanted_book
    name: '&dMagical Items'
    lore:
      - '&7Mysterious items filled with magic'
      - '&7Contains <item_count> items'

Practical Group ExamplesCopy Anchor Link

Group by TypeCopy Anchor Link

# weapons.yml
__group__:
  name: 'Weapons'
  priority: 1

# Melee weapons
iron_sword:
  icon: iron_sword
  name:
    item_name: '&7Iron Sword'

diamond_sword:
  icon: diamond_sword
  name:
    item_name: '&bDiamond Sword'

Group by TierCopy Anchor Link

# legendary_items.yml
__group__:
  name: 'Legendary Items'
  priority: 1

legendary_sword:
  icon: diamond_sword
  name:
    item_name: '&6Legendary Sword'
  data:
    tier: 'legendary'

legendary_bow:
  icon: bow
  name:
    item_name: '&6Legendary Bow'
  data:
    tier: 'legendary'

Group by FunctionCopy Anchor Link

# utility_items.yml
__group__:
  name: 'Utility Items'
  priority: 3

teleport_scroll:
  icon: paper
  name:
    item_name: '&bTeleport Scroll'

healing_potion:
  icon: potion
  name:
    item_name: '&cHealing Potion'

Usage TipsCopy Anchor Link

1. Logical Group StructureCopy Anchor Link

Create a clear hierarchical group structure:

2. Priority SettingsCopy Anchor Link

Control the display order of groups in the menu using priority:

# Important groups with smaller priority numbers
__group__:
  priority: 1  # Appears first

# Secondary groups with larger priority numbers
__group__:
  priority: 10  # Appears later

3. Descriptive NamingCopy Anchor Link

Use clear group names and descriptions:

__group__:
  name: 'Beginner Equipment'
  display:
    name: '&aBeginner Equipment'
    lore:
      - '&7Basic equipment suitable for new players'
      - '&7Inexpensive and easy to obtain'