User Guide

Contains all the information relating to running the BattleTracker plugin.

Plugin Overview

BattleTracker is a standalone plugin that tracks PVP & PVE statistics along with a suite of combat features to enhance server gameplay.

BattleTracker tracks player statistics for both PVP and PVE combat. It also comes with a full suite of customizable features, such as death messages, combat logging, damage indicators and more. It also serves as the companion to BattleArena, and handles keeping track of arena and competition statistics.

Features

PVP and PVE Records

One of the core features of BattleTracker is its robust tracking system for PVP and PVE statistics. BattleTracker tracks a variety of statistics including kills, deaths, killstreaks, and more. These statistics are saved in MySQL or SQLite, allowing them to be shared across Minecraft servers, or accessed by web applications.

Leaderboards

Another feature BattleTracker includes is a leaderboard system that allows players to view the top players on the server based on various statistics.

Death Messages

BattleTracker provides customizable death messages that can be displayed to players when they are killed in PVP or PVE combat. These are easily configurable for each tracker type, and can be customized to fit the theme of your server.

Damage Recap

BattleTracker also includes a damage recap feature that displays a summary of the damage dealt and received by a player during combat. This can be summarized in multiple ways, such as which item dealt the most damage, a breakdown of players that dealt damage, or all the types of damage a player received.

Combat Logging

BattleTracker includes a combat logging feature that places players "in combat" when they attack another player. If they log out, they will be killed and their attacker will receive credit for the kill.

Damage Indicators

Inside BattleTracker, there is also support for damage indicators, which show to a player how much damage they inflicted on another player or entity.

Installation

Requirements

Downloading

  1. Download the BattleTracker plugin
  2. Stop your server and place the plugins in your plugins folder
  3. Start the server and BattleTracker will load

Features

Documentation for all the features that BattleTracker includes.

Features

PVP and PVE Trackers

One of the core features of BattleTracker is its robust tracking system for PVP and PVE statistics. BattleTracker tracks a variety of statistics including kills, deaths, killstreaks, and more. These statistics are saved in MySQL or SQLite, allowing them to be shared across Minecraft servers, or accessed by web applications. 

Configuration

By default, BattleTracker has support for both PVP and PVE tracking. These configurations can be found in the plugins/BattleTracker/trackers/pvp.yml and plugins/BattleTracker/trackers/pve.yml YML files respectively.

Recaps

By default, each tracker supports recaps, which recaps information about when a player took damage. This also includes information such as a player's inventory or armor at the time of the recap.

Options:

Tracked Statistics

Which statistics are tracked by a tracker. The options available are pvp, pve and world. By default, BattleTracker splits this into two trackers, with PVP tracking exclusively PVP data, and PVE tracking both PVE and world data.

Calculator

Which calculator is used to rank players in leaderboards. By default, this is elo. As of BattleTracker 4.0.0, only elo is supported.

Killstreaks

Whether the killstreak feature is enabled. A killstreak occurs when a player kills a certain number of players in a row without dying.

Options:

Rampage

Whether the rampage feature is enabled. A rampage occurs when a player kills a certain number of players in a short amount of time.

Options:

Features

Death Messages

BattleTracker provides customizable death messages that can be displayed to players when they are killed in PVP or PVE combat. These are easily configurable for each tracker type, and can be customized to fit the theme of your server.

Configuration

Player

Player death messages are death messages that occur when a player dies due to another player. 

By default, these come pre-configured in the pvp.yml, and are configured in conjunction with the item type that is used to kill the player. Additionally, Minecraft Item Tags are also able to be used, allowing you to configure death messages for similar types of items, denoted by a pound/hashtag (#) symbol (i.e. #axes for all axes, #pickaxes for all pickaxes, etc.)

Variables:

World

World death messages are death messages that occur when a player dies due to a world event, such as suffocating in sand, burning in lava, or anything that does not involve a death by an entity or player.

By default, these come pre-configured in the pve.yml, and can be set for any Damage Cause.

Variables:

Entity

Entity death messages are death messages that occur when a player is killed by an entity. This does not include players, or world events.

By default, these come pre-configured in the pve.yml, and can be set for any Minecraft Entity, using it's official identifier.

Variables:

Features

Damage Recaps

BattleTracker also includes a damage recap feature that displays a summary of the damage dealt and received by a player during combat. This can be summarized in multiple ways, such as which item dealt the most damage, a breakdown of players that dealt damage, or all the types of damage a player received.

By default, BattleTracker allows for recapping damage based on players, entities, items and cause. The image below demonstrates how this is shown to players:

Configuration

Configuration for damage recaps can be found in the PVP and PVE Tracker configuration page.

Features

Combat Logging

BattleTracker includes a configurable combat logging feature that places players "in combat" when they attack another player. If they log out, they will be killed and their attacker will receive credit for the kill.

Configuration

The combat logging configuration can be found in the plugins/BattleTracker/features/combat-log.yml YML file. 

Options:

Features

Damage Indicators

Inside BattleTracker, there is also toggleable damage indicators, which show to a player how much damage they inflicted on another player or entity.

Configuration

The combat logging configuration can be found in the plugins/BattleTracker/features/damage-indicators.yml YML file. 

Options:

Commands

Tracker Commands

These are the commands present for any tracker. By default, these will include /pvp and /pve.

Command
Description
/<tracker> top [max]
View the top players of this tracker.
/<tracker> rank [player]
View the rank of a player in a tracker.
/<tracker> versus <player> [target]
Compare the stats of two different players.
/<tracker> recap [player]
View the last damage recap of a player.

Permissions

Permission Description
battletracker.command.top
Permission for the /<tracker> top command.
battletracker.command.rank
Permission for the /<tracker> rank command.
battletracker.command.versus
Permission for the /<tracker> versus command.
battletracker.command.recap
Permission for the /<tracker> recap command.
battletracker.combatlog.bypass
Whether a player will bypass the combat log (if enabled). Requires that allow-permission-bypass is enabled in the Combat Log config.

Plugin Integrations

Integrations with third party plugins to extend BattleTracker functionality.

Plugin Integrations

Placeholder API


Within BattleTracker, there is support to display tracker info through a plugin called PlaceholderAPI. If you are unfamiliar with the plugin, it allows for you to show information with certain placeholders (e.g. %player_name% will return the player name) in plugins that have support for PlaceholderAPI. An example usage of this is displaying your PVP kills through BattleTracker on a scoreboard through PlaceholderAPI.

If you also have BattleArena installed, you can display tracker information from it too. An example usage of this is displaying the top players in arena. The support for these placeholders even extends to custom arena games you have created or even plugins that hook into BattleTracker directly for stats.

Placeholders

These are the placeholders for BattleTracker. They are split into two sections: player placeholders and rating placeholders. Player placeholders get information on the player that "sees" the placeholder. The rating placeholders get information about players for the rating you specify.

Player Placeholders

These placeholders show statistics for the player viewing the information. This information will look different to each player seeing it in-game. <tracker> below can be replaced with any tracker BattleTracker has registered (i.e. pvp, pve).

If you are using BattleArena, replace the tracker name with the name of your arena.

Rating Placeholders

These placeholders show statistics for the top players. The placeholder must be specified with a rating at the end. <tracker> below can be replaced with any tracker BattleTracker has registered (i.e. pvp, pve). <rating> below can be replaced with the rating you want to get placeholder information from. For example, 1 will get information from the #1 player on the leaderboard.

Additionally, if you wish to get the name or UUID of the user that holds a certain rating, you can add _name or _uuid to the end of the placeholder (i.e. %bt_<tracker>_top_kills_<rating>_name%).

If you are using BattleArena, replace the tracker name with the name of your arena.