From e520b1a23ec665bc1d8a2cdf51c7204be3a04110 Mon Sep 17 00:00:00 2001
From: Hri7566 <hri7566@gmail.com>
Date: Mon, 4 Nov 2024 21:19:44 -0500
Subject: [PATCH] Update configs with comments and  new settings

---
 config/channels.yml |  3 +++
 config/frontend.yml | 23 +++++++++++++++++++++++
 config/users.yml    |  4 ++--
 3 files changed, 28 insertions(+), 2 deletions(-)

diff --git a/config/channels.yml b/config/channels.yml
index 4a94d7c..f1a8cd7 100644
--- a/config/channels.yml
+++ b/config/channels.yml
@@ -48,3 +48,6 @@ channelDestroyTimeout: 1000
 
 # Maximum allowed kickban time in minutes
 maxBanMinutes: 60
+
+# Whether to disable the crown entirely
+disableCrown: false
diff --git a/config/frontend.yml b/config/frontend.yml
index 1ade225..60803ba 100644
--- a/config/frontend.yml
+++ b/config/frontend.yml
@@ -1,9 +1,32 @@
+# Which top buttons to show in the top right corner of the page.
+# "git-links" shows a link to the server source,
+# "original" shows the kitten1.png button that brings up the "more" page,
+# "mppnet" shows the links from multiplayerpiano.net,
+# and "none" will hide the top buttons entirely.
+# The size of the `#names` div will not change.
 topButtons: git-links
+
+# Whether to hide the `#chat` div.
 disableChat: false
+
+# Whether to enable snowflakes.
 winter: false
+
+# Whether to enable the previously-broken piano sliding transition.
 enableSlide: false
+
+# Whether to show social links in the notification for creating new rooms.
 createdRoomSocialLinks: false
+
+# Whether to show social links in the notification for creating private rooms.
 playingAloneSocialLinks: false
+
+# The text that appears in the startup modal.
+# The startup modal dialog is somewhat required to enable sound on the page in modern browsers.
+# This is because of the change that disallows ads to autoplay audio, which will make the piano silent in certain circumstances.
 motd: This site makes a lot of sound! You may want to adjust the volume before
     continuing.
+
+# Whether to hide the chat when the client disconnects from the server.
+# This was an option that was changed in 2020 when TLS was implemented on Brandon's original server.
 hideChatOnDisconnect: false
diff --git a/config/users.yml b/config/users.yml
index 981738d..dcb1b9b 100644
--- a/config/users.yml
+++ b/config/users.yml
@@ -42,10 +42,10 @@ tokenAuth: jwt
 # The browser challenge scheme. Valid options are "none", "obf" and "basic".
 # This is to change what is sent in the "b" message.
 # "none" will disable the browser challenge,
-# "obf" will sent an obfuscated function to the client,
+# "obf" will send an obfuscated function to the client,
 # and "basic" will just send a simple function that expects a boolean.
 # FIXME Note that "obf" is not implemented yet, and has undefined behavior.
-browserChallenge: none
+browserChallenge: basic
 
 # Scheme for generating user IDs.
 # Valid options are "random", "sha256", "mpp" and "uuid".