EzAuction

EzAuction is a modern, extensible Minecraft auction plugin for Bukkit/Spigot servers. It features a user-friendly GUI, robust API, and comprehensive event system for both server owners and plugin developers.

Version 2.0.0 introduces enhanced GUI navigation, detailed confirmation dialogs, and full compatibility with EzShops 2.0.0+.

---

📑 Table of Contents

• EzAuction
  • 📑 Table of Contents
  • 📦 Requirements
  • 🚀 Installation
    • New Installation
  • ✨ Features
  • ⚙️ Configuration
  • 🛡️ Permissions & Commands
  • 📚 Documentation
  • 🛠️ Usage Examples
    • Creating a Listing
    • Listening for Events
  • 🤝 Contributing
  • 🛡️ Support & Community
  • 📄 License

---

📦 Requirements

• Java 17 or higher (Adoptium)
• Bukkit/Spigot/Paper server (1.17+ recommended)

🚀 Installation

New Installation

1. Download the latest EzAuction JAR from the releases page.
2. Place the JAR in your server's plugins/ directory.
3. Start or reload your server.
4. Configure the plugin as needed (see below).

✨ Features

• Intuitive auction GUI for browsing, buying, and selling
• Buy/sell items with in-game currency
• Configurable listing rules, durations, and permissions
• Search, filter, and sort auction listings
• Expiry and auto-removal of old listings
• Customizable messages and GUI appearance
• Full event and API support for developers
• Multi-language support (via config)
• NEW in 2.0: EzShops 2.0.0+ integration support
• NEW in 2.0: Enhanced navigation with Back buttons and search tips
• NEW in 2.0: Quick access to pending returns via Claims button
• NEW in 2.0: Low-price warnings in confirmation dialogs
• NEW in 2.0: Consolidated "My Activity" menu
• Actively maintained and open source
• NEW in 2.0.1 Orders-Only Mode If you only want the Orders feature (buy orders, no auction house), set orders-only-mode: true in orders-only.yml. This disables all auction house features and enables the /orders and /order commands for players to create and manage buy orders.

⚙️ Configuration

Default configuration files are generated on first run in plugins/EzAuction/.

Key configuration options in config.yml:

• listing-max-duration: Maximum time (in hours) a listing can stay active
• listing-fee: Flat or percentage fee for creating a listing
• currency-type: Vault, XP, or custom economy
• max-listings-per-player: Limit the number of active listings per player
• allow-bidding: Enable/disable bidding (if supported)
• gui-title: Customize the auction GUI title
• language: Set the plugin language (see lang/ folder)

After editing, reload the plugin or restart the server to apply changes.

🛡️ Permissions & Commands

Orders-Only Mode Command:

Command	Description	Permission
/orders	Open the Orders (buy orders) menu	ezauction.auction.order

When orders-only-mode is enabled, all other auction commands are disabled.

Main Commands:

Command	Description	Permission
/auction	Open the auction browser GUI	ezauction.use
/auction sell <price>	List held item for sale	ezauction.sell
/auction cancel	Cancel your active listing	ezauction.cancel
/auction reload	Reload plugin configuration	ezauction.admin.reload
/auction history [player]	View your auction history (or another player's, if permitted)	ezauction.auction.history / ezauction.auction.history.others

Key Permissions:

• ezauction.use: Access the auction GUI

• ezauction.sell: List items for sale

• ezauction.cancel: Cancel own listings

• ezauction.admin.*: All admin permissions

• ezauction.auction.history: View your own auction history in the GUI

• ezauction.auction.history.others: View other players' auction history (if permitted)

See the docs/permissions.md for a full list.

📚 Documentation

• API Reference: Public classes, methods, and code samples
• Event Reference: All plugin events, listener registration, and event payloads
• Configuration Guide: All config options explained
• Permissions: All permissions and their usage
• Full Documentation: Guides, advanced usage, and troubleshooting

🛠️ Usage Examples

Creating a Listing

AuctionOperationResult result = auctionManager.createListing(player, itemStack, price, duration);
if (result.success()) {
    // Listing created
} else {
    player.sendMessage(result.message());
}

Listening for Events

@EventHandler
public void onAuctionListingCreate(AuctionListingCreateEvent event) {
    // Custom logic here
}

---

🤝 Contributing

Contributions are welcome! Please see CONTRIBUTING.md for guidelines, or open an issue/PR.

🛡️ Support & Community

• For help, open an issue on GitHub or contact the maintainers.
• Feature requests and bug reports are encouraged.

📄 License

EzAuction is licensed under the MIT License. Copyright (c) 2026 Gyvex (63536625).

---

For full documentation, see the docs/ folder. For support, open an issue or contact the maintainers.