ShamboQ
PluginMIT

ShamboQ

Lightweight Queue Plugin

80
Downloads
3
Followers
11 months ago
Updated
📦
3
Versions

📖About ShamboQ

ShamboQ - Advanced Queue System

sq

Overview

ShamboQ is a professional queue management system for Minecraft networks that allows server administrators to create an elegant waiting experience for players before transferring them to the main server. The plugin freezes players in a designated waiting area, displays countdown messages, and plays immersive sound effects before automatically transferring them to the destination server. Plugin will be developed further.

Project History

ShamboQ is sponsored by Shambonoor Enterpraises

Installation

Requirements

  • Minecraft server running Bukkit/Spigot/Paper 1.19+ (might work on 1.16-1.18)
  • A proxy server: BungeeCord, Waterfall, or Velocity
  • Java 8 or higher

Installation Steps

  1. Download the ShamboQ-xxx.jar file
  2. Place the JAR file in your lobby server's /plugins/ directory
  3. Restart your server (or use a plugin manager to load it)
  4. Edit the generated configuration file at /plugins/ShamboQ/config.yml to match your network settings
  5. Use /shamboq reload to apply your configuration changes

Important: Proxy Configuration

  1. Make sure your BungeeCord/Velocity config has the destination server defined with the same name as specified in the ShamboQ configuration
  2. Enable Proxy support in config files of your Queue Server

How It Works

The Queue Process

  1. When a player joins your lobby server, ShamboQ automatically:

    • Freezes the player in place
    • Hides the player from others (and vice versa)
    • Teleports them to the designated spawn point in The End dimension (plugin searches for an End world by default)
    • Displays a welcome message with countdown information
    • Plays immersive sound effects
    • Shows a countdown in the action bar
  2. When the countdown reaches zero, the player is automatically transferred to your main server

Queue Management

  • Administrators can toggle the queue on/off without restarting
  • When disabled, players remain frozen but don't see the countdown
  • When re-enabled, all waiting players are automatically added to the active queue process
  • Players with the shamboq.bypass permission skip the queue entirely

Configuration

The config.yml file allows you to customize:

# ShamboQ Configuration
# developed by Shambonoor Ent.
# https://szam.boo/
# https://discord.gg/wUmVUBc7rv

# Queue settings
queue:
  # Enable or disable the queue system
  enabled: true
  # Time in seconds to wait before sending to SMP
  time: 10
  # Name of the SMP server to connect to
  smp-server: "smp"
  # Message to show when queue is disabled
  disabled-message: "Queue is currently disabled"
  # Whether to show the disabled message
  show-disabled-message: true
  # How often to show the notification in seconds
  notification-interval: 5

# Connection settings
connection:
  # Maximum number of retry attempts when connection fails
  max-retries: 3
  # Time in seconds to wait between retry attempts
  retry-delay: 5

# Messages for various plugin functions
messages:
  queue_enabled: "&aQueue has been enabled!"
  queue_disabled: "&cQueue has been disabled!"
  no_permission: "&cYou don't have permission to use this command!"
  queue_time_set: "&aQueue time set to &e%d &aseconds!"
  invalid_number: "&cInvalid number: &e%s"
  message_set: "&aQueue disabled message set to: &e%s"
  notifications_enabled: "&aQueue disabled notifications have been enabled!"
  notifications_disabled: "&cQueue disabled notifications have been disabled!"
  player_not_found: "&cPlayer not found: &e%s"
  sending_player: "&aSending &e%s &ato &e%s&a!"
  config_reloaded: "&aShamboQ configuration reloaded!"
  welcome_title: "&6Welcome to the Server!"
  welcome_subtitle: "&eYou will be transferred to the SMP server in &6%d &eseconds"
  countdown: "&eTransfer in &6%d &eseconds..."
  queue_disabled_title: "&cQueue Disabled"
  usage_settime: "&cUsage: /shamboq settime <seconds>"
  usage_message: "&cUsage: /shamboq message <message>"
  usage_send: "&cUsage: /shamboq send <player>"
  queue_disabled_player: "&cQueue system has been disabled. You are no longer in queue."
  frozen_player: "&cYou are currently frozen in the lobby."

  # New connection error messages
  connection_failed: "&cConnection to SMP server failed. Retrying..."
  connection_error: "&cCould not connect to SMP server. &eError: %s"
  connection_timeout: "&cConnection timed out. Retrying in %d seconds..."
  max_retries_reached: "&cCould not connect after %d attempts. Please try again later."
  back_in_queue: "&eYou've been placed back in the queue due to connection issues."

# Spawn location in the End
spawn:
  x: -1.5
  y: 64
  z: 0.5

# Example of sounds that will be played randomly
sounds:
  - "ENTITY_ENDERMAN_DEATH"
  - "ENTITY_ENDER_DRAGON_AMBIENT"
  - "ENTITY_ENDER_DRAGON_DEATH"
  - "BLOCK_END_PORTAL_FRAME_FILL"
  - "BLOCK_END_PORTAL_SPAWN"
  - "BLOCK_END_GATEWAY_SPAWN"
  - "ENTITY_LIGHTNING_BOLT_THUNDER"
  - "ENTITY_LIGHTNING_BOLT_IMPACT"
  - "ENTITY_GENERIC_EXPLODE"

# Optimization settings for reducing server resource usage
optimization:
  # Basic Optimization
  chunk-management: true
  disable-mobs: true
  reduce-view-distance: true
  queue-view-distance: 3
  no-tick-zone: true

  # Advanced
  disable-terrain-generation: true
  disable-player-ticks: true
  spectator-mode: false
  dedicated-thread-pool: true
  thread-pool-size: 1
  aggressive-chunk-management: true
  max-loaded-chunks: 5

# Debug mode (enables verbose logging)
debug: false

Commands

  • /shamboq toggle - Enable or disable the queue
  • /shamboq settime <seconds> - Set the queue waiting time
  • /shamboq message <text> - Set the queue disabled message
  • /shamboq notify - Toggle queue disabled notifications
  • /shamboq send <player> - Send a specific player to the SMP server
  • /shamboq reload - Reload the configuration
  • /shamboq status - Show the current queue status

Permissions

  • shamboq.admin - Access to all ShamboQ commands
  • shamboq.bypass - Skip the queue entirely

Technical Features

  • Multi-version support with automatic API detection
  • Advanced action bar system compatible with Paper's Adventure API
  • Memory-efficient queue management
  • Thread-safe player handling
  • Automatic fallback systems for compatibility
  • Optimization of Queue Server

Support and Feedback

For support, feature requests, or to report bugs, please visit discord.gg/wUmVUBc7rv

Developed by Shambonoor Ent.