Skip to content

README.md

Latest commit

 

History

History
49 lines (33 loc) · 1.46 KB

README.md

File metadata and controls

49 lines (33 loc) · 1.46 KB
Raw

ZCoreAPI

A Bukkit plugin that exposes ZCore player statistics over HTTP.

Built for Minecraft Beta 1.7.3 servers running Tsunami and ZCore.

Endpoints

Endpoint Description
GET /api/server Server status, player count, total economy, total playtime
GET /api/players/online List of online players with stats
GET /api/leaderboard All players with stats
GET /api/players/:name Single player lookup with full stats and balance

Player fields

name, kills, deaths, playtime, playtime_ms, blocks_placed, blocks_broken, mobs_killed, damage_dealt, damage_taken, blocks_traveled, first_join, last_join, online, rank, prefix, balance (player lookup only)

Requirements

Building

  1. Run mvn package
  2. Output JAR is in target/ZCoreAPI-1.0.0.jar

Installation

  1. Drop the built JAR into your server's plugins/ folder
  2. Start the server
  3. A config.properties file is generated in plugins/BMC-WebStats/

Configuration

plugins/BMC-WebStats/config.properties:

port=6465
cors-origin=*
Option Description Default
port HTTP server port 6465
cors-origin Allowed CORS origin (* for any, or a specific domain) *