Getting Started

Overview

mineTeams is a team/guild management plugin for Paper and Folia servers. Players create teams with tags and names, invite members, set a base, use team chat, and climb player/team rankings driven by kills. Optional economy, team expiration, Redis multi-server sync, and PlaceholderAPI complete a full PvP network stack.

Features

Teams — create, invite, kick, promote/demote deputies, transfer leadership, disband
Team base — set and teleport to a shared base location
Friendly fire — per-team PvP toggle
Team chat — toggle mode or prefix character (e.g. !message)
Dashboard GUI — upgrade member slots and renew expiration
Ranking — Elo, percentage, or static point systems with abuse protection
Economy — Vault or item-based costs for create, slots, and renewal
Expiration — time-limited teams with join/periodic reminders
Multi-server — optional Redis pub/sub for teams, profiles, and chat
Multiple databases — H2, MySQL, MongoDB, or YAML (FLAT)
PlaceholderAPI — team and ranking placeholders
LuckPerms — prefix/suffix in messages and ranking placeholders when present
Folia support — region-aware task factory when Folia is detected
Developer API — public interfaces and team lifecycle events

Requirements

Java 25+
Paper 1.17+ (Folia supported)

Optional

PlaceholderAPI 2.11.6+
Vault (for Vault economy mode)
LuckPerms (prefix/suffix metadata)
Redis (multi-server synchronization)
MySQL or MongoDB (production storage)

Installation

Download the latest mineTeams-*-build.jar file
Place it in your server’s plugins/ folder
Start or restart the server
Edit the generated configuration files in plugins/mineTeams/
Set your license key in configuration.yml
Run /teamadmin reload to apply changes (or restart)

Configuration Files

After first startup, the following files are generated in plugins/mineTeams/:

File	Description
`configuration.yml`	Main settings (license, ranking, economy, expiration, database, Redis, chat)
`messages.yml`	Plugin messages (legacy color codes / MiniMessage)
`commands.yml`	Command names, aliases, permissions, and enable toggles
`guis.yml`	Team dashboard GUI layout and items

Quick Setup

Single server (H2)

Default storage is H2. Set the license key and you are ready:

license-key: "YOUR_LICENSE_KEY"

database:
  database-type: H2

Production (MySQL + Redis)

license-key: "YOUR_LICENSE_KEY"

database:
  database-type: MYSQL
  hostname: "localhost"
  base: "mineTeams"
  port: 3306
  username: "root"
  password: "securepass"

redis:
  enable: true
  host: "127.0.0.1:6379"
  password: "strongPass"
  server-id: "survival-1"

Use a unique server-id on every game server that shares Redis.

Next Steps

Page	Description
Commands	Player and admin commands with permissions
Configuration	Full `configuration.yml` reference
Teams & Members	Create, invite, roles, base, chat, panel
Ranking	Elo, percentage, static ranking and abuse protection
Economy & Expiration	Costs, slots, and team lifespan
Database & Redis	Storage backends and multi-server sync
PlaceholderAPI	Available placeholders
Developer API	Public interfaces and events