Upstream
/
Plan
mirror of https://github.com/plan-player-analytics/Plan.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity
Plan/README.md

43 lines
3.3 KiB
Markdown
Raw Normal View History

Update README.md
2018-07-17 13:30:05 +02:00
# ![Player Analytics](http://puu.sh/AXSg7/5f2f78c06c.jpg)
Create README.md
2017-04-19 15:57:51 +02:00
Update README.md
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)
Update sonarcloud badges
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)
[![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)
Update README.md
2018-04-08 19:26:53 +02:00
Update README.md
2019-10-22 09:26:12 +02: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) | [Jenkins (Development builds)](https://plan.djrapitops.com/job/Player%20Analytics/job/master/)
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.
Update README.md
2017-12-06 09:25:46 +01:00
Update README.md
2019-10-05 10:46:18 +02:00
Plan supports multiple different platforms and versions;
Spigot, Paper, Sponge, SpongeForge, Bungeecord, Velocity, Cauldron & all derivatives; from 1.7 to 1.14 - One jar for all platforms.
Update README.md
2017-12-06 09:25:46 +01:00
Update README.md
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)
Update README.md
2017-12-06 09:25:46 +01:00
## Used Libraries
Update README.md
2019-10-20 14:09:41 +02:00
- **[SBAdmin 2 Template](https://github.com/BlackrockDigital/startbootstrap-sb-admin-2)** | [MIT License](https://opensource.org/licenses/MIT)
Update README.md
2017-12-06 09:25:46 +01:00
- **[Bootstrap](https://v4-alpha.getbootstrap.com/)** | [MIT License](https://v4-alpha.getbootstrap.com/about/license/)
Update README.md
2019-10-20 14:09:41 +02: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)
Update README.md
2017-12-06 09:25:46 +01: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/)
[New] H2 Db Support + improvements (#774) by Fuzzlemann * Adding H2 Database Support * Making HtmlCompressor a constant so it is not created new each time it is used. Note: It is thread-safe (see: https://code.google.com/archive/p/htmlcompressor/ "HtmlCompressor and XmlCompressor classes are considered thread safe* and can be used in multi-thread environment") * Adds the H2 Database to the used libraries in the README.md * Changes all invalid license headers * Refactors many methods into an enum named DBType These methods are: -> getName() -> getConfigName() -> supportsMySQLQueries() to a check if the DBType is H2 * KeepAliveTask splitted into separate class to remove duplicate code * Fixes compilation error * Refactors Database Tests into one Common class with all generic Database Tests and specific Database Tests * Fixes some JavaDocs * Adds license headers * Optimizing comparisons to enum comparisons
2018-11-03 15:49:55 +01: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)
Update README.md
2019-10-05 10:46:18 +02:00
## License
Player Analytics is licensed under LGPL-3 (GNU Lesser General Public License)
- [License](https://github.com/Rsl1122/Plan-PlayerAnalytics/blob/master/LICENSE)