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

Updated the README

Browse Source
This commit is contained in:
Pascal Koenig
2011-08-27 19:29:40 +02:00
parent 518f2daeeb
commit d48898b8ad
1 changed files with 19 additions and 5 deletions
Download Patch File Download Diff File Expand all files Collapse all files

24
README.md
View File

@@ -2,19 +2,33 @@
This plugin for the Bukkit Minecraft Server API ([Homepage](http://bukkig.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). This plugin for the Bukkit Minecraft Server API ([Homepage](http://bukkig.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).
## Usage ## 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: 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 options.webserver-enabled: true
## Usage
Afterwards you can access the following xml files: Afterwards you can access the following xml files:
http://server:port/users.xml for a list of all known players on your server. For a list of all known players on your server:
http://server:port/userstats.xml for the stats of all known players
http://server:port/users.xml
For the stats of all known players:
http://server:port/userstats.xml
This will eventually be changed to a summarized view of all users stats as soon as the selection of users is implemented
The following commands are planned but not implemented yet: The following commands are planned but not implemented yet:
http://server:port/userstats.xml?id=username to fetch the stats of the given user To fetch the stats of the given user:
http://server:port/money.xml to get data provided by the iConomy plugin
http://server:port/userstats.xml?id=username
to get data provided by the iConomy plugin:
http://server:port/money.xml
http://server:port/money.xml?id=username self-explanatory http://server:port/money.xml?id=username self-explanatory