From 6c711055bdcdda5dba8d9d1f2e2316bd171e3fe0 Mon Sep 17 00:00:00 2001
From: ORelio <oreliogitantispam.l0gin@spamgourmet.com>
Date: Wed, 4 Jan 2017 21:54:08 +0100
Subject: [PATCH] Add more comments in default MinecraftClient INI file

---
 MinecraftClient/Settings.cs | 47 +++++++++++++++++++------------------
 1 file changed, 24 insertions(+), 23 deletions(-)

diff --git a/MinecraftClient/Settings.cs b/MinecraftClient/Settings.cs
index 1b715559..18ec4b22 100644
--- a/MinecraftClient/Settings.cs
+++ b/MinecraftClient/Settings.cs
@@ -539,15 +539,15 @@ namespace MinecraftClient
                 + "showxpbarmessages=true             # Messages displayed above xp bar\r\n"
                 + "showchatlinks=true                 # Show links embedded in chat messages\r\n"
                 + "terrainandmovements=false          # Uses more ram, cpu, bandwidth\r\n"
-                + "sessioncache=memory                # Use 'none', 'memory' or 'disk' (disk is experimental)\r\n"
+                + "sessioncache=memory                # Use 'none', 'memory' or 'disk' (disk session storing is experimental)\r\n"
                 + "resolvesrvrecords=fast             # Use 'false', 'fast' (5s timeout), or 'true'. Required for joining some servers.\r\n"
-                + "accountlist=accounts.txt\r\n"
-                + "serverlist=servers.txt\r\n"
-                + "playerheadicon=true\r\n"
-                + "exitonfailure=false\r\n"
-                + "debugmessages=false\r\n"
-                + "scriptcache=true\r\n"
-                + "timestamps=false\r\n"
+                + "accountlist=accounts.txt           # See README > 'Servers and Accounts file' for more info about this file\r\n"
+                + "serverlist=servers.txt             # See README > 'Servers and Accounts file' for more info about this file\r\n"
+                + "playerheadicon=true                # Only works on Windows XP-8 or Windows 10 with old console\r\n"
+                + "exitonfailure=false                # Disable pauses on error, for using MCC in non-interactive scripts\r\n"
+                + "debugmessages=false                # Please enable this before submitting bug reports. Thanks!\r\n"
+                + "scriptcache=true                   # Cache compiled scripts for faster load on low-end devices\r\n"
+                + "timestamps=false                   # Prepend timestamps to chat messages\r\n"
                 + "\r\n"
                 + "[AppVars]\r\n"
                 + "# yourvar=yourvalue\r\n"
@@ -555,26 +555,27 @@ namespace MinecraftClient
                 + "# %username% and %serverip% are reserved variables.\r\n"
                 + "\r\n"
                 + "[Proxy]\r\n"
-                + "enabled=false             # Use 'false', 'true', or 'login' for login only\r\n"
-                + "type=HTTP                 # Supported types: HTTP, SOCKS4, SOCKS4a, SOCKS5\r\n"
-                + "server=0.0.0.0:0000\r\n"
-                + "username=\r\n"
-                + "password=\r\n"
+                + "enabled=false                      # Use 'false', 'true', or 'login' for login only\r\n"
+                + "type=HTTP                          # Supported types: HTTP, SOCKS4, SOCKS4a, SOCKS5\r\n"
+                + "server=0.0.0.0:0000                # Proxy server must allow HTTPS for login, and non-443 ports for playing\r\n"
+                + "username=                          # Only required for password-protected proxies\r\n"
+                + "password=                          # Only required for password-protected proxies\r\n"
                 + "\r\n"
                 + "[ChatFormat]\r\n"
-                + "builtins=true                                       # Support for common message formats\r\n"
-                + "# public=^<([a-zA-Z0-9_]+)> (.+)$                   # Uncomment and adapt if necessary\r\n"
-                + "# private=^([a-zA-Z0-9_]+) whispers to you: (.+)$   # Vanilla private message example\r\n"
+                + "# Do not forget to uncomment (remove '#') these settings if modifying them\r\n"
+                + "builtins=true                      # MCC built-in support for common message formats\r\n"
+                + "# public=^<([a-zA-Z0-9_]+)> (.+)$\r\n"
+                + "# private=^([a-zA-Z0-9_]+) whispers to you: (.+)$\r\n"
                 + "# tprequest=^([a-zA-Z0-9_]+) has requested (?:to|that you) teleport to (?:you|them)\\.$\r\n"
                 + "\r\n"
                 + "[MCSettings]\r\n"
-                + "enabled=true            # If disabled, client settings are not sent to the server\r\n"
-                + "locale=en_US            # Use any language implemented in Minecraft\r\n"
-                + "renderdistance=medium   # tiny, short, medium, far, or chunk amount [0 - 255]\r\n"
-                + "difficulty=normal       # MC 1.7- difficulty. peaceful, easy, normal, difficult\r\n"
-                + "chatmode=enabled        # enabled, commands, disabled. Allows to mute yourself...\r\n"
-                + "chatcolors=true         # Allows disabling chat colors server-side\r\n"
-                + "main_hand=left          # MC 1.9+ main hand. left or right\r\n"
+                + "enabled=true                       # If disabled, settings below are not sent to the server\r\n"
+                + "locale=en_US                       # Use any language implemented in Minecraft\r\n"
+                + "renderdistance=medium              # Use tiny, short, medium, far, or chunk amount [0 - 255]\r\n"
+                + "difficulty=normal                  # MC 1.7- difficulty. peaceful, easy, normal, difficult\r\n"
+                + "chatmode=enabled                   # Use 'enabled', 'commands', or 'disabled'. Allows to mute yourself...\r\n"
+                + "chatcolors=true                    # Allows disabling chat colors server-side\r\n"
+                + "main_hand=left                     # MC 1.9+ main hand. left or right\r\n"
                 + "skin_cape=true\r\n"
                 + "skin_hat=true\r\n"
                 + "skin_jacket=false\r\n"