Getting started

Introduction

What ExyliaCombat is, the sixteen modules it ships, what it needs to run and how this documentation is organised.

ExyliaCombat is a combat tag plugin, and everything a PvP server builds round it. A player who hits another, or is hit, is tagged for a while; logging out during that time is punished, and a tagged player is kept from running away: no commands, no teleports, no flight, no walking into a safe zone. All of it is split into sixteen modules that switch on and off on their own: besides the restrictions, the barrier and the logout NPC there are item cooldowns, a PvP switch, protection for new players and after a respawn, stats and leaderboards, anti kill-farming, kill rewards and streaks, death messages, nametags, loot protection and a combat tag that follows a player across a proxy network.

Every Exylia plugin asks ExyliaLib's Combat facade who is fighting, and ExyliaCombat is what answers. So ExyliaSpecials, ExyliaClans, ExyliaMines and the rest agree on who is in combat without each keeping a timer of its own.

It is a premium plugin, installed through a licence loader. See Installation.

Who decides the tag

ExyliaCombat tags players itself, but it can also leave that to another combat plugin already on the server (DeluxeCombat, CelestCombat or PvPManager) and add its modules on top. See Combat tag.

The modules

Each module is switched on or off in config.yml under modules, and keeps its settings in modules/<module>/config.yml and its text in lang/<language>/modules/<module>/messages.yml. A module that is off registers no listener, command, placeholder or timer.

Module	Default	What it does
`action-bar`	on	The combat timer and item cooldowns above the hotbar.
`combat-display`	on	Boss bar, titles and sounds for the tag.
`combat-nametag`	off	A colour, prefix, suffix or glow on the names of tagged players.
`combat-restrictions`	on	What a tagged player cannot do: commands, inventories, teleports, safe zones, flight, elytra, blocks, items, potions.
`pvp-barrier`	on	A wall drawn at the edge of a safe zone while tagged, solid by default.
`logout-npc`	on	A combat logger leaves an NPC wearing their gear behind.
`vanilla-cooldowns`	on	Cooldowns on ordinary items, per world and per region.
`pvp-toggle`	on	`/pvp`: players switch their own PvP on and off.
`newbie-protection`	on	First-time players cannot fight or be hit for a while.
`respawn-protection`	off	A few seconds of protection after respawning.
`loot-protection`	off	After a PvP kill, only the killer can pick up the drops for a while.
`stats`	on	Kills, deaths, KDR, streaks, points, `/pvpstats` and the leaderboards.
`kill-abuse`	on	Catches kill farming: the same victim over and over, alts on one address, brand-new accounts.
`kill-rewards`	on	Money, experience, rewards, streak milestones and bounties for PvP kills.
`death-messages`	on	One message per damage cause for deaths caused by a player.
`cross-server`	off	Keeps the tag when a player switches server on a proxy network.

What is included

Combat tag

How a player is tagged, the providers, /combat, the action bar, the boss bar and the nametags.

Logging out

The punishment, who is spared, the broadcast, the Discord webhook and the logout NPC.

Restrictions

Every rule a tagged player is under, safe zones and the PvP barrier.

Protection

The PvP switch, newbie protection, respawn protection and loot protection.

Item cooldowns

Pearls, golden apples, totems and fireworks, with combat, world and region values.

Stats

Kills, deaths, points, /pvpstats, /combattop and the death messages.

Kill rewards

Kill farming checks, money and experience, streak milestones and bounties.

Networks

The tag across a proxy, and the player record shared through Redis.

Requirements

Requirement	Detail
Server	Paper 1.21.1 or newer, or a fork of it. Folia 1.21.4 or newer. The skinned logout mannequin needs 1.21.9.
Java	21
Required dependencies	`ExyliaLib`, installed for you if it is missing
Optional dependencies	`packetevents`, `PlaceholderAPI`, `WorldGuard`, Lands, GriefPrevention, Towny, SuperiorSkyblock2, DeluxeCombat, CelestCombat, PvPManager, Apollo (Lunar) and Feather's server API. See Integrations.

About ExyliaLib

Configuration and migrations, menus and prompts, the database and its Redis sync, cooldowns, the action bar, boss bars and titles, rewards, the economy, regions, clans and the Combat facade other plugins read all come from ExyliaLib. ExyliaCombat is written on top of it and does not run without it, which is why the loader installs it on a server that lacks it.

Languages

The plugin ships English, Spanish, Portuguese, French, Russian and Turkish (en, es, pt, fr, ru, tr): every message, every module's text and every menu. See Configuration.

Something missing on this page? Tell us on Discord