Merge pull request #37 from KotRikD/feature/detailed_env_config

(WIP): detailed env config

packages/common/src/config.ts

@@ -8,16 +8,41 @@ const configPath = path.join(process.cwd(), 'tsosu.env');
 if (!fs.existsSync(configPath)) {
     fs.writeFileSync(
         configPath,
-        `DEBUG_LOG=false
+        `# The config implies a set of key-values to enable/disable tosu functionality
+# Below you can see that there is EVERY_THE_FUNCTION=true/false,
+# true = on
+# false = off
+
+# Turns PP counting on/off. Very useful for tournament client, when you only care about scoring and map stats for example
 CALCULATE_PP=true
+# Enables/disables reading K1/K2/M1/M2 keys on the keyboard
 ENABLE_KEY_OVERLAY=true
-WS_SEND_INTERVAL=150
+
+# Reference: 1 second = 1000 milliseconds
+# Once in what value, the programme should read the game values (in milliseconds)
 POLL_RATE=150
+# Once per value, the programme should read the values of keys K1/K2/M1/M2 (in milliseconds)
 KEYOVERLAY_POLL_RATE=150
+# Once in what value, the programme should send information about values to the websocket (overlay) (in milliseconds)
+WS_SEND_INTERVAL=150
+
+# Enables/disables the in-game gosumemory overlay (!!!I AM NOT RESPONSIBLE FOR USING IT!!!).
+ENABLE_GOSU_OVERLAY=false
+
+# WARNING: EVERYTHING BELOW IS NOT TO BE TOUCHED UNNECESSARILY.
+
+# Enables logs for tosu developers, not very intuitive for you, the end user.
+# best not to include without developer's request.
+DEBUG_LOG=false
+
+# IP address where the websocket api server will be registered
+# 127.0.0.1 = localhost
+# 0.0.0.0.0 = all addresses
 SERVER_IP=127.0.0.1
+# The port on which the websocket api server will run
 SERVER_PORT=24050
-STATIC_FOLDER_PATH=./static
-ENABLE_GOSU_OVERLAY=false`
+# The folder from which the overlays will be taken.
+STATIC_FOLDER_PATH=./static`
     );
 }