Skip to content

1. Getting Started

Terry edited this page May 2, 2023 · 1 revision

Welcome to the StatsAPI wiki!

Installation

Step 1: Download the plugin here and install it on your server.
Step 2: Edit config.yml in plugins/StatsAPI folder and setup your MySQL-Configuration and restart the server.
Step 3: You're done! StatsAPI is now running on your server.

Plugin

Commands

Overview of the commands provided by StatsAPI:

Command Usage Description Permission
/stats <player> Show stats of a player stats.show
/astats or /ap <player> <datatype> <new value> Edit stats of a player stats.admin

List of available datatypes:

KILLS, DEATHS, WINS, LOSES, GAMES_PLAYED, STREAK, GAME_POINTS

Configuration

Overview of the config.yml in plugins/StatsAPI:

mysql:
  host: localhost
  port: 3306
  database: stats
  user: root
  password: password

# If this option is enabled, the Game Points will be synchronized with the PointsAPI.
# Requires PointsAPI installed on the server: https://github.com/teraprath/PointsAPI
use_points_api: false

language:
  prefix: "&8[&cStats&8] "
  player_not_found: "&7Player &4%player% &7not found."
  player_stats_update: "&4%player%'s &7%datatype% has been set to &c%amount%."
  wrong_usage: "&7Wrong usage: &c%usage%"

  # Stats command
  # Placeholder: %player_stats%, %kills%, %deaths%, %wins%, %loses%, %games_played%, %streak%, %game_points%
  stats:
    - "&8&m-------------------"
    - ""
    - "&4%player%'s &7Stats"
    - ""
    - "&7Kills: &c%kills%"
    - "&7Deaths: &c%deaths%"
    - "&7Wins: &c%wins%"
    - "&7Loses: &c%loses%"
    - "&7Games Played: &c%games_played%"
    - "&7Streak: &c%streak%"
    - "&7Game Points: &c%game_points%"
    - "&8&m-------------------"

IMPORTANT: It's recommended to restart the server to save changes.

Clone this wiki locally