From 5b1a3483f4d84f6c611b3634b84a1c9c28c0b1e1 Mon Sep 17 00:00:00 2001 From: al3xwarrior <138648975+al3xwarrior@users.noreply.github.com> Date: Sun, 15 Feb 2026 10:40:08 -0500 Subject: [PATCH 1/2] Add guide: Tracking Mod Analytics with HStats Add a new guide on tracking your mod with a 3rd party tool hstats.dev --- .../tracking-mod-analytics-with-hstats.mdx | 59 +++++++++++++++++++ 1 file changed, 59 insertions(+) create mode 100644 content/docs/en/guides/plugin/tracking-mod-analytics-with-hstats.mdx diff --git a/content/docs/en/guides/plugin/tracking-mod-analytics-with-hstats.mdx b/content/docs/en/guides/plugin/tracking-mod-analytics-with-hstats.mdx new file mode 100644 index 00000000..0ba4bfbc --- /dev/null +++ b/content/docs/en/guides/plugin/tracking-mod-analytics-with-hstats.mdx @@ -0,0 +1,59 @@ +--- +title: "Tracking Mod Analytics with HStats" +description: "Learn how you can track Analytics for your Hytale Mod for Free using hstats.dev" +authors: + - name: Al3x + url: https://hstats.dev +--- + +In this guide, you will learn how to integrate HStats into your Plugin/Mod which will allow you to track how many Servers are using it along with other stats. + + +HStats is a third-party tool and is not affiliated with HytaleModding or Hypixel Studios + + +# Step 1: Register your Mod to HStats +Before you touch any code, you will need to add your mod to the HStats website which will give you a UUID for your mod. + +- Create or Login to an Account on https://hstats.dev +- Navigate to the dashboard page (https://hstats.dev/dashboard) +- On the left, type in your mod's name and click "Add Mod" +- Keep note of the UUID generated for later. + +# Step 2: Add the HStats Class to Your Project +To keep things simple, HStats uses a single Java class file that handles everything for you. + +- Download / Copy the File from the GitHub page (https://github.com/hstats-dev/HStatsExamplePlugin/blob/main/src/main/java/com/al3x/HStats.java) +- Paste into your Project. You should now have a HStats.java file somewhere in your projects directory. +- Update the package name from com.al3x to whatever fits your project. + +# Step 3: Initialize HStats in your code +You only need to add one line of code to your mod's setup method in your main class to start tracking. + +`new HStats("YOUR-MOD-UUID", "1.0.0");` + +Replace `YOUR-MOD-UUID` with the Mod UUID we made note of earlier and change the `1.0.0` version to whatever version your mod is currently on. + +Your setup method should now look something like this: +```java +@Override +protected void setup() { + super.setup(); + new HStats("c34a2b2a-afd8-4d6a-821e-7a63e12c5ea6", "1.0.0"); +} +``` + +# Extras +Your done! Your mod should now be listed under the Mods page (https://hstats.dev/mods) as well as under your dashboard. + +Servers using your mod should now post updates about every minute to HStats which you can view in the Dashboard. + +### Embeds +HStats allows you to generate an Embed Card that you can place on your CurseForge or GitHub page. This is useful for server owners to be able to see how many other servers are using your mod. + +- In your dashboard, scroll down to the Embed Card section. +- Customize the appearance (Light/Dark mode, layout, etc). +- Copy the generated URL to display your "Active Servers" and "Players Online" live on your mod's description page + +Heres an example of what they look like: +![HStats Example](https://api.hstats.dev/api/embed/d52fa672-6966-47b2-b501-1a11bddebac3/card.svg?theme=light&layout=compact&size=md&show_id=true&dark=false) \ No newline at end of file From 4efc9bcd2f5108d1a4557efa9af4c760decbd2ff Mon Sep 17 00:00:00 2001 From: al3xwarrior <138648975+al3xwarrior@users.noreply.github.com> Date: Sun, 22 Feb 2026 17:11:32 -0500 Subject: [PATCH 2/2] Update HStats Guide to include all Embed Types --- .../en/guides/plugin/tracking-mod-analytics-with-hstats.mdx | 6 ++++-- 1 file changed, 4 insertions(+), 2 deletions(-) diff --git a/content/docs/en/guides/plugin/tracking-mod-analytics-with-hstats.mdx b/content/docs/en/guides/plugin/tracking-mod-analytics-with-hstats.mdx index 0ba4bfbc..41fcb0af 100644 --- a/content/docs/en/guides/plugin/tracking-mod-analytics-with-hstats.mdx +++ b/content/docs/en/guides/plugin/tracking-mod-analytics-with-hstats.mdx @@ -55,5 +55,7 @@ HStats allows you to generate an Embed Card that you can place on your CurseForg - Customize the appearance (Light/Dark mode, layout, etc). - Copy the generated URL to display your "Active Servers" and "Players Online" live on your mod's description page -Heres an example of what they look like: -![HStats Example](https://api.hstats.dev/api/embed/d52fa672-6966-47b2-b501-1a11bddebac3/card.svg?theme=light&layout=compact&size=md&show_id=true&dark=false) \ No newline at end of file +Heres an example of what they look like (Multiple different options): +![HStats History Example](https://api.hstats.dev/api/embed/00a9cb44-fac7-4aae-bdd7-8fb5e8291280/card.svg?theme=light&layout=history&size=sm&show_id=true&dark=false) +![HStats Compact Example](https://api.hstats.dev/api/embed/00a9cb44-fac7-4aae-bdd7-8fb5e8291280/card.svg?theme=light&layout=compact&size=sm&show_id=true&dark=false) +![HStats Stacked Example](https://api.hstats.dev/api/embed/00a9cb44-fac7-4aae-bdd7-8fb5e8291280/card.svg?theme=light&layout=stacked&size=sm&show_id=true&dark=false) \ No newline at end of file