From 71f43f4597b16bb588f8239fcd1b9db72477ef64 Mon Sep 17 00:00:00 2001
From: q13x <84165981+WorldEditAxe@users.noreply.github.com>
Date: Fri, 24 May 2024 01:48:47 -0700
Subject: [PATCH] make config more descriptive for certain setting entries

---
 src/config.ts | 9 ++++++---
 1 file changed, 6 insertions(+), 3 deletions(-)

diff --git a/src/config.ts b/src/config.ts
index dbc769c..236772b 100644
--- a/src/config.ts
+++ b/src/config.ts
@@ -9,6 +9,9 @@ export const config: Config = {
     bindHost: "0.0.0.0",
     bindPort: 8080,
     maxConcurrentClients: 20,
+    // set this to false if you are unable to install sharp due to either the use of a platform that does not support native modules
+    // or if you are unable to install the required dependencies. this will cause the proxy to use jimp instead of sharp, which may
+    // degrade your proxy's performance.
     useNatives: true,
     skinServer: {
       skinUrlWhitelist: undefined,
@@ -20,12 +23,12 @@ export const config: Config = {
       },
     },
     motd: true
-      ? "FORWARD"
+      ? "FORWARD" // "FORWARD" regularly polls the server for the MOTD
       : {
-          iconURL: "motd.png",
+          iconURL: "motd.png", // must be a valid file path
           l1: "yes",
           l2: "no",
-        },
+        }, // providing an object as such will allow you to supply your own MOTD
     ratelimits: {
       lockout: 10,
       limits: {