MeowOreGen - Advanced Custom Ore Generator

[中文说明 (Chinese)]

---

📖 Introduction

MeowOreGen is a highly customizable and performance-optimized cobblestone generator plugin for Minecraft servers. It features seamless BentoBox integration but works perfectly in standalone mode.

Designed to be versatile, it supports SkyBlock, AcidIsland, Survival, Factions, and any other gamemode. It allows server administrators to create a deep progression system where players unlock better ore generation rates as they progress (via Island Level or Permissions).

MeowOreGen enhances gameplay by turning boring cobblestone generators into valuable resource extractors, regardless of your server type.

✨ Key Features

• 🚀 Seamless BentoBox Integration: Native support for BSkyBlock, AcidIsland, OneBlock, Boxed, and all BentoBox gamemodes. Drop-in replacement with zero friction.
• 🔌 Standalone Versatility: Not running BentoBox? No problem. Operates flawlessly as a global ore generator for Survival, Factions, or RPG servers.
• 📈 Dynamic Progression System: Engineer a rewarding gameplay loop with unlimited "Generator Tiers" (e.g., Rookie, Pro, Elite, Overlord).
• 🔐 Smart Unlock Criteria: Automate tier progression based on Island Levels or specific Permissions (great for ranks/VIPs).
• 🌍 Multi-Dimension Support:
  • Overworld: Revamp Cobblestone & Stone generation mechanics.
  • Nether: Transform Netherrack generators into valuable resource wells.
  • The End: Customize End Stone generation for end-game content.
• 🖥️ Modern GUI Experience: An intuitive, user-friendly interface for players to track unlock requirements, analyze drop rates in real-time, and switch tiers effortlessly.
• ⚙️ Player-Centric Control: Includes a "Vanilla Fallback" toggle, allowing builders to revert to standard generation mechanics on demand.
• 🧪 Custom Interaction Rules: Define custom block interaction logic (e.g., Lava flowing next to a Composter generates Cobblestone). This enables unique generator mechanics in environments like the Nether, where water cannot be placed.
• 🛡️ Fair Play Enforcement: Optional anti-exploit mechanics automatically disable generators upon TNT explosions, curbing low-effort AFK farming and maintaining economic balance.
• ⚡ Enterprise-Grade Performance:
  • Smart Caching: High-efficiency caching (60s TTL) eliminates API bottlenecks.
  • Lazy Evaluation: Resource-light logic checks requirements only when absolutely necessary.
  • Non-Blocking I/O: Fully asynchronous database operations (SQLite/MySQL) ensure your main thread never skips a beat.

📥 Installation

1. Ensure you have BentoBox installed and running.
2. Download MeowOreGen.jar and place it in your plugins folder.
3. Restart your server.
4. Configure config.yml to your liking.
5. Run /mog reload to apply changes.

🛠 Commands & Permissions

Command	Alias	Description	Permission
/mog	/oregen	Open the Generator Selection GUI.	meoworegen.use
/mog gui	-	Open the Generator Selection GUI.	meoworegen.use
/mog reload	-	Reload configuration and messages.	meoworegen.admin

• meoworegen.use: Default permission (true). Allows players to open the GUI and use the generator.
• meoworegen.admin: Admin permission (OP). Allows reloading the plugin.

⚙️ Configuration Guide

The config.yml is heavily commented to help you customize everything.

Defining Tiers

You can add as many tiers as you want in the generators section:

generators:
  # Unique ID for the tier
  vip_tier:
    display_name: "&6VIP Generator"
    # Requirement: Island Level 1000 OR permission 'meoworegen.group.vip'
    island_level_required: 1000
    permission: "meoworegen.group.vip"
    # GUI Slot
    slot: 2
    priority: 10
    icon: DIAMOND_ORE
    # Drop Rates
    worlds:
      NORMAL:
        STONE: 50.0
        DIAMOND_ORE: 1.0
        IRON_ORE: 20.0
      NETHER:
        QUARTZ_ORE: 30.0

Storage

MeowOreGen supports both local flatfile (SQLite) and enterprise database (MySQL) storage.

storage:
  type: SQLITE # or MYSQL

❓ FAQ

Q: Does this work with AcidIsland? A: Yes! It works with any gamemode that uses BentoBox for island management.

Q: Can I limit a generator to VIPs only? A: Yes, set a specific permission node in the tier config (e.g., group.vip) and give that permission only to VIP players.

Q: Why do players need to re-enable the generator after an explosion? A: This is a configurable feature (disable_on_explosion) designed to discourage fully automatic TNT-based AFK farming. You can disable this in the config.