Add ExamplePlugin with custom metrics and plugin.yml

Author: NonSwag

bukkit/example-plugin/build.gradle.kts

@@ -0,0 +1,16 @@
+plugins {
+    id("com.gradleup.shadow") version ("9.3.0")
+}
+
+repositories {
+    maven("https://repo.papermc.io/repository/maven-public/")
+}
+
+dependencies {
+    compileOnly("io.papermc.paper:paper-api:1.21.11-R0.1-SNAPSHOT")
+    implementation(project(":bukkit"))
+}
+
+tasks.shadowJar {
+    relocate("dev.faststats", "com.example.utils") // optionally relocate faststats
+}

bukkit/example-plugin/src/main/java/com/example/ExamplePlugin.java

@@ -0,0 +1,32 @@
+package com.example;
+
+import dev.faststats.bukkit.BukkitMetrics;
+import dev.faststats.core.Metrics;
+import dev.faststats.core.chart.Chart;
+import org.bukkit.plugin.java.JavaPlugin;
+
+import java.net.URI;
+
+public class ExamplePlugin extends JavaPlugin {
+    private final Metrics metrics = BukkitMetrics.factory()
+            .url(URI.create("https://metrics.example.com/v1/collect")) // For self-hosted metrics servers only
+
+            // Custom example charts
+            // For this to work you have to create a corresponding data source in your project settings first
+            .addChart(Chart.number("example_chart", () -> 42))
+            .addChart(Chart.string("example_string", () -> "Hello, World!"))
+            .addChart(Chart.bool("example_boolean", () -> true))
+            .addChart(Chart.stringArray("example_string_array", () -> new String[]{"Option 1", "Option 2"}))
+            .addChart(Chart.numberArray("example_number_array", () -> new Number[]{1, 2, 3}))
+            .addChart(Chart.booleanArray("example_boolean_array", () -> new Boolean[]{true, false}))
+
+            .debug(true) // Enable debug mode for development and testing
+
+            .token("YOUR_TOKEN_HERE") // required -> token can be found in the settings of your project
+            .create(this);
+
+    @Override
+    public void onDisable() {
+        metrics.shutdown();
+    }
+}

bukkit/example-plugin/src/main/resources/plugin.yml

@@ -0,0 +1,3 @@
+name: ExamplePlugin
+version: 1.0.0
+main: com.example.ExamplePlugin

settings.gradle.kts

@@ -4,6 +4,7 @@ plugins {
 
 rootProject.name = "dev-kits"
 include("bukkit")
+include("bukkit:example-plugin")
 include("bungeecord")
 include("core")
 include("minestom")