cubyz-discord-relay 2.4.0 → 2.4.2

package/README.md

@@ -14,7 +14,7 @@
 - Provides a `/list` Discord command to show the players currently online
 - Cleans Cubyz markdown-style usernames and censors configurable words
 - Automatic reconnection with exponential backoff and retry limits
-- Optional integration advertises your server on [cubyzlist.site](https://cubyzlist.site)
+- Optional integration advertises your server on [servers.ashframe.net](https://servers.ashframe.net)
 
 ## Prerequisites
 
@@ -79,15 +79,20 @@ npm install
    - `connection.reconnect`: enable/disable automatic reconnect attempts
    - `connection.maxRetries`: maximum reconnect attempts (`0` = infinite)
    - `connection.retryDelayMs`: initial delay before retrying (milliseconds)
-   - `integration.cubyzlistSite.enabled`: toggle advertising to the community server list
-   - `integration.cubyzlistSite.serverName`: required display name shown on cubyzlist.site, must be unique
-   - `integration.cubyzlistSite.serverIp`: public hostname or IP that players should connect to
-   - `integration.cubyzlistSite.serverPort`: public port exposed for players (defaults to `47649` if omitted)
-   - `integration.cubyzlistSite.iconUrl`: optional URL for the list thumbnail
-   - `integration.cubyzlistSite.customClientDownloadUrl`: optional link to a custom client build
 
 > First run convenience: if `config.json` is missing, the application writes a fresh template in your working directory and exits so you can fill it in before retrying.
 
+### CubyzListSite Integration
+
+- `integration.cubyzlistSite.enabled`: toggle advertising to the community server list
+- `integration.cubyzlistSite.serverName`: required display name shown on servers.ashframe.net, must be unique; if missing while enabled, the integration logs a warning and stays disabled
+- `integration.cubyzlistSite.serverIp`: required public hostname or IP that players should connect to; if missing while enabled, the integration logs a warning and stays disabled
+- `integration.cubyzlistSite.description`: optional short description shown on servers.ashframe.net
+- `integration.cubyzlistSite.serverPort`: optional public port exposed for players
+- `integration.cubyzlistSite.iconUrl`: optional URL for the list thumbnail
+- `integration.cubyzlistSite.discordServer`: optional Discord invite or server URL
+- `integration.cubyzlistSite.customClientDownloadUrl`: optional link to a custom client build
+
 ### Usage
 
 ```bash

package/config.example.json

@@ -31,7 +31,9 @@
       "serverName": "My Cubyz Server",
       "serverIp": "play.yourserver.com",
       "serverPort": 47649,
+      "description": "A friendly public survival server",
       "iconUrl": "https://github.com/PixelGuys/Cubyz/blob/master/assets/cubyz/logo.png?raw=true",
+      "discordServer": "https://discord.gg/your-server",
       "customClientDownloadUrl": "https://github.com/PixelGuys/Cubyz/releases/tag/0.0.0"
     }
   }

package/dist/config.js

@@ -2,6 +2,7 @@ import { access, copyFile, mkdir, readFile } from "node:fs/promises";
 import path from "node:path";
 import process from "node:process";
 import { fileURLToPath } from "node:url";
+import { createLogger } from "./logger.js";
 const DEFAULT_EVENTS = ["join", "leave", "death", "chat"];
 const SUPPORTED_EVENTS = [...DEFAULT_EVENTS];
 const DEFAULT_CENSORLIST = [];
@@ -32,8 +33,10 @@ const DEFAULT_CUBYZLIST_SITE = {
     enabled: false,
     serverName: "",
     serverIp: "",
-    serverPort: 47649,
+    description: undefined,
+    serverPort: undefined,
     iconUrl: undefined,
+    discordServer: undefined,
     customClientDownloadUrl: undefined,
 };
 const CONFIG_TEMPLATE_PATH = fileURLToPath(new URL("../config.example.json", import.meta.url));
@@ -65,6 +68,18 @@ function coercePort(value, fallback) {
     }
     return fallback;
 }
+function coerceOptionalPort(value) {
+    if (value === undefined || value === null || value === "") {
+        return undefined;
+    }
+    if (typeof value === "number" &&
+        Number.isInteger(value) &&
+        value > 0 &&
+        value <= 65535) {
+        return value;
+    }
+    return undefined;
+}
 function coerceString(value, fallback) {
     return typeof value === "string" && value.trim().length > 0
         ? value.trim()
@@ -124,8 +139,10 @@ function applyDefaults(partial) {
             : DEFAULT_CUBYZLIST_SITE.enabled,
         serverName: coerceString(partial.integration?.cubyzlistSite?.serverName, DEFAULT_CUBYZLIST_SITE.serverName),
         serverIp: coerceString(partial.integration?.cubyzlistSite?.serverIp, DEFAULT_CUBYZLIST_SITE.serverIp),
-        serverPort: coercePort(partial.integration?.cubyzlistSite?.serverPort, DEFAULT_CUBYZLIST_SITE.serverPort),
+        description: coerceString(partial.integration?.cubyzlistSite?.description, DEFAULT_CUBYZLIST_SITE.description ?? "") || undefined,
+        serverPort: coerceOptionalPort(partial.integration?.cubyzlistSite?.serverPort),
         iconUrl: coerceString(partial.integration?.cubyzlistSite?.iconUrl, DEFAULT_CUBYZLIST_SITE.iconUrl ?? "") || undefined,
+        discordServer: coerceString(partial.integration?.cubyzlistSite?.discordServer, DEFAULT_CUBYZLIST_SITE.discordServer ?? "") || undefined,
         customClientDownloadUrl: coerceString(partial.integration?.cubyzlistSite?.customClientDownloadUrl, DEFAULT_CUBYZLIST_SITE.customClientDownloadUrl ?? "") || undefined,
     };
     const integration = {
@@ -172,6 +189,25 @@ function applyDefaults(partial) {
         integration,
     };
 }
+function finalizeConfig(config) {
+    const cubyzlist = config.integration.cubyzlistSite;
+    if (!cubyzlist.enabled) {
+        return config;
+    }
+    const missingFields = [];
+    if (cubyzlist.serverName.length === 0) {
+        missingFields.push("integration.cubyzlistSite.serverName");
+    }
+    if (cubyzlist.serverIp.length === 0) {
+        missingFields.push("integration.cubyzlistSite.serverIp");
+    }
+    if (missingFields.length === 0) {
+        return config;
+    }
+    createLogger(config.logLevel)("warn", `[CubyzListSite] Disabled integration because required config field(s) are missing: ${missingFields.join(", ")}`);
+    cubyzlist.enabled = false;
+    return config;
+}
 async function ensureConfigFile(resolvedPath) {
     try {
         await access(resolvedPath);
@@ -285,25 +321,33 @@ export function validateConfig(config) {
     if (typeof cubyzlist.enabled !== "boolean") {
         throw new Error('Configuration error: "integration.cubyzlistSite.enabled" must be a boolean.');
     }
-    // Only validate required fields if enabled
+    if (typeof cubyzlist.serverName !== "string") {
+        throw new Error('Configuration error: "integration.cubyzlistSite.serverName" must be a string.');
+    }
+    if (typeof cubyzlist.serverIp !== "string") {
+        throw new Error('Configuration error: "integration.cubyzlistSite.serverIp" must be a string.');
+    }
+    if (cubyzlist.description !== undefined &&
+        (typeof cubyzlist.description !== "string" || cubyzlist.description === "")) {
+        throw new Error('Configuration error: "integration.cubyzlistSite.description" must be a non-empty string or undefined.');
+    }
     if (cubyzlist.enabled) {
-        if (typeof cubyzlist.serverName !== "string" ||
-            cubyzlist.serverName === "") {
-            throw new Error('Configuration error: "integration.cubyzlistSite.serverName" must be a non-empty string when enabled.');
-        }
-        if (typeof cubyzlist.serverIp !== "string" || cubyzlist.serverIp === "") {
-            throw new Error('Configuration error: "integration.cubyzlistSite.serverIp" must be a non-empty string when enabled.');
-        }
-        if (typeof cubyzlist.serverPort !== "number" ||
-            !Number.isInteger(cubyzlist.serverPort) ||
-            cubyzlist.serverPort <= 0 ||
-            cubyzlist.serverPort > 65535) {
-            throw new Error('Configuration error: "integration.cubyzlistSite.serverPort" must be an integer between 1 and 65535.');
+        if (cubyzlist.serverPort !== undefined &&
+            (typeof cubyzlist.serverPort !== "number" ||
+                !Number.isInteger(cubyzlist.serverPort) ||
+                cubyzlist.serverPort <= 0 ||
+                cubyzlist.serverPort > 65535)) {
+            throw new Error('Configuration error: "integration.cubyzlistSite.serverPort" must be an integer between 1 and 65535 or undefined.');
         }
         if (cubyzlist.iconUrl !== undefined &&
             (typeof cubyzlist.iconUrl !== "string" || cubyzlist.iconUrl === "")) {
             throw new Error('Configuration error: "integration.cubyzlistSite.iconUrl" must be a non-empty string or undefined.');
         }
+        if (cubyzlist.discordServer !== undefined &&
+            (typeof cubyzlist.discordServer !== "string" ||
+                cubyzlist.discordServer === "")) {
+            throw new Error('Configuration error: "integration.cubyzlistSite.discordServer" must be a non-empty string or undefined.');
+        }
         if (cubyzlist.customClientDownloadUrl !== undefined &&
             (typeof cubyzlist.customClientDownloadUrl !== "string" ||
                 cubyzlist.customClientDownloadUrl === "")) {
@@ -319,7 +363,7 @@ export async function loadConfig(configPath) {
     if ("cubyzLogPath" in parsedUnknown) {
         throw new Error("Configuration error: detected legacy log-based settings. Update the configuration file to use the bot connection schema.");
     }
-    const config = applyDefaults(parsedUnknown);
+    const config = finalizeConfig(applyDefaults(parsedUnknown));
     validateConfig(config);
     return config;
 }

package/dist/integrations/cubyzListSite.d.ts

@@ -6,7 +6,7 @@ import type { BaseIntegration, IntegrationStatusContext } from "./base.js";
  * Integration that sends server status updates to the Cubyz list site
  * via TCP socket connection to api.ashframe.net:5001.
  * Sends periodic updates every 5 minutes to keep the listing fresh.
- * @link https://cubyzlist.site
+ * @link https://servers.ashframe.net
  */
 export declare class CubyzListSiteIntegration implements BaseIntegration {
     readonly name = "CubyzListSite";
@@ -18,6 +18,7 @@ export declare class CubyzListSiteIntegration implements BaseIntegration {
     private readonly UPDATE_INTERVAL_MS;
     private isReady;
     private readonly config;
+    private readonly version;
     private readonly logger;
     constructor(config: Config);
     private log;

package/dist/integrations/cubyzListSite.js

@@ -4,7 +4,7 @@ import { createLogger } from "../logger.js";
  * Integration that sends server status updates to the Cubyz list site
  * via TCP socket connection to api.ashframe.net:5001.
  * Sends periodic updates every 5 minutes to keep the listing fresh.
- * @link https://cubyzlist.site
+ * @link https://servers.ashframe.net
  */
 export class CubyzListSiteIntegration {
     name = "CubyzListSite";
@@ -16,9 +16,11 @@ export class CubyzListSiteIntegration {
     UPDATE_INTERVAL_MS = 5 * 60 * 1000; // 5 minutes
     isReady = false;
     config;
+    version;
     logger;
     constructor(config) {
         this.config = config.integration.cubyzlistSite;
+        this.version = config.cubyz.version;
         this.logger = createLogger(config.logLevel);
     }
     log(level, ...args) {
@@ -90,14 +92,26 @@ export class CubyzListSiteIntegration {
         const payload = {
             server_id: this.config.serverName,
             player_count: this.currentPlayers.size,
+            player_list: Array.from(this.currentPlayers),
             status: this.currentStatus,
-            gamemode: this.gamemode,
-            ip: this.config.serverIp +
-                (this.config.serverPort ? `:${this.config.serverPort}` : ""),
-            icon: this.config.iconUrl ?? "",
-            client_download: this.config.customClientDownloadUrl ?? "",
-            script_version: "1.4",
+            ip: this.config.serverIp,
+            version: this.version,
+            api_version: "1",
             timestamp: Math.floor(Date.now() / 1000),
+            ...(this.config.serverPort != null
+                ? { port: this.config.serverPort }
+                : {}),
+            ...(this.gamemode != null ? { gamemode: this.gamemode } : {}),
+            ...(this.config.description != null
+                ? { description: this.config.description }
+                : {}),
+            ...(this.config.iconUrl != null ? { icon: this.config.iconUrl } : {}),
+            ...(this.config.discordServer != null
+                ? { discord_server: this.config.discordServer }
+                : {}),
+            ...(this.config.customClientDownloadUrl != null
+                ? { client_download: this.config.customClientDownloadUrl }
+                : {}),
         };
         const dataString = JSON.stringify(payload);
         return new Promise((resolve, reject) => {

package/dist/types.d.ts

@@ -16,8 +16,10 @@ export interface CubyzListSiteConfig {
     enabled: boolean;
     serverName: string;
     serverIp: string;
-    serverPort: number;
+    description?: string;
+    serverPort?: number;
     iconUrl?: string;
+    discordServer?: string;
     customClientDownloadUrl?: string;
 }
 export interface IntegrationConfig {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "cubyz-discord-relay",
-  "version": "2.4.0",
+  "version": "2.4.2",
   "description": "Bot that relays messages between a Cubyz server and a Discord channel.",
   "type": "module",
   "main": "dist/index.js",
@@ -40,4 +40,4 @@
     "tsx": "^4.20.6",
     "typescript": "^5.9.3"
   }
-}
+}