Plan/README.md

46 lines
3.5 KiB
Markdown
Raw Normal View History

2018-07-17 13:30:05 +02:00
# ![Player Analytics](http://puu.sh/AXSg7/5f2f78c06c.jpg)
2017-04-19 15:57:51 +02:00
2019-08-06 09:35:18 +02:00
[![Build Status](http://plan.djrapitops.com/buildStatus/icon?job=Player+Analytics%2Fmaster)](https://plan.djrapitops.com/blue/organizations/jenkins/Player%20Analytics/activity)
2018-12-18 08:33:09 +01:00
[![Discord](https://img.shields.io/discord/364107873267089409.svg?logo=discord)](https://discord.gg/yXKmjzT)
[![Quality Gate](https://sonarcloud.io/api/project_badges/measure?project=com.djrapitops%3APlan&metric=alert_status)](https://sonarcloud.io/dashboard?id=com.djrapitops%3APlan)
[![Maintainability](https://sonarcloud.io/api/project_badges/measure?project=com.djrapitops%3APlan&metric=sqale_rating)](https://sonarcloud.io/dashboard?id=com.djrapitops%3APlan)
[![Lines of Code](https://sonarcloud.io/api/project_badges/measure?project=com.djrapitops%3APlan&metric=ncloc)](https://sonarcloud.io/dashboard?id=com.djrapitops%3APlan)
[![Code coverage](https://sonarcloud.io/api/project_badges/measure?project=com.djrapitops%3APlan&metric=coverage)](https://sonarcloud.io/dashboard?id=com.djrapitops%3APlan)
[![Duplicate lines](https://sonarcloud.io/api/project_badges/measure?project=com.djrapitops%3APlan&metric=duplicated_lines_density)](https://sonarcloud.io/dashboard?id=com.djrapitops%3APlan)
[![Code Smells](https://sonarcloud.io/api/project_badges/measure?project=com.djrapitops%3APlan&metric=code_smells)](https://sonarcloud.io/dashboard?id=com.djrapitops%3APlan)
2018-04-08 19:26:53 +02:00
2017-04-19 15:57:51 +02:00
Player Analytics is a Bukkit plugin that gathers data about player activity & displays that data on an internal webserver.
Originally the plugin only displayed data of other plugins, but now it gathers it's own data, while displaying data from various other plugins.
2017-12-06 09:25:46 +01:00
![Image](https://puu.sh/yAt5H/2e5d955f97.jpg)
2017-04-19 15:57:51 +02:00
### Links
- [Spigot, Resource page](https://www.spigotmc.org/resources/plan-player-analytics.32536/)
- [Sponge Ore Page](https://ore.spongepowered.org/Rsl1122/Plan)
2017-04-19 15:57:51 +02:00
- [Issues & Suggestions](https://github.com/Rsl1122/Plan-PlayerAnalytics/issues)
- [License](https://github.com/Rsl1122/Plan-PlayerAnalytics/blob/master/LICENSE)
2017-04-19 15:57:51 +02:00
## Documentation
2017-10-01 20:49:44 +02:00
Documentation can be found [On the Wiki](https://github.com/Rsl1122/Plan-PlayerAnalytics/wiki)
2017-12-06 09:25:46 +01:00
2019-06-25 21:18:25 +02:00
## Building
You can build the project by running the following in the repository root
```
cd Plan
./gradlew shadowJar
```
- [More information about setting up the project](https://github.com/plan-player-analytics/Plan/wiki/Project-Setup)
2017-12-06 09:25:46 +01:00
## Used Libraries
- **[HighCharts](https://www.highcharts.com/)** | [Free for non-commercial](https://www.highcharts.com/products/highcharts/#non-commercial)
- **[AdminBSB Bootstrap template](https://gurayyarar.github.io/AdminBSBMaterialDesign/index.html)** | [MIT License](https://opensource.org/licenses/MIT)
- **[Bootstrap](https://v4-alpha.getbootstrap.com/)** | [MIT License](https://v4-alpha.getbootstrap.com/about/license/)
- **[Materialize](http://materializecss.com/about.html)** | [MIT License](https://github.com/Dogfalo/materialize/blob/master/LICENSE)
- **[jQuery Datatables](https://datatables.net/)** | [MIT License](https://datatables.net/license/mit)
- **[Font Awesome Icons](http://fontawesome.io/icons/)** | [SIL Open Font License](http://scripts.sil.org/cms/scripts/page.php?site_id=nrsi&id=OFL)
- **[MaxMind GeoIP2](https://www.maxmind.com/en/geoip-demo)** | [Creative Commons Attribution-ShareAlike 4.0 International License](https://creativecommons.org/licenses/by-sa/4.0/)
- **[H2 Database](http://www.h2database.com)** | [MPL 2.0](http://www.h2database.com/html/license.html#mpl2) or [EPL 1.0](http://www.h2database.com/html/license.html#eclipse_license)