NBContest

# **NBContest** 🏆 **NBContest** is a lightweight, fast and highly customizable Minecraft plugin that allows you to host exciting server-wide contests such as farming, fishing, and mob hunting events. It encourages players to compete and earn configurable rewards with real-time visual feedback. --- ## ✨ Features ### 🎮 **Contest Types** - **Farming Contest** – Break random crops (wheat, carrots, potatoes, etc.) - **Fishing Contest** – Catch as many fish as possible! - **Passive Mobs Contest** – Kill cows, chickens, sheep and more! - **Hostile Mobs Contest** – Kill hostile mobs like zombies and skeletons! ### 📊 **Real-time Display System** - **Boss Bar** (can be enabled/disabled) - Shows time remaining and global objective - Customizable color (PINK, BLUE, GREEN, RED, YELLOW, PURPLE, WHITE) - Full MiniMessage support for rich formatting - **Scoreboard** (can be enabled/disabled) - **NEW!** ✨ - Live display of contest information - Event name with custom formatting - Time remaining (MM:SS format) - Objective progress (for farming events) - **Real-time Top 3 leaderboard** - Shows only active participants - Fully customizable via `messages.yml` - **Action Bar** - Individual player score display - Updates in real-time - Legacy color code support for compatibility ### 🎁 **Rewards System** - Top 3 players receive configurable rewards - Execute any console command as reward - Support for multiple commands per rank - Placeholder support (`%player%`) ### ⏰ **Automatic Event Scheduler** - Schedule multiple events per day - Supports multiple times per event type - Fully customizable timezone (e.g., Europe/Paris) - Runs automatically based on server clock - Enable/disable individual events ### 🎨 **Customization** - **MiniMessage Support** for rich text formatting - Gradients, hex colors, formatting tags - Hover and click events support - **Fully translatable** via `messages.yml` - **Configurable objectives** (fixed or random) - **Custom material names** for better localization - **Organized configuration** with detailed comments ### 🛠️ **Technical Features** - Lightweight and optimized for performance - Adventure API integration for modern text components - Paper/Purpur optimized - No dependencies required (standalone) - Automatic cleanup on server shutdown --- ## ⌨️ Commands | Command | Description | Permission | |---------|-------------|------------| | `/nbcontest start <event>` | Start a contest (`farming`, `fishing`, `hostiles_mobs`, `passive_mobs`) | `nbcontest.admin` | | `/nbcontest stop` | Stop the current contest | `nbcontest.admin` | | `/nbcontest reload` | Reload config, schedule and language | `nbcontest.admin` | ### Event Types - `farming` - Harvesting contest - `fishing` - Fishing contest - `hostiles_mobs` - Monster hunt - `passive_mobs` - Animal culling --- ## 🕒 Automatic Events Auto-events can be scheduled using `auto-events` in the config. Each event can have multiple start times, and all times are based on the server's timezone. **Example:** ```yaml auto-events: enabled: true farming: - "14:00" # 2:00 PM - "18:30" # 6:30 PM fishing: - "15:00" # 3:00 PM ``` You can configure the timezone with `timezone: "Europe/Paris"` (or any (https://en.wikipedia.org/wiki/List_of_tz_database_time_zones)). --- ## ⚙️ Configuration (`config.yml`) ```yaml # ======================================== # NBContest Configuration # ======================================== # Plugin for managing competitive events on your Minecraft server # Discord: https://discord.nb.studio/ # ======================================== # ======================================== # General Settings # ======================================== # Duration of all events in seconds (default: 300 = 5 minutes) duration: 300 # Timezone for auto-events scheduling # Full list: https://en.wikipedia.org/wiki/List_of_tz_database_time_zones # Examples: "Europe/Paris", "America/New_York", "Asia/Tokyo", "UTC" timezone: "Europe/Paris" # ======================================== # Display Settings # ======================================== # Boss Bar Configuration bossbar: # Enable/disable the boss bar during contests enabled: true # Color of the boss bar # Options: PINK, BLUE, GREEN, RED, YELLOW, PURPLE, WHITE color: YELLOW # Scoreboard Configuration scoreboard: # Enable/disable the live scoreboard during contests # Shows: event name, time remaining, top 3 players, objective progress enabled: true # ======================================== # Contest Objective # ======================================== objective: # If true, use the fixed 'amount' value # If false, use a random value between 'min' and 'max' fixed: false # Fixed objective amount (used when fixed: true) amount: 100 # Random objective range (used when fixed: false) min: 50 max: 500 # ======================================== # Auto-Events Scheduler