socrates/XmlStats
1
0
Fork 0
Code Issues 8 Pull Requests Actions Packages Projects Releases Wiki Activity

Updated the readme file.

Browse Source
This commit is contained in:
Pascal Koenig
2011-09-25 15:38:22 +02:00
parent 78a8704ab9
commit a2f8e4e3cd
1 changed files with 20 additions and 8 deletions
Download Patch File Download Diff File Expand all files Collapse all files

28
README.md
View File

@@ -1,12 +1,10 @@
# XmlStats
# 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).
## 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. To enable the webserver of the plugin you have to edit the config.yml, set the following value and reload the server again:
options.webserver-enabled: true
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
@@ -22,19 +20,33 @@ Afterwards you can access the following xml files:
For a list of all known players on your server:
http://server:port/users.xml
http://server:port/user_list.xml
For the added up stats of all known players:
http://server:port/userstats.xml
http://server:port/user_stats.xml?sum=*
To fetch the stats of the given user:
http://server:port/userstats.xml?player=username
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/money.xml
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: