Logo
pv-addon-sorter
PluginMIT

pv-addon-sorter

Plasmo Voice addon for sorting players.

77
Downloads
0
Followers
10 months ago
Updated
📦
1
Versions
utilitypaper
Download Latestv1.2View on Modrinth

📖About pv-addon-sorter

🎙️ PvAddonSorter - A PlasmoVoice Add-On for Minecraft Servers

PvAddonSorter is a Minecraft server plugin and add-on for PlasmoVoice, designed to manage players based on their voice chat status. Whether you're hosting a special event, moderating a server, or organizing gameplay, this add-on makes it easy to filter, kick, teleport, list, broadcast messages, or assign teams to players with or without voice chat. 🚀

Some features, like VOICE mode, may not be fully stable on high-latency servers. PlasmoVoice plugin is required! The plugin was tested with PlasmoVoice version 2.1.4+.

🌟 Features

  • Flexible Player Filtering: Control who can join or stay on your team based on whether they have PlasmoVoice installed. 🎯
  • Kick Modes: Choose from three modes modes to enforce voice chat rules:
    • NOBODY: No restrictions, everyone is allowed. 😊
    • NO-VOICE: Kicks players without voice chat. 🚪
    • VOICE: Kicks players with voice chat. ⚠️
  • Teleportation: Instantly teleport players with or without voice chat to your location for grouping. 🌍
  • Player Listing: Display lists of players based on their voice chat status. 📋
  • Broadcasting: Send targeted messages to players with or without voice chat. 📢
  • Team Assignment: Assign Minecraft teams based on voice chat status. 🛡️
  • Configurable Messages: Customize all messages and settings config.yml. 📝
  • Permission System: Restrict commands and bypass checks with pvaddsonsorter permissions. 🔒
  • Tab Completion: Smart command suggestions for admins. 💻
  • Lightweight & Robust: Easy to install, use, and performant on any server. ⚡

The VOICE mode (kicking players with voice chat) may be unstable be on stable on servers with high ping or frequent connection issues, as players might appear connected before stabilizing. Use with caution on laggy servers.

⚙️ How It Works

PvAddonSorter integrates with PlasmoVoice to monitor players voice chat status upon joining. It uses a delayed check (default: 3 seconds, configurable) to ensure accurate detection of PlasmoVoice via UDP. Based on the configured mode, it can:

  • Kick players who don't meet voice chat criteria.
  • Teleport players to an admin's location for events or team separation.
  • List players with or without voice chat.
  • Broadcast messages to specific groups.
  • Assign players to Minecraft teams.
  • Bypass checks for players with permissions.

The VOICE mode is sensitive to network latency. Adjust the check-time-in-seconds in config.yml for better reliability on high-latency servers.

📋 Requirements

  • Minecraft Server: Spigot/Paper 1.20.4 or 1.21+.
  • PlasmoVoice: Version 2.1.4 or higher (required dependency).

🎮 Use Cases

Scenario Command Result
Event requiring voice chat /sorter kick no-voice Kicks players without PlasmoVoice and prevents joining.
Event excluding voice chat /sorter kick voice Kicks players with PlasmoVoice and enforces no voice chat.
Organize voice chat users /sorter tp voice Teleports players with voice chat to the admin's location.
List players without voice chat /sorter list no-voice Displays a list of players without voice chat.
Announce to voice chat users /sorter broadcast voice Hello! Sends "Hello!" to players with voice chat.
Assign players to teams /sorter team voice VoiceTeam Assigns players with voice chat to the VoiceTeam team.
Reset restrictions /sorter kick nobody Disables voice chat checks, allowing everyone to join.

📜 Commands

Use the main command /sorter (or aliases /pvsorter, /pvsort) to manage the add-on. Below are the available subcommands:

Command Description Permission
/sorter kick <nobody|no-voice|voice> Sets kick mode and kicks players who don't meet criteria. pvaddsonsorter.admin
/sorter tp <voice|no-voice> Teleports players with or without voice chat to your location. pvaddsonsorter.admin
/sorter list <voice|no-voice> Lists players with or without voice chat. pvaddsonsorter.admin
/sorter broadcast <voice|no-voice> <message> Sends a message to players with or without voice chat. pvaddsonsorter.admin
/sorter team <voice|no-voice> <team-name> Assigns players with or without voice chat to a team. pvaddsonsorter.admin
/sorter reload Reloads the configuration file. pvaddsonsorter.admin

Example Usage:

  • /sorter kick no-voice – Kicks players without voice chat and prevents joining.
  • /sorter tp voice – Teleports players with voice chat to you.
  • /sorter list no-voice – Shows players without voice chat.
  • /sorter broadcast voice Join our Discord! – Sends "Join our Discord!" to voice chat users.
  • /sorter team no-voice NoVoiceTeam – Assigns players without voice chat to NoVoiceTeam.
  • /sorter reload – Reloads config.yml.

⚙️ Configuration

The plugin generates a config.yml file in plugins/pv-addon-sorter/. You can customize messages, kick reasons, and settings. Key options include:

  • check-time-in-seconds: Delay (in seconds) before checking voice chat status (default: 3).
  • Messages for commands (kick, tp, list, broadcast, team): Customize all in-game messages.
  • Kick reasons for NO-VOICE and VOICE modes.

🔐 Permissions

Control who can manage or bypass the add-on with these permissions:

Permission Description
pvaddonsorter.* Grants all add-on permissions (admin + bypass).
pvaddonsorter.admin Allows execution of all /sorter commands.
pvaddonsorter.bypass Exempts a player from being kicked by the add-on.

🛠️ Installation

  1. Download the latest pv-addon-sorter.jar from the Versions page.
  2. Place the .jar file in your server's plugins folder.
  3. Ensure PlasmoVoice is installed in the plugins folder.
  4. Start or restart your server to generate config.yml.
  5. Configure config.yml in plugins/pv-addon-sorter/ to customize messages and settings.
  6. Use /sorter reload to apply changes without restarting.

📝 License

This project is licensed under the MIT License. See the LICENSE for details.

⚠️ Notes & Limitations

  • Some features (like VOICE mode) may not be fully stable on high-latency servers.
  • The VOICE mode relies on detecting an active UDP connection, which may take a few seconds, potentially causing false positives.
  • Always test the add-on in a controlled environment before using it in a live event.

📊 Supported Versions

Minecraft Version Status
1.20.4 1.21+ ✅ Supported
Older ❌ Not tested

🐛 Bug Reports & Suggestions

Found a bug or have an idea to improve PvAddonSorter? Open an issue on our GitHub Issues page or message me on discord oluni_official ! 🗣️

💖 Credits

  • Author: Oluni_Official
  • Built for: PlasmoVoice
  • Inspiration: Making Minecraft events more dynamic and organized!

Thank you for using PvAddonSorter! Let's make voice chat management a breeze. 🎉