Files
XmlStats/README.md
2012-02-03 15:19:26 +01:00

55 lines
2.0 KiB
Markdown

# XmlStats v0.3
This plugin for the Bukkit Minecraft Server API ([Homepage](http://bukkit.org) | [Github](https://github.com/Bukkit/Bukkit )) offers the possibility to access some playerstats via xml files. The provided data is basically generated by [Stats](https://github.com/nidefawl/Stats).
[![Flattr this git repo](http://api.flattr.com/button/flattr-badge-large.png)](https://flattr.com/submit/auto?user_id=socke&url=https://github.com/sockenklaus/XmlStats&title=XmlStats&language=&tags=github&category=software)
## Install
To install the plugin, simply place the compiled **XmlStats.jar** in your servers plugin directory and execute the /reload-command on your server. The plugin will create it's config file in the /plugins/XmlStats directory.
## Usage
### Game side
At this time of the development an Op is able to reload the plugin without reloading the whole server:
/xmlstats reload
### Browser side
Afterwards you can access the following xml files:
For a list of all known players on your server:
http://server:port/user_list.xml
For the added up stats of all known players:
http://server:port/user_stats.xml?sum=*
To fetch the stats of the given user:
http://server:port/user_stats.xml?user=username
Or to fetch the stats of a list of users:
http://server:port/user_stats.xml?user=user1,user2
You can combine these parameters, so you can receive the sum of some users and specific stats:
http://server:port/user_stats.xml?sum=user1,user2&user=*
To get data provided by the iConomy plugin:
http://server:port/user_balances.xml?user=*
http://server:port/user_balances.xml?sum=*
Also you can request achievement data provided by the achievements plugin via:
http://server:port/achievements_list.xml
http://server:port/user_achievements.xml?user=*
You can request gzip compressed files by using the parameter gzip=true. This works on all files:
http://server:port/userstats.xml?gzip=true