Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
52 changes: 28 additions & 24 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,13 +1,13 @@
# ServerStats Server Plugins
# Analyse Server Plugins

Analytics tracking plugins for Minecraft servers. Supports Paper, Velocity, and BungeeCord.
Analytics tracking plugins for Minecraft servers. Supports Spigot 1.8+, Paper, Velocity, and BungeeCord.

## Features

- **Automatic Session Tracking** - Player joins, leaves, and playtime
- **Heartbeat System** - Regular server health checks
- **Custom Events API** - Fluent API for other plugins to track analytics
- **Multi-Platform** - Paper, BungeeCord, and Velocity support
- **Multi-Platform** - Spigot 1.8+, Paper, BungeeCord, and Velocity support
- **ACF Commands** - Clean command system using [Annotation Command Framework](https://github.com/aikar/commands)

## Documentation
Expand All @@ -27,32 +27,33 @@ Download the appropriate plugin for your server:

| Platform | Download |
|----------|----------|
| Paper/Spigot | `serverstats-paper-x.x.x.jar` |
| BungeeCord | `serverstats-bungeecord-x.x.x.jar` |
| Velocity | `serverstats-velocity-x.x.x.jar` |
| Spigot/Paper | `analyse-spigot-x.x.x.jar` |
| BungeeCord | `analyse-bungeecord-x.x.x.jar` |
| Velocity | `analyse-velocity-x.x.x.jar` |
| Hytale | `analyse-hytale-x.x.x.jar` |

### 2. Configure

Add your API key from [serverstats.net](https://serverstats.net):
Add your API key from [analyse.net](https://analyse.net):

```yaml
# Paper - plugins/ServerStats/config.yml
# Spigot/Paper - plugins/Analyse/config.yml
api-key: "your-api-key-here"
```

### 3. Verify

Run `/serverstats status` to check the connection.
Run `/analyse status` to check the connection.

## For Developers

Track custom events from your plugin:

```java
import net.serverstats.api.ServerStats;
import net.analyse.api.Analyse;

// Simple event
ServerStats.trackEvent("shop_purchase")
Analyse.trackEvent("shop_purchase")
.withPlayer(player.getUniqueId(), player.getName())
.withData("item", "diamond_sword")
.withValue(500.0)
Expand All @@ -67,9 +68,10 @@ See the [Developer API Documentation](docs/api.md) for more examples.
|--------|-------------|
| `sdk` | Core SDK with HTTP client and data models |
| `api` | Public API for other plugins to track events |
| `paper` | Plugin for Paper/Spigot servers |
| `spigot` | Plugin for Spigot 1.8+ and Paper servers |
| `velocity` | Plugin for Velocity proxies |
| `bungeecord` | Plugin for BungeeCord proxies |
| `hytale` | Plugin for Hytale servers |

## Building

Expand All @@ -78,34 +80,36 @@ See the [Developer API Documentation](docs/api.md) for more examples.
```

Output JARs:
- `paper/build/libs/serverstats-paper-*.jar`
- `velocity/build/libs/serverstats-velocity-*.jar`
- `bungeecord/build/libs/serverstats-bungeecord-*.jar`

- `modules/spigot/build/libs/analyse-spigot-*.jar`
- `modules/velocity/build/libs/analyse-velocity-*.jar`
- `modules/bungeecord/build/libs/analyse-bungeecord-*.jar`
- `modules/hytale/build/libs/analyse-hytale-*.jar`

## Requirements

- **Java**: 21+
- **Paper**: 1.21.4+
- **Spigot/Paper**: Spigot 1.8+ or Paper (see module for tested API level)
- **Velocity**: 3.4.0+
- **BungeeCord**: 1.21+

## Commands

```
/serverstats - Show plugin status
/serverstats status - Show plugin status
/serverstats reload - Reload configuration
/serverstats debug - Toggle debug mode
/serverstats event <name> - Send a custom event
/serverstats help - Show help
/analyse - Show plugin status
/analyse status - Show plugin status
/analyse reload - Reload configuration (Spigot/Paper only)
/analyse debug - Toggle debug mode
/analyse event <name> - Send a custom event
/analyse help - Show help
```

See [Commands Documentation](docs/commands.md) for details.

## Support

- Website: [serverstats.net](https://serverstats.net)
- API: [api.serverstats.net](https://api.serverstats.net)
- Website: [analyse.net](https://analyse.net)
- API: [api.analyse.net](https://api.analyse.net)

## License

Expand Down
9 changes: 2 additions & 7 deletions build.gradle
Original file line number Diff line number Diff line change
Expand Up @@ -11,18 +11,13 @@ allprojects {
subprojects {
apply plugin: 'java'

java {
sourceCompatibility = JavaVersion.VERSION_21
targetCompatibility = JavaVersion.VERSION_21
}

repositories {
mavenCentral()
maven { url = 'https://repo.papermc.io/repository/maven-public/' }
maven { url = 'https://oss.sonatype.org/content/repositories/snapshots' }
maven { url = 'https://s01.oss.sonatype.org/content/repositories/snapshots/' }
maven { url = 'https://hub.spigotmc.org/nexus/content/repositories/snapshots/' }
maven { url = 'https://repo.aikar.co/content/groups/aikar/' }
maven { url = 'https://repo.aikar.co/content/groups/aikar/' }
}

dependencies {
Expand All @@ -36,7 +31,7 @@ subprojects {
}

tasks.register('publishApi') {
dependsOn ':api:publish'
dependsOn ':modules:api:publish'
description = 'Publishes only the API module to Nexus'
group = 'publishing'
}
6 changes: 0 additions & 6 deletions bungeecord/src/main/resources/bungee.yml

This file was deleted.

24 changes: 12 additions & 12 deletions docs/README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# ServerStats Plugin Documentation
# Analyse Plugin Documentation

Welcome to the ServerStats plugin documentation. This guide covers installation, configuration, commands, and API usage for developers.
Welcome to the Analyse plugin documentation. This guide covers installation, configuration, commands, and API usage for developers.

## Table of Contents

Expand All @@ -13,31 +13,31 @@ Welcome to the ServerStats plugin documentation. This guide covers installation,

## Overview

ServerStats is a comprehensive analytics plugin for Minecraft servers. It provides:
Analyse is a comprehensive analytics plugin for Minecraft servers. It provides:

- **Player Session Tracking** - Automatically tracks player joins, leaves, and playtime
- **Heartbeat System** - Regular server health checks with online player data
- **Custom Events API** - Fluent static API for other plugins to track custom analytics events
- **A/B Testing** - Built-in support for A/B tests with variant assignment and action execution
- **Multi-Platform Support** - Works on Paper, BungeeCord, and Velocity
- **Multi-Platform Support** - Works on Spigot 1.8+, Paper, BungeeCord, and Velocity

## Platforms

| Platform | Server Type | Java Version |
|----------|-------------|--------------|
| **Paper** | Single server / backend | Java 21+ |
| **Spigot / Paper** | Single server / backend | Java 21+ (runtime); Spigot API targets 1.8+ |
| **BungeeCord** | Proxy | Java 21+ |
| **Velocity** | Proxy | Java 21+ |

### Choosing the Right Version

- **Paper**: Use for standalone servers or backend servers behind a proxy
- **Spigot / Paper**: Use for standalone servers or backend servers behind a proxy
- **BungeeCord/Velocity**: Use for proxy servers to track cross-server analytics

### Feature Comparison

| Feature | Paper | BungeeCord | Velocity |
|---------|-------|------------|----------|
| Feature | Spigot/Paper | BungeeCord | Velocity |
|---------|----------------|------------|----------|
| Session Tracking | ✅ | ✅ | ✅ |
| Heartbeat | ✅ | ✅ | ✅ |
| Custom Events | ✅ | ✅ | ✅ |
Expand All @@ -50,17 +50,17 @@ ServerStats is a comprehensive analytics plugin for Minecraft servers. It provid
1. Download the appropriate plugin jar for your platform
2. Place it in your `plugins` folder
3. Start the server to generate the config
4. Add your API key from [serverstats.net](https://serverstats.net)
4. Add your API key from [analyse.net](https://analyse.net)
5. Restart the server

```yaml
# Paper config.yml
# Spigot/Paper config.yml (plugins/Analyse/config.yml)
api-key: "your-api-key-here"
debug: false
instance-id: "auto-generated"
```

## Support

- Website: [serverstats.net](https://serverstats.net)
- API Documentation: [api.serverstats.net](https://api.serverstats.net)
- Website: [analyse.net](https://analyse.net)
- API Documentation: [api.analyse.net](https://api.analyse.net)
Loading