# Overview Lead is a lightweight plugin that creates visual teams showcased in Civilization, Battle Royale, or SMP events. It provides a complete team management system with customizable names, colors, prefixes, and integration with TAB and PlaceholderAPI. --- ## What is Lead? Lead allows server owners to organize players into teams with visual identity. Each team receives a unique color and name that displays as a prefix or suffix on player nametags and in the TAB list. Teams persist across sessions and support features such as friendly fire control, team chat, invitations, and spawn locations. The plugin is developed by **Apollo** under the **Lodestone** organization and is available for free at [https://lode.gg/plugin/lead](https://lode.gg/plugin/lead). --- ## Features - **Team Creation and Management** — Players can create, join, leave, and disband teams through in-game commands. - **Customizable Team Names** — Teams can use player-defined names or auto-generated names from configurable lists (names, numbers, colors, or unicode symbols). - **Team Colors** — Each team receives a hex color that applies to prefixes, suffixes, and optionally player chat names. - **Prefix/Suffix Alignment** — Team labels display as either a prefix or suffix on nametags and the TAB list. - **Friendly Fire Toggle** — Control whether teammates can damage each other, configurable globally or per team. - **Collision Rules** — Set collision behavior per team: `ALWAYS`, `NEVER`, `FOR_OTHER_TEAMS`, or `FOR_OWN_TEAM`. - **Nametag Visibility** — Control nametag visibility per team with the same four options as collision. - **Team Chat** — Players can toggle team-only chat or send messages with `/teammsg`. - **Team Invitations** — Team members invite others who must accept before joining. - **Team Spawns** — Set and teleport to team spawn locations. - **Shuffle** — Randomly distribute online players across existing teams. - **Merge** — Combine two teams into one. - **Auto-Assign** — Automatically place joining players onto a team. - **Team List GUI** — Browse all teams through a paginated menu. - **Team Editor GUI** — Modify team properties through an interactive menu. - **TAB Integration** — When TAB is installed, Lead uses its API for nametag and tab list formatting, avoiding vanilla scoreboard limitations. - **PlaceholderAPI Support** — Exposes team data through placeholders: `%lead_team_id%`, `%lead_team_name%`, `%lead_team_size%`, `%lead_team_color%`. - **Custom Fonts** — Specify a custom font namespace for team display names. --- ## Use Cases Lead is designed for organized multiplayer events: - **Civilization Events** — Assign players to named factions with unique colors and team chat for coordination. - **Battle Royale Events** — Create small squads with friendly fire disabled and visual team identification. - **SMP Events** — Form persistent teams with spawn points, colored names, and collision rules for long-running survival worlds. --- ## Dependencies | Dependency | Required | Notes | |---|---|---| | Paper 1.20.4+ | Yes | Built against Paper API. Main class: `gg.lode.lead.LeadPlugin` | | Bookshelf | Soft | Enables Bookshelf-based chat listener. Falls back to Spigot chat listener if absent | | TAB | Soft | Recommended for large servers. Handles nametag and tab list formatting without vanilla scoreboard bugs | | PlaceholderAPI | Soft | Provides `%lead_team_id%`, `%lead_team_name%`, `%lead_team_size%`, `%lead_team_color%` | All-in-all, you **do not** need to install any additional plugins. --- ## Folia Support Lead is fully compatible with Folia. The `plugin.yml` declares `folia-supported: true`, and the plugin uses Bookshelf's `Task` utilities for thread-safe scheduling. --- ## Related Pages - [[Lead/Server Owners/Configuration]] — Full breakdown of every config.yml field. - [[Lead/Server Owners/Commands]] — Complete command and permission reference. - [[Lead/Developers/API Reference]] — Developer documentation for the Lead API.