Skip to content
master
Go to file
Code

README.md

MinecraftStats

MinecraftStats is a web browser application for the statistics that Minecraft servers collect about players.

The presentation is done by giving awards to players for certain achievements. For example, the player who played on the server for the longest total time receives the Addict award. Every award has a viewable ranking associated to it with medals - the award holder gets the gold medal, the second the silver medal and the third the bronze medal for the award. Each medal gives players a crown score (1 for every bronze medal, 2 for every silver, 4 for every gold medal), which is displayed in a server hall of fame.

The system is highly customizable. All the awards are defined in Python modules that can be altered, added or removed to fit your needs. Additionally to simply reading Minecraft's original statistics, there are some awards that are combinations of various statistics.

A live demo of MinecraftStats in action is available here: DVG Snapshot Stats

Setup Guide

This section describes how to set up MinecraftStats to work on your server.

Compatibility

MinecraftStats is compatible only to Minecraft 1.13 or later (more precisely: snapshot 17w47a or later).

I am trying to keep the statistics up to date with new Minecraft versions. However, Mojang sometimes decide to rename entity or statistic IDs, which may break some awards. I am trying my best to update accordingly, but please don't hesitate to open an issue in case you notice something is wrong!

Requirements

Python 3.4 or later is required to feed MinecraftStats with your server's data.

Installation

I recommend using git to check out the master branch of this repository somewhere under your webserver's document root (e.g. /var/www/html), as it makes updating easier (see below).

git clone https://github.com/pdinklag/MinecraftStats.git

However, downloading the repository as a zip file and unpacking it there will work as well.

The web application is accessed via index.html - so you'll simply need to point your players to the URL corresponding to the installation path.

Updating MinecraftStats

To update MinecraftStats to a newer version, if you are using git, the following will do the trick:

git pull

Otherwise, re-download the repository and overwrite any existing files.

Feeding The Data

The heart of MinecraftStats is the update.py script, which loads the player statistics from your Minecraft server into the database for the web application. Said database is file-based and will be stored in the data directory by default.

To call the update script, simply go into the installation directory and execute the following:

python3 update.py config.json

When you do this for the first time, the file called config.json will be created for you with a default configuration.

You will also receive the following message:

server.path not configured, please edit config.json

This is because MinecraftStats does not yet know where your Minecraft server is installed. So go ahead and enter the path to your Minecraft server under the server > path setting in config.json. See below for more configuration possibilities.

Configuration

The configuration JSON file supprots the following settings:

  • client
    • playerCacheUUIDPrefix - short explanation: do not touch. Determines player cache grouping by UUIDs. Most of the time you should leave the default value of 2 untouched. If you have many active players on your server (e.g., thousands) and wish to reduce traffic and load times somewhat, you may try increasing this to 3 to see if it helps. Note that increasing this value will increase the number of files under data/playercache exponentially (!), so handle with care (default: 2).
    • playersPerPage - how many players to display at most in the players list (default: 100).
    • showLastOnline - if true, the last online date and time will be displayed for players (default: true).
  • configVersion - used internally, do not change manually.
  • crown
    • bronze - the crown score worth of a bronze medal (default: 1)
    • silver - the crown score worth of a silver medal (default: 2)
    • gold - the crown score worth of a gold medal (default: 4)
  • events - see below in the Events section.
  • players
    • exclude - a list of UUIDs to exclude from the stats (default: empty)
    • excludeBanned - if true, exclude players listed in banned-players.json from the stats (default: true)
    • excludeOps - if true, exclude players listed in ops.json from the stats (default: false)
    • inactiveDays - if a player is inactive for this many days, they will no longer be eligible for any awards (default: 7)
  • minPlaytime - only players having played this many minutes or more will be eligible for awards (default: 0)
    • profileUpdateInterval - update player names and skins using the Mojang API every this many days (default: 3)
    • updateInactive - also update names and skins of inactive players (not recommended) (default: false)
  • server
    • customName - the server name to display on the home page. Leave this at null to use the MOTD from your server.properties (default: null)
    • path - the path to your Minecraft server installation (no default).
    • worldName - the name of the world on the server that contains the player statistics (stats directory with JSON files in it). In most cases, this is simply world (default: world).
Migrating Command-Line Configurations

If you have been using MinecraftStats before the configuration was changed to JSON-based, you can use the makeconfig.py script with all your old arguments to generate the corresponding JSON configuration, for example:

python3 makeconfig.py -s /path/to/server --min-playtime 60 > config.json

Note that the way how events are started and stopped has changed. You will find the new information in the Events section.

Troubleshooting

You may encounter the following messages during the update:

  • update.py: error: unrecognized arguments: ... - if you are sure that everything is right, it may be that when you last used MinecraftStats, configuration was still done via the command line. This has changed and you need to switch to the JSON based configuration described above. You can call makeconfig.py with the old list of arguments to create a JSON file from it to make the process easier.

  • updating profile for <player> ... - the updater needs to download the player's skin URL every so often using Mojang's web API ,so that the browser won't have to do it later and slow the web application down. If this fails, make sure that Python is able to open https connections to sessionserver.mojang.com.

  • HTTP Error 429 - Mojang has some limitations on their API that MinecraftStats uses to get player skins. If too many requests for the same player are done within a certain time frame (the exact specs are not known to me), Mojang's API refuses the request with a 429 code. This normally shouldn't happen if you use the default profile update interval.

  • unsupported data version 0 for <player> - this means that <player> has not logged into your server for a long time and his data format is still from Minecraft 1.12.2 or earlier.

In case you encounter any error messages and can't find an explanation, don't hesistate to open an issue.

After the update, you will have a data directory that contains everything the web application needs; refer to the Database Structure section for details.

Automatic Updates

MinecraftStats does not include any means for automatic updates - you need to take care of this yourself. The most common way to do it on Linux servers is by creating a cronjob that starts the update script regularly, e.g., every 10 minutes.

If you're using Windows to run your server... figure something out!

FTP

In case you use FTP to transfer the JSON files to another machine before updating, please note that MinecraftStats uses a JSON file's last modified date in order to determine a player's last play time. Therefore, in order for it to function correctly, the last modified timestamps of the files need to be retained.

Database Structure

The data directory will contain the following after running an update:

  • summary.json.gz - This is a summary for the web application, containing information about the server and everything needed to display the award listing.
  • server-icon.png - if your server has an icon, this will be a copy of it. Otherwise, a default icon will be used.
  • events - contains one JSON file for every event containing player scores.
  • playercache - cache of player names and skin IDs, grouped by player UUIDs.
  • playerdata - contains one JSON file for every player, containing information displayed in the player view.
  • playerlist - contains an index for player information used by the player list.
  • rankings - contains one JSON file for every award containing player rankings.

Events

Events allow you to track a specific award stat for a limited amount of time. You can plan events via the events list in the config JSON. The following information needs to be specified for an event:

  • name - the unique internal name of the event, which needs to be a valid file and URL name, i.e., you should not use spaces or special characters here. Every event needs a different name, even if they share the same title.
  • title - the title of the event displayed in the browser.
  • stat - the ID of the award stat counted for the event. An easy way to find these IDs is by clicking an award in the browser and getting it from the URL.
  • startTime - the time at which the event starts in YYYY-MM-DD HH:MM format (4-digit year followed by 2-digit month, day, hour and minute).
  • endTime - the time at which the event ends (same format as startTime).

When you run update.py, events will automatically be started or stopped based on the current server time.

Event Example

As an example, let's consider a Halloween-themed event called "Skeleton Hunt" that tracks how many skeletons people kill between October 30, 10 o'clock in the morning and midnight of November 1. We would add the following to the config JSON:

...
	"events": [
        {
            "name": "skeleton_hunt_2020",
            "title": "Skeleton Hunt",
            "stat": "kill_skeleton",
            "startTime": "2020-10-30 10:00",
            "endTime": "2020-01-01 00:00"
        }
    ],
...

Customizing Awards

I assume here that you have some very basic knowledge of Python, however, you may also get away without any.

update.py imports all modules from the mcstats/stats directory. Here you will find many .py files that define the awards in a pretty straightforward way.

Any changes will be in effect the next time update.py is executed.

Adding New Awards

For adding a new award, follow these steps:

  1. Create a new module in mcstats/stats and register your MinecraftStat instances (see below).
  2. Place an icon for the award in img/award-icons. If your award ID is my_award, the icon's file name needs to be my_award.png.

The MinecraftStat Class

A MinecraftStat object consists of an ID, some meta information (title, description and a unit for statistic values) and a StatReader.

The ID is simply the award's internal identifier. It is used for the database and the web application also uses it to locate the award icon (img/award-icons/<id>.png).

The meta information is for display in the web application. The following units are supported:

  • int - a simple integer number with no unit.
  • ticks - time statistics are usually measured in ticks. The web application will convert this into a human readable duration (seconds, minutes, hours, ...).
  • cm - Minecraft measures distances in centimeters. The web application will convert this to a suitable metric unit.

The StatReader is responsible for calculating the displayed and ranked statistic value. Most commonly, this simply reads one single entry from a player's statistics JSON, but more complex calculations are possible (e.g., summing up various statistics like for the mine_stone.

There are various readers, the usage of which is best explained by having a close look to the existing awards. If you require new types of calculations, dig in the mcstats/mcstats.py file and expand upon what's there.

Modifying and Removing Awards

In order to modify or remove an award, find the corresponding module and modify or delete it to suit your needs.

Note that some awards, e.g., all the mob kill awards, are grouped into a single python file.

Development Notes

This section contains some hints for those who want to develop on MinecraftStats.

JavaScript and CSS minimization

In an effort to reduce client traffic, the JavaScript and CSS files of the web UI are minified. The JavaScripts are minified using terser. Refer to the minimize.sh script located in the js directory for the command-line used to do so. For CSS minimization, I use uglifycss without any special command-line parameters.

License and Attribution

MinecraftStats is released under the Creative Commons BY-SA 4.0 license. This means you can pretty much use and modify it freely, with the only requirements being attribution and not putting it under restrictive (e.g., commercial) licenses if modified.

Concerning the attribution part, the only requirement is that you provide a visible link to this original repository in your installment. The easiest way to do this is by not removing it from the index.html footer, where you will also find a reminder about this.

About

A Minecraft player statistics browser for the web - supports 1.13 to 1.16!

Resources

License

Releases

No releases published

Packages

No packages published
You can’t perform that action at this time.