Teams API

[!(https://github.com/ez-plugins/teams-api/actions/workflows/ci.yml/badge.svg)](https://github.com/ez-plugins/teams-api/actions) [!(https://codecov.io/gh/ez-plugins/teams-api/branch/main/graph/badge.svg)](https://codecov.io/gh/ez-plugins/teams-api) [!(https://img.shields.io/github/license/ez-plugins/teams-api)](LICENSE) [!(https://jitpack.io/v/ez-plugins/teams-api.svg?v=3)](https://jitpack.io/#ez-plugins/teams-api)

The universal bridge between team plugins and everything else.

TeamsAPI is a passive, server-side bridge plugin for Paper, Spigot, Purpur, and Folia servers, inspired by Vault. It provides a single, stable interface for team operations, so any plugin that needs team data can work with any compatible team plugin, without either plugin knowing about the other.

Implemented in our refactored Factions fork: (https://modrinth.com/plugin/pvpindex-factions)

## How it works

!(https://i.ibb.co/VpzgC9SK/teams-api-header.png)

• Providers - faction, clan, guild, or custom team plugins `implement TeamsService`
• and register with TeamsAPI during `onEnable()`.
• Consumers - scoreboard plugins, chat formatters, quest plugins, or any plugin that
• needs team data call `TeamsAPI.getService()` and use the returned interface.
• Server owners - install `TeamsAPI.jar` and one compatible team plugin. Done.

No two plugins need to know about each other. When the team plugin changes, every consumer plugin keeps working without a recompile.

## Features

• Official extensions: ready-to-use provider bridges for (https://www.spigotmc.org/resources/betterteams. 17664/), (https://modrinth.com/plugin/towny), and (https://www.spigotmc.org/resources/kingdomsx. 77782/), bundled inside the main JAR. Install in-game with `/teamsapi install `.
• Provider-agnostic: works with any team plugin that ships a `TeamsService` implementation.
• Graceful fallback: if no provider is present, `TeamsAPI.isAvailable()` returns `false`; consumers can disable their team features cleanly instead of crashing.
• Read-only snapshots: `Team` and `TeamMember` are immutable interfaces; providers own the backing data.
• Role hierarchy: built-in `OWNER > ADMIN > MEMBER` with `outranks()` and `canManage()` helpers.
• Optional invite service: providers can expose `TeamsInviteService` for invitation workflows.
• Optional warp service: providers can expose `TeamsWarpService` for named team warps.
• Optional chest service: providers can expose `TeamsChestService` for team chest contents and add/remove operations.
• Optional claim service: providers can expose `TeamsClaimService` for chunk-claim management, including SafeZone and WarZone territory support.
• Optional power service: providers can expose `TeamsPowerService` for player and team power values.
• Optional power-history service: providers can expose `TeamsPowerHistoryService`
• for reading and managing player/team power-history entries.
• Optional relation service: providers can expose `TeamsRelationService` for inter-team diplomacy (ally/truce/neutral/enemy).
• Optional notification service: providers can expose `TeamsNotificationService` for
• cross-plugin player notifications using built-in enum types and custom string types.
• Custom subcommands: any plugin registers a `TeamsSubcommand` via `TeamsAPI.registerSubcommand()`; team plugins call `TeamsAPI.getSubcommands()` in their own command handler to dispatch them, extending the command tree without coupling.
• Cancellable events: fifteen Bukkit events that providers can fire so other plugins can react to or cancel team operations.
• Lightweight: a single shaded JAR with no required runtime dependencies beyond the Bukkit API (optional: (https://github.com/MilkBowl/VaultAPI) for the built-in power shop).
• JitPack-ready: depend on just the API module at compile time; no transitive dependencies leak into your plugin.
• Velocity bridge (experimental): optional `teams-api-velocity` plugin for querying team data from the Velocity proxy. Supports multi-proxy networks via Redis.
• BungeeCord bridge (experimental): optional `teams-api-bungeecord` plugin for querying team data from BungeeCord / Waterfall proxies. Supports multi-proxy networks via Redis.

## Requirements

| Requirement | Value | |-------------|-------| | Server software | Paper / Spigot / Purpur / Folia 1. 16+ | | Java | 17+ (25 recommended) | | Plugin dependencies | None (optional: (https://github.com/MilkBowl/VaultAPI) for power shop) |

## Installation (server owners)

1. Download `teams-api-plugin-VERSION.jar` from the Files tab of this listing or from (https://github.com/ez-plugins/teams-api/releases). 2. Drop it into your server's `plugins/` directory. 3. Install a compatible team pl