2018-07-17 19:30:05 +08:00
# ![Player Analytics](http://puu.sh/AXSg7/5f2f78c06c.jpg)
2017-04-19 21:57:51 +08:00
2020-02-27 16:02:45 +08:00
![Github Actions ](https://github.com/plan-player-analytics/Plan/workflows/Java%20CI/badge.svg )
2018-12-18 15:33:09 +08:00
[![Discord ](https://img.shields.io/discord/364107873267089409.svg?logo=discord )](https://discord.gg/yXKmjzT)
2020-06-20 03:13:15 +08:00
[![Quality Gate ](https://sonarcloud.io/api/project_badges/measure?project=com.djrapitops%3APlan&metric=alert_status )](https://sonarcloud.io/dashboard?id=com.djrapitops%3APlan)
2018-12-18 15:33:09 +08:00
[![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)
2018-04-09 01:26:53 +08:00
2019-12-19 22:14:04 +08:00
[API, Documentation & Tutorials ](https://github.com/Rsl1122/Plan-PlayerAnalytics/wiki ) | [Releases ](https://github.com/plan-player-analytics/Plan/releases ) | [Issues & Suggestions ](https://github.com/Rsl1122/Plan-PlayerAnalytics/issues )
2019-10-22 15:26:12 +08:00
Player Analytics is a fully fledged solution for the analytics needs of your minecraft server. A built in webserver displays insights into different aspects on the server such as Online activity, Playerbase and how these change over time.
2017-12-06 16:25:46 +08:00
2019-10-05 16:46:18 +08:00
Plan supports multiple different platforms and versions;
2020-01-18 05:06:29 +08:00
Spigot, Paper, Sponge, SpongeForge, Bungeecord, Velocity, Cauldron & all derivatives - One jar for all platforms.
2017-12-06 16:25:46 +08:00
2020-01-23 02:54:25 +08:00
- [Version 5 Release trailer on Youtube ](https://www.youtube.com/watch?v=BS_Ti9zkoRc )
2019-06-26 03:18:25 +08:00
## Building
You can build the project by running the following in the repository root
```
cd Plan
2019-12-08 02:13:25 +08:00
./gradlew build
2019-06-26 03:18:25 +08:00
```
- [More information about setting up the project ](https://github.com/plan-player-analytics/Plan/wiki/Project-Setup )
2017-12-06 16:25:46 +08:00
## Used Libraries
2019-10-20 20:09:41 +08:00
- **[SBAdmin 2 Template](https://github.com/BlackrockDigital/startbootstrap-sb-admin-2)** | [MIT License ](https://opensource.org/licenses/MIT )
2017-12-06 16:25:46 +08:00
- **[Bootstrap](https://v4-alpha.getbootstrap.com/)** | [MIT License ](https://v4-alpha.getbootstrap.com/about/license/ )
2019-10-20 20:09:41 +08:00
- **[HighCharts](https://www.highcharts.com/)** | [Free for non-commercial ](https://www.highcharts.com/products/highcharts/#non-commercial )
- **[jQuery Datatables](https://datatables.net/)** | [MIT License ](https://datatables.net/license/mit )
- **[FullCalendar](https://github.com/fullcalendar/fullcalendar)** | [MIT License ](https://datatables.net/license/mit )
2017-12-06 16:25:46 +08:00
- **[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/ )
2018-11-03 22:49:55 +08:00
- **[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 )
2019-10-05 16:46:18 +08:00
## License
Player Analytics is licensed under LGPL-3 (GNU Lesser General Public License)
- [License ](https://github.com/Rsl1122/Plan-PlayerAnalytics/blob/master/LICENSE )