From a2f8e4e3cdd160ddfd1cc688ac4f1125879fb3ce Mon Sep 17 00:00:00 2001 From: Pascal Koenig Date: Sun, 25 Sep 2011 15:38:22 +0200 Subject: [PATCH] Updated the readme file. --- README.md | 28 ++++++++++++++++++++-------- 1 file changed, 20 insertions(+), 8 deletions(-) diff --git a/README.md b/README.md index aaf5280..d5cea27 100644 --- a/README.md +++ b/README.md @@ -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: