mirror of
https://github.com/plan-player-analytics/Plan.git
synced 2024-11-08 20:01:20 +01:00
67 lines
4.0 KiB
Markdown
67 lines
4.0 KiB
Markdown
# 
|
||
|
||
[](https://github.com/plan-player-analytics/Plan/actions/workflows/ci.yml)
|
||
[](https://sonarcloud.io/dashboard?id=com.djrapitops%3APlan)
|
||
|
||
[](https://sonarcloud.io/dashboard?id=com.djrapitops%3APlan)
|
||
[](https://sonarcloud.io/dashboard?id=com.djrapitops%3APlan)
|
||
|
||
[](https://sonarcloud.io/summary/overall?id=plan-player-analytics_Plan)
|
||
|
||
[Documentation & Tutorials](https://github.com/plan-player-analytics/Plan/wiki) | [Releases](https://github.com/plan-player-analytics/Plan/releases) | [DEV builds](https://github.com/plan-player-analytics/Plan/actions/workflows/ci.yml?query=branch%3Amaster) | [Issues & Suggestions](https://github.com/plan-player-analytics/Plan/issues)
|
||
|
||
Player Analytics is a fully-fledged solution for the analytics needs of your Minecraft server. A built-in webserver displays insights into different aspects of the server such as Online activity, Playerbase, and how these change over time.
|
||
|
||
Plan supports multiple different platforms and versions; Spigot, Paper, Sponge, SpongeForge, Bungeecord, Velocity, Cauldron & all derivatives - One jar for all platforms.
|
||
|
||
- [Version 5 Release trailer on Youtube](https://www.youtube.com/watch?v=BS_Ti9zkoRc)
|
||
|
||
## API
|
||
|
||
- [Javadocs](https://plan-player-analytics.github.io/Plan/)
|
||
- [API documentation](https://github.com/plan-player-analytics/Plan/wiki/APIv5)
|
||
|
||
[](https://jitpack.io/#plan-player-analytics/Plan)
|
||
|
||
```xml
|
||
<repository>
|
||
<id>jitpack</id>
|
||
<url>https://jitpack.io</url>
|
||
</repository>
|
||
|
||
<dependency>
|
||
<groupId>com.github.plan-player-analytics</groupId>
|
||
<artifactId>Plan</artifactId>
|
||
<version>{jitpack version}</version>
|
||
<scope>provided</scope>
|
||
</dependency>
|
||
```
|
||
|
||
## Building
|
||
|
||
You can build the project by running the following in the repository root:
|
||
```
|
||
cd Plan
|
||
./gradlew build
|
||
```
|
||
|
||
- [More information about setting up the project](https://github.com/plan-player-analytics/Plan/wiki/Project-Setup)
|
||
|
||
## Used Libraries
|
||
|
||
- **[SBAdmin 2 Template](https://github.com/BlackrockDigital/startbootstrap-sb-admin-2)** | [MIT License](https://opensource.org/licenses/MIT)
|
||
- **[Bootstrap](https://getbootstrap.com/)** | [MIT License](https://v4-alpha.getbootstrap.com/about/license/)
|
||
- **[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)
|
||
- **[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 Country](https://www.maxmind.com/en/geoip2-country-database)** | [MaxMind End User License Agreement (EULA)](https://www.maxmind.com/en/end-user-license-agreement)
|
||
- **[Dagger](https://dagger.dev/)** | [Apache-2.0 License](https://github.com/google/dagger/blob/master/LICENSE.txt)
|
||
- **[DependencyDownload](https://github.com/Vankka/DependencyDownload)** | [MIT License](https://github.com/Vankka/DependencyDownload/blob/main/LICENSE)
|
||
|
||
## License
|
||
|
||
Player Analytics is licensed under LGPL-3 (GNU Lesser General Public License)
|
||
|
||
- [License](https://github.com/plan-player-analytics/Plan/blob/master/LICENSE)
|