DOCSEARCHbyAlgolia
Submit Docs

Groupez Plugin Documentation

website·Indexed 32 days ago

https://docs.groupez.dev/

Documentation for a suite of Minecraft server plugins, including zMenu for flexible GUI inventories, zSpawner for spawner management, zShop for item trading, zItems for custom item effects and metadata, zQuests for quest systems, zAuctionHouse for community auctions, and zKoth for King of the Hill capture zones.

Tokens
230.7K
Snippets
1.4K
Records
1.7K
Agent score
63%

What's inside Groupez

  1. Overview of zMenu Player Data System

    zMenu includes a built-in player data system for storing and retrieving values specific to each player (e.g., tracking progress, toggles, or statistics). Data is stored in a database and persists across server restarts.

  2. Overview of Sarah Java Database Library

    Sarah is a Java library designed to simplify database management by providing a clean abstraction over raw SQL. It supports MySQL, MariaDB, and SQLite. Key capabilities include a fluent query builder, automatic object mapping to DTOs, a schema migration system, and built-in connection pooling via HikariCP.

  3. Overview of zMenu Pattern Types

    zMenu provides three types of patterns to handle reuse across different inventories. Inventory and Button patterns are stored in the patterns/ folder, while Action patterns are stored in actions_patterns/.
    plugins/zMenu/
├── patterns/
│   ├── my_decoration.yml   # type: INVENTORY (default)
│   └── my_button.yml       # type: BUTTON
└── actions_patterns/
    └── default-actions.yml

  4. Overview of Item Metadata Configuration

    Metadata allows you to configure special properties for items that extend beyond basic materials and enchantments. Metadata is defined within the metadata section of an item configuration, where each metadata type is represented as a separate key.
    my_item:
  material: DIAMOND_SWORD
  display-name: "<red>Special Sword</red>"

  metadata:
    # Each metadata type is a separate key
    food:
      nutrition: 5
      saturation: 1.0

    commands:
      commands:
        - sender: CONSOLE
          commands:
            - "give %player% diamond 1"

  5. Overview of MenuItemStack

    MenuItemStack is an abstraction over Bukkit's ItemStack designed for zMenu. It enables the creation of dynamic items by providing support for placeholders in names and lores, dynamic item building based on player context, and easy manipulation of properties such as custom model data and enchantments.

  6. Overview of zAuctionHouse Sales History

    The history inventory provides a read-only view of a player's completed sales, allowing them to see which items were sold, who bought them, and when the transaction occurred. It is accessed via the /ah history command and configured in plugins/zAuctionHouse/inventories/history.yml.

  7. Overview of zEssentials Discord Bot

    The zEssentials Discord Bot is a standalone Java application built with JDA (Java Discord API). It runs as a separate process from the Minecraft server but connects to the same database to enable real-time account association. Its primary purpose is to provide a secure, code-based verification flow to link Minecraft accounts with Discord accounts.

  8. Overview of zCookieClicker features

    zCookieClicker is a Minecraft server plugin that implements a Cookie Clicker-style mini-game. Key gameplay features include:

    • Cookie Clicking: Players earn cookies via clicking with real-time GUI updates.
    • Passive Income: Players earn Cookies Per Second (CPS) through purchased upgrades.
    • Dynamic Pricing: Upgrade costs scale by a configurable percentage per purchase, utilizing BigDecimal to prevent number overflow.
    • Number Formatting: Large values are displayed using short-hand suffixes (K, M, B, T, Qa, Qi, etc.), which are customizable.
    • zMenu Integration: Uses zMenu for customizable GUIs, interactive buttons, and consistent upgrade display patterns.
    • Data Persistence: Supports automatic saving of player progress across sessions using SQLite, MySQL, or MariaDB.

  10. Overview of Virtual Spawners in zSpawner

    Virtual Spawners are advanced spawners that differ from traditional ones by spawning entities in a controlled radius, supporting auto-kill and auto-sell functionality, storing items internally in a spawner inventory, and allowing location rental for other players.

  11. Overview of zAuctionHouse features

    zAuctionHouse is a customizable marketplace plugin for Minecraft servers that allows players to buy and sell items. Key capabilities include:

    • Tax System: Configurable taxes on sales and purchases with permission-based exemptions.
    • Bulk Sales: Ability to sell multiple items in a single listing.
    • Shulker Preview: Allows players to preview the contents of shulker boxes before purchasing.
    • Auto-Claim: Automatically claims sold items upon player login.
    • Discord Integration: Sends notifications to Discord when items are sold.
    • Category System: Flexible organization based on materials, item names, lore, and NBT tags. It supports custom item plugins including ItemsAdder, Oraxen, Nexo, and MMOItems.
    • Transaction Management: Includes transaction history, search/filter options, and retrieval of expired items.

  12. Overview of zKoth features

    zKoth is a Minecraft plugin for creating capture zones where players or teams compete for control to earn rewards. Key features include support for multiple KOTH types (Capture and Score), team plugin integration, custom scoreboards, floating holograms, Discord webhooks, a flexible loot system, random command execution, automatic scheduling via zScheduler, and PlaceholderAPI support.