wurstmineberg / api.wurstmineberg.de Goto Github PK

An API Server using bottle.py that exposes minecraft server data via JSON

Python 100.00%

api.wurstmineberg.de's Introduction

Note: This repository only hosts versions 1 and 2 of the API, which are no longer operational. Version 3 can be found at https://github.com/wurstmineberg/wurstmineberg.de/blob/master/wurstmineberg_web/api.py.

This is Wurstmineberg's Minecraft API, an API server using bottle.py that exposes Minecraft server data via JSON. It is not to be confused with Minecraft's official API which is currently in development.

It can be found live on http://api.wurstmineberg.de/.

This is version 2.5.0 of the API (semver). A list of available endpoints along with brief documentation can be found on its index page.

Requirements

Python 3.4
Pillow 3.0 (required for image-producing endpoints only)
bottle 0.12
mcstatus 2.1 (required for world status endpoints only)
minecraft-backuproll 0.1 (required for world backup endpoints only)
more-itertools 2.2
nbt 1.4
people (required for people.json features only)
playerhead 3.0 (required for skin rendering endpoints only)
python-anvil (required for chunk endpoints only)
requests 2.7
systemd-minecraft

Configuration

If you are using nginx, you can for the most part follow this guide. Just use api.py instead of writing your own app.py as in the guide, and make sure to install uwsgi-plugin-python3 and python3-bottle instead of their Python 2 counterparts.

If you're using the Apache httpd or another web server, you're on your own for setting up the API.

Some endpoints use logs generated by wurstminebot. If you don't run a wurstminebot on your server, you will have to provide logs in a compatible format in order to use these endpoints.

You can provide a configuration file in /opt/wurstmineberg/config/api.json to customize some behavior. Here are the default values:

{
    "cache": "/opt/wurstmineberg/api-cache",
    "host": "wurstmineberg.de",
    "jlogPath": "/opt/wurstmineberg/jlog",
    "logPath": "/opt/wurstmineberg/log",
    "moneysFile": "/opt/wurstmineberg/moneys/moneys.json",
    "webAssets": "/opt/git/github.com/wurstmineberg/assets.wurstmineberg.de/master",
    "worldHost": "wurstmineberg.de"
}

api.wurstmineberg.de's People

Contributors

Stargazers

Watchers

Forkers

xlrdx fenhl

api.wurstmineberg.de's Issues

Backup downloads

A replacement for http://wurstmineberg.de/assets/latestbackup.tar.gz that has multiworld support and doesn't break when a new backup is made during the download.

Possibly using minecraft-backuproll to find the locations of the latest backup files?

chunk data access

There should be a way to access chunk data through the API. Ideally after 2.0 for multiworld support.

Move Death Games endpoint

The endpoint is /deathgames/log.json, but it should be /minigame/deathgames/log.json. Since this is a backwards-incompatible API change, it would require a major version bump.

Allow fallback to Minecraft nicks when people.json is missing

Some endpoints currently fail when people.json cannot be loaded, even though their basic functionality could easily be made available without it.

Fox example, /server/deaths/latest.json works fine as long as there is something that creates the deaths log, even if no people file is present.

These endpoints should fall back to using Minecraft nicknames or UUIDs instead of erroring.

minecraftlib

Separate the backend that reads the data into its own Python module (called minecraftlib), so that it can also be used by wurstminebot for features like !Weather.

playerstats/item.json contains "stat.drop"

The /server/playerstats/item.json contains a rogue stat named stat.drop. IIRC, this would be the summary statistic for the drop.$item stats and should be included in /server/playerstats/general.json and does not need to be in the items endpoint.

Player skin endpoints

Effectively an on-demand replacement for playerhead, providing endpoints for both head-only and front-view skin images at different sizes.

Actually using playerhead to generate the images is probably the easiest implementation.

Add file extensions to endpoints

The following endpoints are missing file extensions:

/minecraft/items/by-damage/:item_id/:item_damage
/minecraft/items/by-id/:item_id
/server/maps/by-id/:identifier
/server/playerdata/by-id/:identifier
/server/playerstats/by-id/:identifier

playerstats/general.json endpoint includes stat.pickup.* and stat.drop.*

The playerstats/general endpoint should not included drop and pickup stats for all the items, they should rather be included in playerstats/item.json.

/server/playernames.json not listing players with a player data file

The /server/playernames.json is supposed to list the Minecraft nicknames of everyone on the whitelist, as well as everyone with a player data file in the world directory. For Minecraft 1.7.6 and higher, the location of these files has moved, and the endpoint fails to include the player data files in the response.