Merge pull request #692 from Aktanusa/dev

Push 2.031.6 to master

.eslintrc.js

@@ -8,28 +8,20 @@ module.exports = {
     l: 'readonly',
     b64_to_utf8: 'readonly',
     utf8_to_b64: 'readonly',
-    realAudio: 'readonly',
     BeautifyAll: 'readonly',
-    CM: 'writable',
-    unsafeWindow: 'readonly',
   },
   extends: ['airbnb-base', 'plugin:prettier/recommended'],
   parserOptions: {
     ecmaVersion: 12,
   },
   rules: {
-    'import/no-named-default': 'off',
     'import/no-mutable-exports': 'off',
-    'no-param-reassign': 'off',
-    'no-plusplus': 'off',
+    'no-plusplus': ['error', { allowForLoopAfterthoughts: true }],
     'no-new-func': 'off',
-    'no-restricted-syntax': 'off',
-    'prefer-destructuring': 'off',
     'func-names': 'off',
     'no-console': 'off',
-    'no-nested-ternary': 'off',
-    'no-new': 'off',
     'no-alert': 'off',
     'no-restricted-globals': 'off',
+    'prefer-destructuring': ['error', { object: true, array: false }],
   },
 };

.github/CONTRIBUTING.md

@@ -0,0 +1,18 @@
+Cookie Monster is written to modify Cookie Clicker as little as possible. This means the data is copied to simulate instead of actually modifying the current values and reverting later. The benefit is that CM should never mess up any data. The downside is that there is an extra overhead to copy and store the copied data.
+
+The following is a short description of the various `src` directories and their contents:
+
+JS | Description
+-- | -
+Cache | Functions related to creating and storing data cache
+Config | Functions related to manipulating CM configuration
+Data | Hard coded values
+Disp | Functions related to displaying CM's UI
+InitSaveLoad | Functions related to registering the CM object with the Game's Modding API
+Main | Functions related to the main loop and initializing CM
+Sim | Functions related to simulate something
+
+These are some additional guidelines:
+- Try to use DOM as much as possible instead of using string manipulation to modify HTML.
+- Please be descriptive of your commits. If the commit is related to an issue or PR, please add the issue/PR number to the commit message.
+- PR's should target the `dev` branch

.github/ISSUE_TEMPLATE/bug_report.md

@@ -19,5 +19,6 @@ If applicable, add screenshots to help explain your problem.
 
 **Save file**
 ```
-If applicable please copy your save file here
+Please add a save file here.
+This makes debugging much easier as we do not always have a good test save to debug the issue
 ```

README.md

@@ -18,13 +18,13 @@ Cookie Monster also indicates the time left before being able to buy an upgrade
 
 This index is computed for buildings and upgrades. If the relevant option is enabled, it will color-code each of them based on their value:
 
-* Light Blue: (upgrades) This item has a better PP than any building
-* Green: This item has the best PP
-* Yellow: This item is not the best, but it is closer to best than it is to worst
-* Orange: This item is not the worst, but it is closer to worst than it is to best
-* Red: This item has the worst PP
-* Purple: (upgrades) This item has a worse PP than any building
-* Gray: (upgrades) This item has not been calculated and/or cannot be calculated due to no definitive worth.
+* Light Blue: (upgrades) This item has a better PP than the best building to buy
+* Green: This building has the best PP
+* Yellow: This building is within the top 10 of best PP's
+* Orange: This building is within the top 20 of best PP's
+* Red: This building is within the top 30 of best PP's
+* Purple: This building is worse than the top 10 of best PP's
+* Gray: This item does not have a PP, often this means that there is no change to CPS
 
 Note: For this index, **lower is better**, meaning a building with a PP of 1 is more interesting than one with a PP of 3.