Update configs with comments and new settings

This commit is contained in:
Hri7566 2024-11-04 21:19:44 -05:00
parent e4e13a896f
commit e520b1a23e
3 changed files with 28 additions and 2 deletions

View File

@ -48,3 +48,6 @@ channelDestroyTimeout: 1000
# Maximum allowed kickban time in minutes # Maximum allowed kickban time in minutes
maxBanMinutes: 60 maxBanMinutes: 60
# Whether to disable the crown entirely
disableCrown: false

View File

@ -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 topButtons: git-links
# Whether to hide the `#chat` div.
disableChat: false disableChat: false
# Whether to enable snowflakes.
winter: false winter: false
# Whether to enable the previously-broken piano sliding transition.
enableSlide: false enableSlide: false
# Whether to show social links in the notification for creating new rooms.
createdRoomSocialLinks: false createdRoomSocialLinks: false
# Whether to show social links in the notification for creating private rooms.
playingAloneSocialLinks: false 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 motd: This site makes a lot of sound! You may want to adjust the volume before
continuing. 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 hideChatOnDisconnect: false

View File

@ -42,10 +42,10 @@ tokenAuth: jwt
# The browser challenge scheme. Valid options are "none", "obf" and "basic". # The browser challenge scheme. Valid options are "none", "obf" and "basic".
# This is to change what is sent in the "b" message. # This is to change what is sent in the "b" message.
# "none" will disable the browser challenge, # "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. # and "basic" will just send a simple function that expects a boolean.
# FIXME Note that "obf" is not implemented yet, and has undefined behavior. # FIXME Note that "obf" is not implemented yet, and has undefined behavior.
browserChallenge: none browserChallenge: basic
# Scheme for generating user IDs. # Scheme for generating user IDs.
# Valid options are "random", "sha256", "mpp" and "uuid". # Valid options are "random", "sha256", "mpp" and "uuid".