allbuild commit 0133945c

UI: Fixed `nano` not correctly opening a script in root of a server if `cd`'d into a directory

.browserslistrc

@@ -1,3 +1,3 @@
-last 4 versions
+last 8 versions
 not dead
 not ie <= 11

.eslintignore

@@ -1,27 +1,26 @@
 node_modules/
-dist/
-input/
 
 .dist
 .tmp
 .package
-
-assets/
-css/
+.build
 .cypress/
-cypress/
+
+dist/
+input/
+assets/
 doc/
 markdown/
-netscript_tests/
-scripts/
+
+
+test/netscript/
 
 electron/lib
 electron/greenworks.js
 src/ThirdParty/*
 src/JSInterpreter.js
+tools/engines-check/
 
-test/*.bundle.*
 editor.main.js
 main.bundle.js
 webpack.config.js
-webpack.config-test.js

.eslintrc.js

@@ -4,7 +4,12 @@ module.exports = {
     commonjs: true,
     es6: false,
   },
-  extends: ["eslint:recommended", "plugin:@typescript-eslint/recommended"],
+  extends: [
+    "eslint:recommended",
+    "plugin:@typescript-eslint/recommended",
+    "plugin:@typescript-eslint/recommended-requiring-type-checking",
+    "plugin:@typescript-eslint/strict",
+  ],
   parser: "@typescript-eslint/parser",
   parserOptions: {
     ecmaVersion: 8,
@@ -12,387 +17,20 @@ module.exports = {
     ecmaFeatures: {
       experimentalObjectRestSpread: true,
     },
+    project: ["./tsconfig.json", "./test/tsconfig.json", "./tools/tsconfig.json", "./test/cypress/tsconfig.json"],
   },
   plugins: ["@typescript-eslint"],
+  extends: ["plugin:@typescript-eslint/recommended"],
   rules: {
-    "accessor-pairs": [
+    "@typescript-eslint/no-unused-vars": [
       "error",
       {
-        setWithoutGet: true,
-        getWithoutSet: false,
+        argsIgnorePattern: "^__",
+        varsIgnorePattern: "^__",
+        caughtErrorsIgnorePattern: "^__",
       },
     ],
-    "array-bracket-newline": ["off"],
-    "array-bracket-spacing": ["off"],
-    "array-callback-return": ["off"],
-    "array-element-newline": ["off"],
-    "arrow-body-style": ["off"],
-    "arrow-parens": ["off"],
-    "arrow-spacing": ["off"],
-    "block-scoped-var": ["off"],
-    "block-spacing": ["off"],
-    "brace-style": ["off"],
-    "callback-return": ["error"],
-    camelcase: ["off"],
-    "capitalized-comments": ["off"],
-    "class-methods-use-this": ["off"],
-    complexity: ["off"],
-    "consistent-return": ["off"],
-    "consistent-this": ["off"],
-    "constructor-super": ["error"],
-    curly: ["off"],
-    "default-case": ["off"],
-    "dot-notation": ["off"],
-    "eol-last": ["off"],
-    eqeqeq: ["off"],
-    "for-direction": ["error"],
-    "func-call-spacing": ["off"],
-    "func-name-matching": ["error"],
-    "func-names": ["off", "never"],
-    "func-style": ["off"],
-    "function-paren-newline": ["off"],
-    "getter-return": [
-      "error",
-      {
-        allowImplicit: false,
-      },
-    ],
-    "global-require": ["off"],
-    "guard-for-in": ["off"],
-    "handle-callback-err": ["error"],
-    "id-blacklist": ["error"],
-    "id-length": ["off"],
-    "id-match": ["error"],
-    indent: ["off"],
-    "indent-legacy": ["off"],
-    "init-declarations": ["off"],
-    "key-spacing": ["off"],
-    "keyword-spacing": ["off"],
-    "line-comment-position": ["off"],
-    "linebreak-style": [
-      "off", // Line endings automatically converted to LF on git commit so probably shouldn't care about it here
-    ],
-    "lines-around-comment": ["off"],
-    "lines-around-directive": ["error"],
-    "lines-between-class-members": ["error"],
-    "max-depth": ["off"],
-    "max-len": ["off"],
-    "max-lines": ["off"],
-    "max-nested-callbacks": ["error"],
-    "max-params": ["off"],
-    "max-statements": ["off"],
-    "max-statements-per-line": ["off"],
-    "multiline-comment-style": ["off", "starred-block"],
-    "multiline-ternary": ["off", "never"],
-    "new-cap": ["off"],
-    "new-parens": ["off"],
-    "newline-after-var": ["off"],
-    "newline-before-return": ["off"],
-    "newline-per-chained-call": ["off"],
-    "no-alert": ["error"],
-    "no-array-constructor": ["error"],
-    "no-await-in-loop": ["error"],
-    "no-bitwise": ["off"],
-    "no-buffer-constructor": ["error"],
-    "no-caller": ["error"],
-    "no-case-declarations": ["error"],
-    "no-catch-shadow": ["error"],
-    "no-class-assign": ["error"],
-    "no-compare-neg-zero": ["error"],
-    "no-confusing-arrow": ["error"],
-    "no-console": ["off"],
-    "no-const-assign": ["error"],
-    "no-constant-condition": [
-      "error",
-      {
-        checkLoops: false,
-      },
-    ],
-    "no-continue": ["off"],
-    "no-control-regex": ["error"],
-    "no-debugger": ["error"],
-    "no-delete-var": ["error"],
-    "no-div-regex": ["error"],
-    "no-dupe-args": ["error"],
-    "no-dupe-class-members": ["error"],
-    "no-dupe-keys": ["error"],
-    "no-duplicate-case": ["error"],
-    "no-duplicate-imports": [
-      "error",
-      {
-        includeExports: true,
-      },
-    ],
-    "no-else-return": ["off"],
-    "no-empty": [
-      "off",
-      {
-        allowEmptyCatch: false,
-      },
-    ],
-    "no-empty-character-class": ["error"],
-    "no-empty-function": ["off"],
-    "no-empty-pattern": ["error"],
-    "no-eq-null": ["off"],
-    "no-ex-assign": ["off"],
-    "no-extra-boolean-cast": ["error"],
-    "no-extra-parens": ["off"],
-    "no-extra-semi": ["off"],
-    "no-eval": ["off"],
-    "no-extend-native": ["off"],
-    "no-extra-bind": ["error"],
-    "no-extra-label": ["error"],
-    "no-fallthrough": ["off"],
-    "no-floating-decimal": ["off"],
-    "no-func-assign": ["error"],
-    "no-global-assign": ["error"],
-    "no-implicit-coercion": ["off"],
-    "no-implicit-globals": ["error"],
-    "no-implied-eval": ["error"],
-    "no-inline-comments": ["off"],
-    "no-inner-declarations": ["off", "both"],
-    "no-invalid-regexp": ["error"],
-    "no-invalid-this": ["off"],
-    "no-irregular-whitespace": [
-      "error",
-      {
-        skipStrings: false,
-        skipComments: false,
-        skipRegExps: false,
-        skipTemplates: false,
-      },
-    ],
-    "no-iterator": ["error"],
-    "no-label-var": ["error"],
-    "no-labels": ["off"],
-    "no-lone-blocks": ["error"],
-    "no-lonely-if": ["off"],
-    "no-loop-func": ["off"],
-    "no-magic-numbers": ["off"],
-    "no-mixed-operators": ["off"],
-    "no-mixed-requires": ["error"],
-    "no-mixed-spaces-and-tabs": ["off"],
-    "no-multi-assign": ["off"],
-    "no-multi-spaces": ["off"],
-    "no-multi-str": ["error"],
-    "no-multiple-empty-lines": [
-      "off",
-      {
-        max: 1,
-      },
-    ],
-    "no-native-reassign": ["error"],
-    "no-negated-condition": ["off"],
-    "no-negated-in-lhs": ["error"],
-    "no-nested-ternary": ["off"],
-    "no-new": ["error"],
-    "no-new-func": ["error"],
-    "no-new-object": ["error"],
-    "no-new-require": ["error"],
-    "no-new-symbol": ["error"],
-    "no-new-wrappers": ["error"],
-    "no-octal": ["error"],
-    "no-octal-escape": ["error"],
-    "no-obj-calls": ["error"],
-    "no-param-reassign": ["off"],
-    "no-path-concat": ["error"],
-    "no-plusplus": ["off"],
-    "no-process-env": ["off"],
-    "no-process-exit": ["error"],
-    "no-proto": ["error"],
-    "no-prototype-builtins": ["off"],
-    "no-redeclare": ["off"],
-    "no-regex-spaces": ["error"],
-    "no-restricted-globals": ["error"],
-    "no-restricted-imports": ["error"],
-    "no-restricted-modules": ["error"],
-    "no-restricted-properties": [
-      "off",
-      {
-        object: "console",
-        property: "log",
-        message: "'log' is too general, use an appropriate level when logging.",
-      },
-    ],
-    "no-restricted-syntax": ["error"],
-    "no-return-assign": ["off"],
-    "no-return-await": ["error"],
-    "no-script-url": ["error"],
-    "no-self-assign": [
-      "error",
-      {
-        props: false,
-      },
-    ],
-    "no-self-compare": ["error"],
-    "no-sequences": ["error"],
-    "no-shadow": ["off"],
-    "no-shadow-restricted-names": ["error"],
-    "no-spaced-func": ["off"],
-    "no-sparse-arrays": ["error"],
-    "no-sync": ["error"],
-    "no-tabs": ["off"],
-    "no-template-curly-in-string": ["error"],
-    "no-ternary": ["off"],
-    "no-this-before-super": ["off"],
-    "no-throw-literal": ["error"],
-    "no-trailing-spaces": ["off"],
-    "no-undef": ["off"],
-    "no-undef-init": ["error"],
-    "no-undefined": ["off"],
-    "no-underscore-dangle": ["off"],
-    "no-unexpected-multiline": ["error"],
-    "no-unmodified-loop-condition": ["error"],
-    "no-unneeded-ternary": ["off"],
-    "no-unreachable": ["off"],
-    "no-unsafe-finally": ["error"],
-    "no-unsafe-negation": ["error"],
-    "no-unused-expressions": ["off"],
-    "no-unused-labels": ["error"],
-    "no-unused-vars": ["off"],
-    "no-use-before-define": ["off"],
-    "no-useless-call": ["off"],
-    "no-useless-computed-key": ["error"],
-    "no-useless-concat": ["off"],
-    "no-useless-constructor": ["error"],
-    "no-useless-escape": ["off"],
-    "no-useless-rename": [
-      "error",
-      {
-        ignoreDestructuring: false,
-        ignoreExport: false,
-        ignoreImport: false,
-      },
-    ],
-    "no-useless-return": ["off"],
-    "no-var": ["off"],
-    "no-void": ["off"],
-    "no-warning-comments": ["off"],
-    "no-whitespace-before-property": ["error"],
-    "no-with": ["error"],
-    "nonblock-statement-body-position": ["off", "below"],
-    "object-curly-newline": ["off"],
-    "object-curly-spacing": ["off"],
-    "object-property-newline": ["off"],
-    "object-shorthand": ["off"],
-    "one-var": ["off"],
-    "one-var-declaration-per-line": ["off"],
-    "operator-assignment": ["off"],
-    "operator-linebreak": ["off", "none"],
-    "padded-blocks": ["off"],
-    "padding-line-between-statements": ["error"],
-    "prefer-arrow-callback": ["off"],
-    "prefer-const": ["off"],
-    "prefer-destructuring": ["off"],
-    "prefer-numeric-literals": ["error"],
-    "prefer-promise-reject-errors": ["off"],
-    "prefer-reflect": ["off"],
-    "prefer-rest-params": ["off"],
-    "prefer-spread": ["off"],
-    "prefer-template": ["off"],
-    "quote-props": ["off"],
-    quotes: ["off"],
-    radix: ["off", "as-needed"],
-    "require-await": ["off"],
-    "require-jsdoc": ["off"],
-    "require-yield": ["error"],
-    "rest-spread-spacing": ["error", "never"],
-    semi: ["off"],
-    "semi-spacing": ["off"],
-    "semi-style": ["error", "last"],
-    "sort-imports": ["off"],
-    "sort-keys": ["off"],
-    "sort-vars": ["off"],
-    "space-before-blocks": ["off"],
-    "space-before-function-paren": ["off"],
-    "space-in-parens": ["off"],
-    "space-infix-ops": ["off"],
-    "space-unary-ops": ["off"],
-    "spaced-comment": ["off"],
-    strict: ["off"],
-    "switch-colon-spacing": [
-      "error",
-      {
-        after: true,
-        before: false,
-      },
-    ],
-    "symbol-description": ["error"],
-    "template-curly-spacing": ["error"],
-    "template-tag-spacing": ["error"],
-    "unicode-bom": ["error", "never"],
-    "use-isnan": ["error"],
-    "valid-jsdoc": ["off"],
-    "valid-typeof": ["error"],
-    "vars-on-top": ["off"],
-    "wrap-iife": ["error", "any"],
-    "wrap-regex": ["off"],
-    "yield-star-spacing": ["error", "before"],
-    yoda: ["error", "never"],
-    "@typescript-eslint/explicit-module-boundary-types": "off",
-    "@typescript-eslint/explicit-function-return-type": "off",
+    "@typescript-eslint/ban-ts-comment": "off",
+    "@typescript-eslint/no-explicit-any": "off",
   },
-  overrides: [
-    {
-      // enable the rule specifically for TypeScript files
-      files: ["*.ts", "*.tsx"],
-      rules: {
-        "@typescript-eslint/explicit-function-return-type": ["error"],
-        "@typescript-eslint/explicit-module-boundary-types": ["error"],
-      },
-    },
-    {
-      // TypeScript configuration
-      files: ["**/*.ts", "**/*.tsx"],
-      parser: "@typescript-eslint/parser",
-      plugins: ["@typescript-eslint"],
-      extends: ["plugin:@typescript-eslint/recommended"],
-      rules: {
-        "lines-between-class-members": "off",
-        "no-empty-pattern": "off",
-        "no-useless-constructor": [
-          "off", // Valid for typescript due to property ctor shorthand
-        ],
-        "@typescript-eslint/ban-ts-comment": "off",
-        "@typescript-eslint/ban-ts-ignore": "off",
-        "@typescript-eslint/camelcase": "off",
-        "@typescript-eslint/explicit-function-return-type": [
-          "error",
-          {
-            allowExpressions: true,
-          },
-        ],
-        "@typescript-eslint/member-delimiter-style": [
-          "error",
-          {
-            multiline: {
-              delimiter: "semi",
-              requireLast: true,
-            },
-            singleline: {
-              delimiter: "semi",
-              requireLast: false,
-            },
-          },
-        ],
-        "@typescript-eslint/member-ordering": [
-          "error",
-          {
-            default: [
-              "signature",
-              "static-field",
-              "instance-field",
-              "abstract-field",
-              "constructor",
-              "instance-method",
-              "abstract-method",
-              "static-method",
-            ],
-          },
-        ],
-        "@typescript-eslint/no-explicit-any": "off",
-        "@typescript-eslint/no-use-before-define": "off",
-      },
-    },
-  ],
 };

.github/PULL_REQUEST_TEMPLATE

@@ -1,5 +1,27 @@
+# Only bugfix are accepted
+
 # DELETE THIS AFTER READING
 
+# READ CONTRIBUTING.md
+
+# PR title
+
+Formatted as such:
+SECTION: PLAYER DESCRIPTION
+
+SECTION is something like "API", "UI", "MISC", "STANEK", "CORPORATION"
+PLAYER DESCRIPTION is what you'd tell a non-contributor to convey what is changed.
+
+# Linked issues
+
+If your pull request is related to a git issue, please link it in the description using #xyz.
+If your PR should close the issue when it is merged in, use `fixes #xyz` or `closes #xyz` like this:
+
+closes #xxxx
+closes #yyyy
+
+It'll automate the process.
+
 # Documentation
 
 - DO NOT CHANGE any markdown/\*.md, these files are autogenerated from NetscriptDefinitions.d.ts and will be overwritten
@@ -9,3 +31,5 @@
 
 - Include how it was tested
 - Include screenshot / gif (if possible)
+
+Make sure you run `npm run format` and `npm run lint` before pushing.

.github/workflows/bump-version.yml

@@ -0,0 +1,100 @@
+name: Bump BitBurner Version
+
+on:
+  workflow_dispatch:
+    inputs:
+      version:
+        description: "Version (format: x.y.z)"
+        required: true
+      versionNumber:
+        description: "Version Number (for saves migration)"
+        required: true
+      changelog:
+        description: "Changelog (url that points to RAW markdown)"
+        default: ""
+      buildApp:
+        description: "Include Application Build"
+        type: boolean
+        default: "true"
+        required: true
+      buildDoc:
+        description: "Include Documentation Build"
+        type: boolean
+        default: "true"
+        required: true
+      prepareRelease:
+        description: "Prepare Draft Release"
+        type: boolean
+        default: "true"
+        required: true
+
+jobs:
+  bumpVersion:
+    name: Bump Version
+    runs-on: ubuntu-latest
+    permissions:
+      contents: write
+      pull-requests: write
+    steps:
+      - name: Install pandoc dependency
+        run: sudo apt-get install -y pandoc
+      - name: Checkout repository
+        uses: actions/checkout@v2
+        with:
+          fetch-depth: 0
+      - name: Use Node.js 16.13.1
+        uses: actions/setup-node@v2
+        with:
+          node-version: 16.13.1
+          cache: "npm"
+      - name: Install NPM dependencies for version updater
+        working-directory: ./tools/bump-version
+        run: npm ci
+      - name: Bump version & update changelogs
+        working-directory: ./tools/bump-version
+        run: |
+          curl ${{ github.event.inputs.changelog }} > changes.md
+          node index.js --version=${{ github.event.inputs.version }} --versionNumber=${{ github.event.inputs.versionNumber }} < changes.md
+      - name: Install NPM dependencies for app
+        if: ${{ github.event.inputs.buildApp == 'true' || github.event.inputs.buildDoc == 'true' }}
+        run: npm ci
+      - name: Build Production App
+        if: ${{ github.event.inputs.buildApp == 'true' }}
+        run: npm run build
+      - name: Build Documentation
+        if: ${{ github.event.inputs.buildDoc == 'true' }}
+        run: npm run doc
+      - name: Commit Files
+        run: |
+          git config --global user.name "GitHub"
+          git config --global user.email "noreply@github.com"
+          git checkout -b bump/v${{ github.event.inputs.version }}
+          git add -A
+          echo "Bump version to v${{ github.event.inputs.version }}" > commitmessage.txt
+          echo "" >> commitmessage.txt
+          cat ./tools/bump-version/changes.md >> commitmessage.txt
+          git commit -F commitmessage.txt
+          git push -u origin bump/v${{ github.event.inputs.version }}
+      - name: Create Pull Request
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+        run: |
+          gh pr create \
+            --base "${{ github.ref_name }}" \
+            --head "bump/v${{ github.event.inputs.version }}" \
+            --title "Bump version to v${{ github.event.inputs.version }}" \
+            --body-file ./tools/bump-version/changes.md
+      - name: Prepare release
+        if: ${{ github.event.inputs.prepareRelease == 'true' }}
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+        run: |
+          RELEASE_TITLE="$(head -n 1 ./tools/bump-version/changes.md | sed 's/## //')"
+          RELEASE_TITLE="${RELEASE_TITLE:-v${{ github.event.inputs.version }}}"
+          gh release create \
+            v${{ github.event.inputs.version }} \
+            --target dev \
+            --title "$RELEASE_TITLE" \
+            --notes-file ./tools/bump-version/changes.md \
+            --generate-notes \
+            --draft

.github/workflows/check-for-generated-files.yml

@@ -0,0 +1,85 @@
+name: Check for Generated Files
+
+on:
+  # Triggers the workflow on push or pull request events but only for the dev branch
+  pull_request:
+    branches: [dev]
+
+  # Allows you to run this workflow manually from the Actions tab
+  workflow_dispatch:
+
+jobs:
+  checkFiles:
+    name: Check Files
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout files
+        uses: actions/checkout@v2
+
+      - name: Check bundle files
+        id: changed-bundle-files
+        uses: tj-actions/changed-files@v18.4
+        with:
+          files: |
+            dist/*
+            index.html
+            main.bundle.js
+            main.bundle.js.map
+
+      - name: Check documentation changes
+        id: changed-markdown-doc-files
+        uses: tj-actions/changed-files@v18.4
+        with:
+          files: |
+            markdown/*.md
+
+      - name: Warn when bundle files were changed
+        id: warn-bundles-changed
+        if: steps.changed-bundle-files.outputs.any_changed == 'true'
+        run: |
+          echo "One or more files in the bundle files were changed." >> warnings.txt
+
+      - name: Warn when documentation markdown files were changed
+        id: warn-markdown-changed
+        if: steps.changed-markdown-doc-files.outputs.any_changed == 'true'
+        run: |
+          echo "One or more files in the markdown documentation were changed." >> warnings.txt
+
+      - name: Print Warnings
+        id: get-warnings
+        run: |
+          if [ -f warnings.txt ]
+          then
+            echo "::set-output name=has_warnings::true"
+          else
+            echo "::set-output name=has_warnings::false"
+            touch warnings.txt
+          fi
+
+      - name: Get Comment Body
+        id: get-comment-body
+        if: steps.get-warnings.outputs.has_warnings == 'true'
+        run: |
+          cat warnings.txt > comment.txt
+          echo "" >> comment.txt
+          echo "Please do not commit files generated by webpack or generated markdown" >> comment.txt
+          echo "" >> comment.txt
+          echo "See [CONTRIBUTING.md](https://github.com/danielyxie/bitburner/blob/dev/doc/CONTRIBUTING.md) for details." >> comment.txt
+
+          body=$(cat comment.txt)
+          body="${body//'%'/'%25'}"
+          body="${body//$'\n'/'%0A'}"
+          body="${body//$'\r'/'%0D'}"
+
+          echo ::set-output name=body::$body
+      - name: Add github comment on problem
+        if: steps.get-warnings.outputs.has_warnings == 'true'
+        uses: peter-evans/commit-comment@v1
+        with:
+          body: ${{ steps.get-comment-body.outputs.body }}
+      - name: Flag as error
+        if: steps.get-warnings.outputs.has_warnings == 'true'
+        run: |
+          COMMIT_WARNINGS=$(cat warnings.txt)
+          echo "::warning:: $COMMIT_WARNINGS"
+          exit 1

.github/workflows/ci-pr.yml

@@ -0,0 +1,71 @@
+name: CI Pull Request
+
+on:
+  # Triggers the workflow on pull request events but only for the dev branch, checking only diffs
+  pull_request:
+    branches: [dev]
+
+  # Allows you to run this workflow manually from the Actions tab
+  workflow_dispatch:
+
+jobs:
+  build:
+    name: Build
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v2
+      - name: Use Node.js 16.13.1
+        uses: actions/setup-node@v2
+        with:
+          node-version: 16.13.1
+          cache: "npm"
+      - name: Install npm dependencies
+        run: npm ci
+      - name: Build the production app
+        run: npm run build
+  lint:
+    name: Lint
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v2
+        with:
+          fetch-depth: 0
+      - name: Use Node.js 16.13.1
+        uses: actions/setup-node@v2
+        with:
+          node-version: 16.13.1
+          cache: "npm"
+      - name: Install npm dependencies
+        run: npm ci
+      - name: Run linter
+        run: npm run lint:report-diff
+  prettier:
+    name: Prettier
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v2
+        with:
+          fetch-depth: 0
+      - name: Use Node.js 16.13.1
+        uses: actions/setup-node@v2
+        with:
+          node-version: 16.13.1
+          cache: "npm"
+      - name: Install npm dependencies
+        run: npm ci
+      - name: Run prettier check
+        run: npm run format:report-diff
+  test:
+    name: Test
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v2
+      - name: Use Node.js 16.13.1
+        uses: actions/setup-node@v2
+        with:
+          node-version: 16.13.1
+          cache: "npm"
+      - name: Install npm dependencies
+        run: npm ci
+      - name: Run tests
+        run: npm run test

.github/workflows/ci.yml

@@ -1,11 +1,9 @@
 name: CI
 
 on:
-  # Triggers the workflow on push or pull request events but only for the dev branch
+  # Triggers the workflow on push events but only for the dev branch
   push:
-    branches: [ dev ]
-  pull_request:
-    branches: [ dev ]
+    branches: [dev]
 
   # Allows you to run this workflow manually from the Actions tab
   workflow_dispatch:
@@ -20,7 +18,7 @@ jobs:
         uses: actions/setup-node@v2
         with:
           node-version: 16.13.1
-          cache: 'npm'
+          cache: "npm"
       - name: Install npm dependencies
         run: npm ci
       - name: Build the production app
@@ -34,11 +32,25 @@ jobs:
         uses: actions/setup-node@v2
         with:
           node-version: 16.13.1
-          cache: 'npm'
+          cache: "npm"
       - name: Install npm dependencies
         run: npm ci
       - name: Run linter
         run: npm run lint:report
+  prettier:
+    name: Prettier
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v2
+      - name: Use Node.js 16.13.1
+        uses: actions/setup-node@v2
+        with:
+          node-version: 16.13.1
+          cache: "npm"
+      - name: Install npm dependencies
+        run: npm ci
+      - name: Run prettier check
+        run: npm run format:report
   test:
     name: Test
     runs-on: ubuntu-latest
@@ -48,7 +60,7 @@ jobs:
         uses: actions/setup-node@v2
         with:
           node-version: 16.13.1
-          cache: 'npm'
+          cache: "npm"
       - name: Install npm dependencies
         run: npm ci
       - name: Run tests

.github/workflows/fetch-changes.yml

@@ -0,0 +1,44 @@
+name: Fetch Merged Changes
+on:
+  workflow_dispatch:
+    inputs:
+      fromCommit:
+        description: "From Commit SHA (full-length)"
+        required: true
+      toCommit:
+        description: "To Commit SHA (full-length, if omitted will use latest)"
+
+jobs:
+  fetchChangelog:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v2
+      - name: Use Node v16.13.1
+        uses: actions/setup-node@v2
+        with:
+          node-version: 16.13.1
+          cache: "npm"
+      - name: Install NPM dependencies
+        working-directory: ./tools/fetch-changelog
+        run: npm ci
+      - name: Fetch Changes from GitHub API
+        working-directory: ./tools/fetch-changelog
+        env:
+          GITHUB_API_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+        run: |
+          node index.js \
+            --from=${{ github.event.inputs.fromCommit }} \
+            --to=${{ github.event.inputs.toCommit }} > changes.md
+          echo
+          echo "============================================================"
+          echo
+          cat changes.md
+          echo
+          echo "============================================================"
+          echo
+          echo "You may want to go to https://gist.github.com/ to upload the final changelog"
+          echo "The next step will require an url because we can't easily pass multiline strings to actions"
+      - uses: actions/upload-artifact@v2
+        with:
+          name: bitburner_changelog___DRAFT.md
+          path: ./tools/fetch-changelog/changes.md

.github/workflows/validate-pr.yml

@@ -0,0 +1,64 @@
+name: Validate PR
+
+on:
+  pull_request:
+    branches: [dev]
+    types: [opened, edited, synchronize, reopened]
+
+jobs:
+  checkTitle:
+    name: Check Title
+    runs-on: ubuntu-latest
+    if: github.event_name == 'pull_request'
+    steps:
+      - name: Validate Title
+        id: validate-pr-title
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+        run: |
+          echo "Creating label (if it does not exist)"
+          LABEL="validation: invalid title"
+          gh --repo "${{ github.repository }}" \
+            label create "$LABEL" --description "Modifications to this pull request are requested" --color D93F0B || true
+
+          PR_TITLE=$(\
+            gh --repo "${{ github.repository }}" \
+              pr view "${{ github.event.number }}" --json title --jq .title)
+          echo "::set-output name=title::$PR_TITLE"
+          echo "PR Title: $PR_TITLE"
+
+          TITLE_REGEX="^[0-9A-Z\-]*: .*$"
+          PR_TITLE_VALID=$(echo "$PR_TITLE" | grep -Eq "$TITLE_REGEX" && echo "true" || echo "false")
+
+          if [ "$PR_TITLE_VALID" == "true" ]; then
+            echo "Title is valid, removing label"
+            gh --repo "${{ github.repository }}" \
+              pr edit "${{ github.event.number }}" --remove-label "$LABEL" || true
+          else
+            echo "Invalid Title"
+            ERROR_MSG="$PR_TITLE -> should match -> $TITLE_REGEX"
+            echo "$ERROR_MSG"
+            echo "::set-output name=invalid::true"
+            echo "::set-output name=errorMessage::$ERROR_MSG"
+
+            touch comment.txt
+            echo "## The title \`$PR_TITLE\` should match \`$TITLE_REGEX\`" >> comment.txt
+            echo "" >> comment.txt
+            echo "SECTION: FIX #xzyw PLAYER DESCRIPTION" >> comment.txt
+            echo "" >> comment.txt
+            echo 'SECTION is something like "API", "UI", "MISC", "STANEK", "CORPORATION"' >> comment.txt
+            echo 'FIX #xyzw is the issue number, if any' >> comment.txt
+            echo "PLAYER DESCRIPTION is what you'd tell a non-contributor to convey what is changed." >> comment.txt
+
+            echo "Add pr label"
+            gh --repo "${{ github.repository }}" \
+              pr edit "${{ github.event.number }}" --add-label "$LABEL"
+            echo "And comment on the pr"
+            gh --repo "${{ github.repository }}" \
+              pr comment "${{ github.event.number }}" --body-file comment.txt
+          fi
+      - name: Flag workflow error
+        if: steps.validate-pr-title.outputs.invalid == 'true'
+        run: |
+          echo "${{ steps.validate-pr-title.outputs.errorMessage }}"
+          exit 1

.gitignore

@@ -1,14 +1,15 @@
 .DS_Store
+.history
 .vscode
 Changelog.txt
 Netburner.txt
 /doc/build
 /node_modules
 /electron/node_modules
-/dist/*.map
 /test/*.map
 /test/*.bundle.*
 /test/*.css
+/input/bitburner.api.json
 .cypress
 
 # tmp folder for electron
@@ -17,3 +18,5 @@ Netburner.txt
 
 # editor files
 .vscode
+
+.idea/

.npmrc

@@ -0,0 +1,3 @@
+# Default "npm version" commit message
+# See: https://stackoverflow.com/a/34606092
+message=":bookmark: Build v%s"

CODE_OF_CONDUCT.md

@@ -0,0 +1 @@
+Don't be an ass.

README.md

@@ -1,12 +1,14 @@
 # Bitburner
 
+[![Join Discord](https://img.shields.io/discord/415207508303544321)](https://discord.gg/TFc3hKD)
+
 [![Build Status](https://github.com/danielyxie/bitburner/actions/workflows/ci.yml/badge.svg?branch=dev)](https://github.com/danielyxie/bitburner/actions/workflows/ci.yml)
 
 Bitburner is a programming-based [incremental game](https://en.wikipedia.org/wiki/Incremental_game)
 that revolves around hacking and cyberpunk themes.
 The game can be played at https://danielyxie.github.io/bitburner or installed through [Steam](https://store.steampowered.com/app/1812820/Bitburner/).
 
-See the [frequently asked questions](./FAQ.md) for more information . To discuss the game or get help, join the [official discord server](https://discord.gg/TFc3hKD)
+See the [frequently asked questions](./doc/FAQ.md) for more information . To discuss the game or get help, join the [official Discord server](https://discord.gg/TFc3hKD).
 
 # Documentation
 
@@ -17,14 +19,14 @@ The [in-game documentation](./markdown/bitburner.md) is generated from the [Type
 
 Anyone is welcome to contribute to the documentation by editing the [source
 files](/doc/source) and then making a pull request with your contributions.
-For further guidance, please refer to the "As A Documentor" section of
-[CONTRIBUTING](CONTRIBUTING.md).
+For further guidance, please refer to the "As A Documenter" section of
+[CONTRIBUTING](./doc/CONTRIBUTING.md).
 
 # Contribution
 
 There are many ways to contribute to the game. It can be as simple as fixing
 a typo, correcting a bug, or improving the UI. For guidance on doing so,
-please refer to the [CONTRIBUTING](CONTRIBUTING.md) document.
+please refer to the [CONTRIBUTING](./doc/CONTRIBUTING.md) document.
 
 You will retain all ownership of the Copyright of any contributions you make,
 and will have the same rights to use or license your contributions. By

css/staneksgift.scss

@@ -1,23 +0,0 @@
-.staneksgift_row {
-  padding: 0;
-  margin: 0;
-}
-
-.staneksgift_cell {
-  width: 25px;
-  height: 25px;
-  background-color: #808080;
-  font-color: white;
-  padding: 0px;
-  margin: 0px;
-  border: 1px solid black;
-  float: left;
-}
-
-.staneksgift_cell:first-child {
-  clear: left;
-}
-
-.staneksgift_container {
-  position: fixed;
-}

cypress.json

@@ -1,10 +1,14 @@
 {
   "baseUrl": "http://localhost:8000",
-  "fixturesFolder": false,
   "trashAssetsBeforeRuns": true,
-  "screenshotsFolder": ".cypress/screenshots",
-  "videosFolder": ".cypress/videos",
   "videoUploadOnPasses": false,
   "viewportWidth": 1980,
-  "viewportHeight": 1080
+  "viewportHeight": 1080,
+  "fixturesFolder": "test/cypress/fixtures",
+  "integrationFolder": "test/cypress/integration",
+  "pluginsFile": "test/cypress/plugins/index.js",
+  "supportFile": "test/cypress/support/index.js",
+  "screenshotsFolder": ".cypress/screenshots",
+  "videosFolder": ".cypress/videos",
+  "downloadsFolder": ".cypress/downloads"
 }

cypress/support/globalHooks.ts

@@ -1,9 +0,0 @@
-export {};
-
-beforeEach(() => {
-  cy.visit("/");
-  cy.clearLocalStorage();
-  cy.window().then((win) => {
-    win.indexedDB.deleteDatabase("bitburnerSave");
-  });
-});

dist/engineStyle.bundle.js

@@ -1,2 +0,0 @@
-!function(n){function t(t){for(var e,i,f=t[0],c=t[1],l=t[2],a=0,s=[];a<f.length;a++)i=f[a],Object.prototype.hasOwnProperty.call(r,i)&&r[i]&&s.push(r[i][0]),r[i]=0;for(e in c)Object.prototype.hasOwnProperty.call(c,e)&&(n[e]=c[e]);for(p&&p(t);s.length;)s.shift()();return u.push.apply(u,l||[]),o()}function o(){for(var n,t=0;t<u.length;t++){for(var o=u[t],e=!0,f=1;f<o.length;f++){var c=o[f];0!==r[c]&&(e=!1)}e&&(u.splice(t--,1),n=i(i.s=o[0]))}return n}var e={},r={2:0},u=[];function i(t){if(e[t])return e[t].exports;var o=e[t]={i:t,l:!1,exports:{}};return n[t].call(o.exports,o,o.exports,i),o.l=!0,o.exports}i.m=n,i.c=e,i.d=function(n,t,o){i.o(n,t)||Object.defineProperty(n,t,{enumerable:!0,get:o})},i.r=function(n){"undefined"!=typeof Symbol&&Symbol.toStringTag&&Object.defineProperty(n,Symbol.toStringTag,{value:"Module"}),Object.defineProperty(n,"__esModule",{value:!0})},i.t=function(n,t){if(1&t&&(n=i(n)),8&t)return n;if(4&t&&"object"==typeof n&&n&&n.__esModule)return n;var o=Object.create(null);if(i.r(o),Object.defineProperty(o,"default",{enumerable:!0,value:n}),2&t&&"string"!=typeof n)for(var e in n)i.d(o,e,function(t){return n[t]}.bind(null,e));return o},i.n=function(n){var t=n&&n.__esModule?function(){return n.default}:function(){return n};return i.d(t,"a",t),t},i.o=function(n,t){return Object.prototype.hasOwnProperty.call(n,t)},i.p="";var f=window.webpackJsonp=window.webpackJsonp||[],c=f.push.bind(f);f.push=t,f=f.slice();for(var l=0;l<f.length;l++)t(f[l]);var p=c;u.push([1281,0]),o()}({1281:function(n,t,o){"use strict";o.r(t);o(1282),o(1284),o(1286),o(1288),o(1290),o(1292),o(1294),o(1296),o(1298),o(1300),o(1302),o(1304),o(1306),o(1308),o(1310),o(1312),o(1314),o(1316),o(1318),o(1320),o(1322),o(1324),o(1326),o(1328),o(1330),o(1332),o(1334),o(1336),o(1338),o(1340)},1284:function(n,t,o){},1286:function(n,t,o){},1288:function(n,t,o){},1290:function(n,t,o){},1292:function(n,t,o){},1294:function(n,t,o){},1296:function(n,t,o){},1298:function(n,t,o){},1300:function(n,t,o){},1302:function(n,t,o){},1304:function(n,t,o){},1306:function(n,t,o){},1308:function(n,t,o){},1310:function(n,t,o){},1312:function(n,t,o){},1314:function(n,t,o){},1316:function(n,t,o){},1318:function(n,t,o){},1320:function(n,t,o){},1322:function(n,t,o){},1324:function(n,t,o){},1326:function(n,t,o){},1328:function(n,t,o){},1330:function(n,t,o){},1332:function(n,t,o){},1334:function(n,t,o){},1336:function(n,t,o){},1338:function(n,t,o){},1340:function(n,t,o){}});
-//# sourceMappingURL=engineStyle.bundle.js.map

dist/vendor.css

@@ -1,301 +0,0 @@
-/*! normalize.css v8.0.0 | MIT License | github.com/necolas/normalize.css */
-/* Document
-   ========================================================================== */
-/**
- * 1. Correct the line height in all browsers.
- * 2. Prevent adjustments of font size after orientation changes in iOS.
- */
-html {
-  line-height: 1.15;
-  /* 1 */
-  -webkit-text-size-adjust: 100%;
-  /* 2 */ }
-
-/* Sections
-   ========================================================================== */
-/**
- * Remove the margin in all browsers.
- */
-body {
-  margin: 0; }
-
-/**
- * Correct the font size and margin on `h1` elements within `section` and
- * `article` contexts in Chrome, Firefox, and Safari.
- */
-h1 {
-  font-size: 2em;
-  margin: 0.67em 0; }
-
-/* Grouping content
-   ========================================================================== */
-/**
- * 1. Add the correct box sizing in Firefox.
- * 2. Show the overflow in Edge and IE.
- */
-hr {
-  box-sizing: content-box;
-  /* 1 */
-  height: 0;
-  /* 1 */
-  overflow: visible;
-  /* 2 */ }
-
-/**
- * 1. Correct the inheritance and scaling of font size in all browsers.
- * 2. Correct the odd `em` font sizing in all browsers.
- */
-pre {
-  font-family: monospace, monospace;
-  /* 1 */
-  font-size: 1em;
-  /* 2 */ }
-
-/* Text-level semantics
-   ========================================================================== */
-/**
- * Remove the gray background on active links in IE 10.
- */
-a {
-  background-color: transparent; }
-
-/**
- * 1. Remove the bottom border in Chrome 57-
- * 2. Add the correct text decoration in Chrome, Edge, IE, Opera, and Safari.
- */
-abbr[title] {
-  border-bottom: none;
-  /* 1 */
-  text-decoration: underline;
-  /* 2 */
-  text-decoration: underline dotted;
-  /* 2 */ }
-
-/**
- * Add the correct font weight in Chrome, Edge, and Safari.
- */
-b,
-strong {
-  font-weight: bolder; }
-
-/**
- * 1. Correct the inheritance and scaling of font size in all browsers.
- * 2. Correct the odd `em` font sizing in all browsers.
- */
-code,
-kbd,
-samp {
-  font-family: monospace, monospace;
-  /* 1 */
-  font-size: 1em;
-  /* 2 */ }
-
-/**
- * Add the correct font size in all browsers.
- */
-small {
-  font-size: 80%; }
-
-/**
- * Prevent `sub` and `sup` elements from affecting the line height in
- * all browsers.
- */
-sub,
-sup {
-  font-size: 75%;
-  line-height: 0;
-  position: relative;
-  vertical-align: baseline; }
-
-sub {
-  bottom: -0.25em; }
-
-sup {
-  top: -0.5em; }
-
-/* Embedded content
-   ========================================================================== */
-/**
- * Remove the border on images inside links in IE 10.
- */
-img {
-  border-style: none; }
-
-/* Forms
-   ========================================================================== */
-/**
- * 1. Change the font styles in all browsers.
- * 2. Remove the margin in Firefox and Safari.
- */
-button,
-input,
-optgroup,
-select,
-textarea {
-  font-family: inherit;
-  /* 1 */
-  font-size: 100%;
-  /* 1 */
-  line-height: 1.15;
-  /* 1 */
-  margin: 0;
-  /* 2 */ }
-
-/**
- * Show the overflow in IE.
- * 1. Show the overflow in Edge.
- */
-button,
-input {
-  /* 1 */
-  overflow: visible; }
-
-/**
- * Remove the inheritance of text transform in Edge, Firefox, and IE.
- * 1. Remove the inheritance of text transform in Firefox.
- */
-button,
-select {
-  /* 1 */
-  text-transform: none; }
-
-/**
- * Correct the inability to style clickable types in iOS and Safari.
- */
-button,
-[type="button"],
-[type="reset"],
-[type="submit"] {
-  -webkit-appearance: button; }
-
-/**
- * Remove the inner border and padding in Firefox.
- */
-button::-moz-focus-inner,
-[type="button"]::-moz-focus-inner,
-[type="reset"]::-moz-focus-inner,
-[type="submit"]::-moz-focus-inner {
-  border-style: none;
-  padding: 0; }
-
-/**
- * Restore the focus styles unset by the previous rule.
- */
-button:-moz-focusring,
-[type="button"]:-moz-focusring,
-[type="reset"]:-moz-focusring,
-[type="submit"]:-moz-focusring {
-  outline: 1px dotted ButtonText; }
-
-/**
- * Correct the padding in Firefox.
- */
-fieldset {
-  padding: 0.35em 0.75em 0.625em; }
-
-/**
- * 1. Correct the text wrapping in Edge and IE.
- * 2. Correct the color inheritance from `fieldset` elements in IE.
- * 3. Remove the padding so developers are not caught out when they zero out
- *    `fieldset` elements in all browsers.
- */
-legend {
-  box-sizing: border-box;
-  /* 1 */
-  color: inherit;
-  /* 2 */
-  display: table;
-  /* 1 */
-  max-width: 100%;
-  /* 1 */
-  padding: 0;
-  /* 3 */
-  white-space: normal;
-  /* 1 */ }
-
-/**
- * Add the correct vertical alignment in Chrome, Firefox, and Opera.
- */
-progress {
-  vertical-align: baseline; }
-
-/**
- * Remove the default vertical scrollbar in IE 10+.
- */
-textarea {
-  overflow: auto; }
-
-/**
- * 1. Add the correct box sizing in IE 10.
- * 2. Remove the padding in IE 10.
- */
-[type="checkbox"],
-[type="radio"] {
-  box-sizing: border-box;
-  /* 1 */
-  padding: 0;
-  /* 2 */ }
-
-/**
- * Correct the cursor style of increment and decrement buttons in Chrome.
- */
-[type="number"]::-webkit-inner-spin-button,
-[type="number"]::-webkit-outer-spin-button {
-  height: auto; }
-
-/**
- * 1. Correct the odd appearance in Chrome and Safari.
- * 2. Correct the outline style in Safari.
- */
-[type="search"] {
-  -webkit-appearance: textfield;
-  /* 1 */
-  outline-offset: -2px;
-  /* 2 */ }
-
-/**
- * Remove the inner padding in Chrome and Safari on macOS.
- */
-[type="search"]::-webkit-search-decoration {
-  -webkit-appearance: none; }
-
-/**
- * 1. Correct the inability to style clickable types in iOS and Safari.
- * 2. Change font properties to `inherit` in Safari.
- */
-::-webkit-file-upload-button {
-  -webkit-appearance: button;
-  /* 1 */
-  font: inherit;
-  /* 2 */ }
-
-/* Interactive
-   ========================================================================== */
-/*
- * Add the correct display in Edge, IE 10+, and Firefox.
- */
-details {
-  display: block; }
-
-/*
- * Add the correct display in all browsers.
- */
-summary {
-  display: list-item; }
-
-/* Misc
-   ========================================================================== */
-/**
- * Add the correct display in IE 10+.
- */
-template {
-  display: none; }
-
-/**
- * Add the correct display in IE 10.
- */
-[hidden] {
-  display: none; }
-
-
-/*# sourceMappingURL=vendor.css.map*/

doc/CONTRIBUTING.md

@@ -1,24 +1,26 @@
+# Only bugfix are accepted
+
 # Contributing to Bitburner
 
 ## In General
 
 The game is made better because the community as a whole speaks up about
-ways to improve the game. Here's some of the ways you can make your voice
+ways to improve the game. Here are some of the ways you can make your voice
 heard:
 
-- [Discord](https://discord.gg/XKEGvHqVr3)
+- [Discord](https://discord.gg/XKEGvHqVr3).
   There is a dedicated Discord instance set up for more free-form chats
   between all members of the community. Regular players, heavy scripters,
   Bitburner contributors, and everyone in between can be found on the
   server.
-- [Github Issues](https://github.com/danielyxie/bitburner/issues)
+- [Github Issues](https://github.com/danielyxie/bitburner/issues).
   Although the term "issues" can have a negative connotation, they are a
-  means of communicating with the community. A new Issue can be a
+  means of communicating with the community. A new Issue can be an
   interesting new feature that you feel would improve the game. It could be
   an unexpected behavior within the game. Or because the game is about
   scripting perhaps there is something that is conflicting with the
-  browser's Javascript interaction. So please do not be afraid to open a
-  [new issue](https://github.com/danielyxie/bitburner/issues/new).
+  browser's JavaScript interaction. So please do not be afraid to open a
+  [new Issue](https://github.com/danielyxie/bitburner/issues/new).
 
 ## Reporting Bugs
 
@@ -33,16 +35,17 @@ already been reported as an [Issue](https://github.com/danielyxie/bitburner/issu
 
 #### How to Submit a Good Bug Report
 
-- **Use a clear and descriptive title** for the issue
-- **State your browser, your browser's version, and your computer's OS**
-- **Attach your save file**, if you think it would help solve the issue
+- **Use a clear and descriptive title** for the Issue.
+- **State your browser, your browser's version, and your computer's OS.**
+- **Attach your save file**, if you think it would help solve the Issue.
+  Zip your save file first, then attach the zipped save file.
 - **Provide instructions on how to reproduce the bug** in as much detail
   as possible. If you cannot reliably reproduce the bug, then just try
-  your best to explain what was happening when the bug occurred
-- **Provide any scripts** that triggered the bug if the issue is Netscript-related
+  your best to explain what was happening when the bug occurred.
+- **Provide any scripts** that triggered the bug if the Issue is Netscript-related.
 - **Open your browser's Dev Console and report any error-related output**
   that may be printed there. The Dev Console can be opened on most modern
-  browsers by pressing F12
+  browsers by pressing F12.
 
 ## As a Developer
 
@@ -71,13 +74,13 @@ changes are okay to contribute:
 
 ##### Contributions that Will Most Likely Be Accepted
 
-- Bug Fixes
-- Quality-of-Life Changes
+- Bug fixes
+- Quality-of-life changes
   - Adding a new, commonly-requested Netscript function
   - Fixing or improving UI elements
   - Adding game settings/options
   - Adding a new Terminal command
-- Code Refactors that conform to good/standard practices
+- Code refactors that conform to good/standard practices
 
 ##### Contributions that will not be Accepted without prior approval
 
@@ -88,69 +91,108 @@ changes are okay to contribute:
 
 ## How to setup fork properly
 
-Fork and clone the repo
+Clone and fork the game's repository by using one of these methods: web browser, GitHub
+Desktop, or command line.
 
-```
-  # This will add the game original code as a repo in your local copy
-  $ git remote add danielyxie git@github.com:danielyxie/bitburner.git
+- Web browser. Log in to your GitHub account, navigate to the
+  [game's repository](https://github.com/danielyxie/bitburner), and fork the
+  repository. Refer to
+  [this page](https://docs.github.com/en/get-started/quickstart/fork-a-repo) for more
+  detail.
+- GitHub Desktop. Click on `File`, then click `Clone repository`. Click on the `URL`
+  tab and type `danielyxie/bitburner` into the text box for repository URL. Choose
+  the path where you want to clone the repository and click the `Clone` button.
+  Refer to [this page](https://docs.github.com/en/desktop/contributing-and-collaborating-using-github-desktop/adding-and-cloning-repositories/cloning-and-forking-repositories-from-github-desktop)
+  for more detail.
+- Command line.
 
-  # You can verify you did this right by doing the following command
-  $ git remote show
-  danielyxie
-  origin
+```sh
+# This clones the game's code repository. The output you get might vary.
+$ git clone https://github.com/danielyxie/bitburner.git
+Cloning into 'bitburner'...
+remote: Enumerating objects: 57072, done.
+remote: Counting objects: 100% (404/404), done.
+remote: Compressing objects: 100% (205/205), done.
+remote: Total 57072 (delta 210), reused 375 (delta 199), pack-reused 56668
+Receiving objects: 100% (57072/57072), 339.11 MiB | 5.42 MiB/s, done.
+Resolving deltas: 100% (43708/43708), done.
+Updating files: 100% (2561/2561), done.
 
-  # Then download all the branches from the game. (there might be more branches)
-  $ git fetch danielyxie
-  From github.com:danielyxie/bitburner
-  * [new branch]        dev             -> danielyxie/dev
-  * [new branch]        master          -> danielyxie/master
+# Change to the directory that contains your local copy.
+$ cd bitburner
 
-  # Makes sure you always start from `danielyxie/dev` to avoid merge conflicts.
+# The upstream is the repository that contains the game's source code. The
+# upstream is also the place where proposed changes are merged into the game.
+$ git remote rename origin upstream
+Renaming remote references: 100% (8/8), done.
+
+# The origin is your own copy or fork of the game's source code. Assume that
+# your fork will be on GitHub. Change "myname" to your GitHub username. Change
+# "myfork" to the name of your forked repository.
+$ git remote add origin https://github.com/myname/myfork
+
+# Now "origin" is your fork and "upstream" is where changes should be merged.
+$ git remote show
+origin
+upstream
+
+# You can now download all changes and branches from the upstream repository.
+# The output you get might vary.
+$ git fetch upstream
+
+# Make sure you always start from "upstream/dev" to avoid merge conflicts.
+$ git branch
+* dev
+$ git branch -r
+upstream/BN14
+upstream/HEAD -> upstream/dev
+upstream/dev
+upstream/folders
+upstream/master
 ```
 
 ## Development Workflow Best Practices
 
-- Work in a new branch forked from the `dev` branch to isolate your new code
+- Work in a new branch forked from the `dev` branch to isolate your new code.
   - Keep code-changes on a branch as small as possible. This makes it easier for code review. Each branch should be its own independent feature.
   - Regularly rebase your branch against `dev` to make sure you have the latest updates pulled.
-  - When merging, always merge your branch into `dev`. When releasing a new update, then merge `dev` into `master`
+  - When merging, always merge your branch into `dev`. When releasing a new update, merge `dev` into `master`.
 
-
-## Running locally.
+## Running locally
 
 Install
 
 - `npm` (maybe via `nvm`)
-- Github Desktop (windows only)
-- Visual Studio code (optional)
+- Github Desktop (Windows only)
+- Visual Studio Code (optional)
 
-Inside the root of the repo run
-`npm install` to install all the dependencies
-`npm run start:dev` to launch the game in dev mode.
+Inside the root of the repository run:
+
+- `npm install` to install all the dependencies; and
+- `npm run start:dev` to launch the game in dev mode.
 
 After that you can open any browser and navigate to `localhost:8000` and play the game.
 Saving a file will reload the game automatically.
 
-
 ### How to build the electron app
 
-Tested on Node v16.13.1 (LTS) on Windows
-These steps only work in a bash-like environment, like MinGW for Windows.
+Tested on Node v16.13.1 (LTS) on Windows.
+These steps only work in a Bash-like environment, like MinGW for Windows.
 
 ```sh
-# Install the main game dependencies & build the app in debug mode
-npm install
-npm run build:dev
+# Install the main game dependencies & build the app in debug mode.
+$ npm install
+$ npm run build:dev
 
-# Use electron-packager to build the app to the .build/ folder
-npm run electron
+# Use electron-packager to build the app to the .build/ folder.
+$ npm run electron
 
-# When launching the .exe directly, you'll need the steam_appid.txt file in the root
-# If not using windows, change this line accordingly
-cp .build/bitburner-win32-x64/resources/app/steam_appid.txt .build/bitburner-win32-x64/steam_appid.txt
+# When launching the .exe directly, you'll need the steam_appid.txt file in the root.
+# If not using Windows, change this line accordingly.
+$ cp .build/bitburner-win32-x64/resources/app/steam_appid.txt .build/bitburner-win32-x64/steam_appid.txt
 
 # And run the game...
-.build/bitburner-win32-x64/bitburner.exe
+$ .build/bitburner-win32-x64/bitburner.exe
 ```
 
 ### Submitting a Pull Request
@@ -158,15 +200,15 @@ cp .build/bitburner-win32-x64/resources/app/steam_appid.txt .build/bitburner-win
 When submitting a pull request with your code contributions, please abide by
 the following rules:
 
-- Work in a branch forked from `dev` to isolate the new code
-- Ensure you have latest from the [game's main
-  repository](danielyxie/bitburner@dev)
-- Rebase your branch if necessary
-- Run the game locally to test out your changes
+- Work in a branch forked from `dev` to isolate the new code.
+- Ensure you have the latest from the [game's main
+  repository](../../../tree/dev).
+- Rebase your branch if necessary.
+- Run the game locally to test out your changes.
 - When submitting the pull request, make sure that the base fork is
   _danielyxie/bitburner_ and the base is _dev_.
 - If your changes affect the game's UI, attach some screenshots or GIFs showing
-  the changes to the UI
+  the changes to the UI.
 - If your changes affect Netscript, provide some
   scripts that can be used to test the Netscript changes.
 - Ensure you have run `npm run lint` to make sure your changes conform to the
@@ -176,23 +218,23 @@ the following rules:
   in the root of the repository. These will be updated as part of official
   releases.
 
-## As a Documentor
+## As a Documenter
 
 To contribute to and view your changes to the BitBurner documentation on [Read The
 Docs](http://bitburner.readthedocs.io/), you will
 need to have Python installed, along with [Sphinx](http://www.sphinx-doc.org).
 
-To make change to the [in-game documentation](./markdown/bitburner.md), you will need to modify the [TypeScript definitions](./src/ScriptEditor/NetscriptDefinitions.d.ts), not the markdown files.
+To make change to the [in-game documentation](../markdown/bitburner.md), you will need to modify the [TypeScript definitions](../src/ScriptEditor/NetscriptDefinitions.d.ts), not the Markdown files.
 
-We are using [API Extractor](https://api-extractor.com/pages/tsdoc/doc_comment_syntax/) (tsdoc hints) to generate the markdown doc. Make your changes to the TypeScript definitions and then run `npm run doc`.
+We are using [API Extractor](https://api-extractor.com/pages/tsdoc/doc_comment_syntax/) (tsdoc hints) to generate the Markdown doc. Make your changes to the TypeScript definitions and then run `npm run doc`.
 
 Before submitting your code for a pull request, please try to follow these
 rules:
 
-- Work in a branch forked from `dev` to isolate the new code
-- Ensure you have latest from the [game's main
-  repository](danielyxie/bitburner@dev)
-- Rebase your branch if necessary
+- Work in a branch forked from `dev` to isolate the new code.
+- Ensure you have the latest from the [game's main
+  repository](../../../tree/dev).
+- Rebase your branch if necessary.
 - When submitting the pull request, make sure that the base fork is
   _danielyxie/bitburner_ and the base is _dev_.
 - Do not check in any generated files under `doc\`. The documentation is built
@@ -206,5 +248,5 @@ Update the following
 - `package.json` `version`
 - `doc/source/conf.py` `version` and `release`
 - `doc/source/changelog.rst`
-- post to discord
+- post to Discord
 - post to reddit.com/r/Bitburner

doc/FAQ.md

@@ -23,10 +23,11 @@ Yes, just export the save file from the options menu & import it in the other pl
 ## Game is stuck after running scripts!
 
 You may have created an infinite loop with no sleep. You'll have to restart the game by killing all scripts.
-* On Browser: Stick `?noScript` at the end of the URL
-* On Steam:
-  * In the menu, "Reloads" -> "Reload & Kill All Scripts".
-  * If this does not work, when launching the game, use the kill all script options.
+
+- On Browser: Stick `?noScript` at the end of the URL
+- On Steam:
+  - In the menu, "Reloads" -> "Reload & Kill All Scripts".
+  - If this does not work, when launching the game, use the kill all script options.
 
 ---
 
@@ -51,11 +52,13 @@ You can navigate to the game files by right-clicking the game in your library an
 ## Steam: Game won't launch
 
 ### **On Windows**
+
 If the game is installed on a network drive, it will fail to start due to a [limitation in Chromium](https://github.com/electron/electron/issues/27356).
 
 If you cannot move the game to another drive, you'll have to add the `--no-sandbox` launch option. In your Steam Library, Right click the game and hit "Properties". You'll see the launch option section in the "General" window.
 
 ### **On Linux**
+
 The game is built natively, do not use Proton unless native does not work.
 
 When launching the game, you will be prompted with three options. If the standard launch does not work, you may attempt the `--disable-seccomp-filter-sandbox` or `--no-sandbox` launch option. If this still does not work, the game should be able to start by launching it directly or through the terminal. See [How do I get to the game files?](#game-files).
@@ -68,17 +71,17 @@ When launching the game, you will be prompted with three options. If the standar
 
 You may want access the logs to get information about crashes or such.
 
-  * on Linux: `~/.config/bitburner/logs/main.log`
-  * on macOS: `~/Library/Logs/bitburner/main.log`
-  * on Windows: `%USERPROFILE%\AppData\Roaming\bitburner\logs\main.log`
+- on Linux: `~/.config/bitburner/logs/main.log`
+- on macOS: `~/Library/Logs/bitburner/main.log`
+- on Windows: `%USERPROFILE%\AppData\Roaming\bitburner\logs\main.log`
 
 ### Config (using [electron-store](https://github.com/sindresorhus/electron-store#readme))
 
 Configuration file will be written to disk in the application data directory.
 
-  * on Linux: `~/.config/bitburner/config.json`
-  * on macOS: `~/Library/Application\ Support/bitburner/config.json`
-  * on Windows: `%USERPROFILE%\AppData\Roaming\bitburner\config.json`
+- on Linux: `~/.config/bitburner/config.json`
+- on macOS: `~/Library/Application\ Support/bitburner/config.json`
+- on Windows: `%USERPROFILE%\AppData\Roaming\bitburner\config.json`
 
 ---
 

doc/NEW_BN_GUIDELINE.md

@@ -0,0 +1,11 @@
+Promote:
+
+- New mechanic
+- Coding problems based on NP problems. This makes solution that are easy to implement inefficient and solutions that are hard to implement efficent. (eg. Stanek)
+- inter-mechanic synergy
+- Simplicity (eg. Stanek, Hashnet. bad example: Corp)
+
+Avoid:
+
+- Failure conditions, it's very frustrating to revert several days worth of progress.
+- Making existing mechanic harder. This makes it hard to port the content to other BNs.

doc/POTENTIAL_BN_0.md

@@ -25,8 +25,8 @@ I need equations that test many different aspect of "math culture", it can be ch
 
 All variable purchasing will be scriptable.
 
-
 All equation must have:
+
 - several variables that can be upgraded, at least 1 variable must be strategic in it's upgrading (upgrading too much can cause drop in performance)
 - Some sort of math twist that requires some thinking, like (-2)^c1 alters between positive and negative.
 

doc/POTENTIAL_BN_1.md

@@ -0,0 +1,78 @@
+## Enter the Enderverse
+
+This bitnode will have your sleeves and yourself move on a 2d grid to fight the Enders.
+Players can access the Enderverse by accessing the glitch in Ishima.
+Upon doing so they will have access to a new tab in which they can view the enderverse map.
+
+The goal of this bitnode is to eliminate all the Enders in this Enderverse.
+
+### Map layout
+
+The enderverse is 10 x 10 cells big. A cell is 10 x 10 tile big. (about 4mb)
+
+Each tile has a id representing the type of terrain on it. Some terrain can be traverse/occupied by entities, others can't.
+e.g. dirt can be occupied by a sleeve but is slower than an asphalt tile.
+
+Entities also have a cell+tile coordinate but some of them can move.
+e.g. Sleeves are an entity that can be controlled by scripts.
+
+### Stats
+
+All stats but charisma are useful in the Enderverse. Althought the Enders special technology make them much less potent (like log2)
+
+Strength determines the power of your attacks
+Agility determines movement speed
+Dexterity determines accuracy of attacks
+Defense determine health points.
+
+Hacking determine the ability to interact with special objects in the world.
+
+### The base
+
+Players start in their main cell. Which contains their base. This base is where your units respawn if they die. The base can also store energy to be used later.
+
+### Moving
+
+Moving, like almost all actions, can only be done via scripts, one tile at a time. The time it takes to move to the next tile depends on the agility of the entity and the type of tile they are trying to enter. Dirt takes longer than asphalt.
+
+### Attacking
+
+An entity can chose to attack any unit within its range. At first your entities will only have a range of 1, meaning they can only attack entities directly next to them. But this can be upgraded. The damage taken is determined with the entity strength and the time is determined by agility.
+
+### Vision
+
+It's not possible to know what is on a tile unless you have a unit within range of it. Your starting units all have 3 vision, which can be upgraded.
+
+### Energy
+
+Some tiles contain minable energy. Energy can be stored in sleeves or in the base. It can be spend to upgrade your units or to build helpful tools and entities such as roads or defense systems.
+
+### Building
+
+Building can be done by any main unit to a surrounding tile. Building anything costs energy which must be carried by your unit.
+
+### Upgrades
+
+Your starting units can be upgrade with energy and rewards found in the Enderverse.
+Examples of upgradable stats:
+
+- vision range
+- attack range
+- str/agi/dex/def bonus
+- Energy capacity
+
+### Chests
+
+Chest can be found containing various improvements. From new buildings to stat upgrades for your units.
+
+### Dying
+
+When unit dies it comes back to life and gains a bonus based on it's exp. This bonus is only based on the max, it is not cummulative like gang members ascension.
+
+### Waves
+
+Every now and then the game will spawn waves of ennemies to attack the home base. If the players core is destroyed the player suffers heavy penalty. Those wave do get stronger over time but also nerfed in the event of a wipeout in order to prevent deadlock.
+
+### Non-starting cells
+
+The cells other than the starting one is where you can find better rewards but also stronger and stronger enemies. Those enemies only attack what's inside their cell and will not follow players back home. But their health is restored if none of your units are in that cell.

doc/POTENTIAL_BN_2.md

@@ -0,0 +1,3 @@
+A game of risk from the point of view of a politician.
+
+You allocate resources on a world map, trying to win elections.

doc/source/advancedgameplay.rst

@@ -12,4 +12,5 @@ must be unlocked.
     Source-Files <advancedgameplay/sourcefiles>
     Intelligence <advancedgameplay/intelligence>
     Sleeves <advancedgameplay/sleeves>
+    Grafting <advancedgameplay/grafting>
     Hacking algorithms <advancedgameplay/hackingalgorithms>

doc/source/advancedgameplay/bitnodes.rst

@@ -35,6 +35,8 @@ Furthermore, some BitNodes introduce new content and mechanics. For example ther
 BitNode that grants access to the `Singularity API <https://github.com/danielyxie/bitburner/blob/dev/markdown/bitburner.singularity.md>`_.
 There is another BitNode in which you can manage a gang to earn money and reputation.
 
+.. _gameplay_bitnodes_howtodestroy:
+
 How to destroy a BitNode
 ^^^^^^^^^^^^^^^^^^^^^^^^
 Initially, the only way to destroy a BitNode is to join the Daedalus :ref:`Daedalus <gameplay_factions>`.

doc/source/advancedgameplay/grafting.rst

@@ -0,0 +1,18 @@
+.. _gameplay_grafting:
+
+Grafting
+========
+Grafting is an experimental process through which you can obtain the benefits of
+Augmentations, without needing to reboot your body.
+
+Grafting can be done at VitaLife in New Tokyo, where you'll find a shady researcher with
+questionable connections. From there, you can spend a sum of money to begin grafting
+Augmentations. This will take some time. When done, the Augmentation will be applied to
+your character without needing to install.
+
+Be warned, some who have tested grafting have reported an unidentified malware. Dubbed
+"Entropy", this virus seems to grow in potency as more Augmentations are grafted,
+causing unpredictable affects to the victim.
+
+Note that when crafting an Augmentation, cancelling will **not** save your progress,
+and the money spent will **not** be returned.

doc/source/advancedgameplay/intelligence.rst

@@ -6,10 +6,8 @@ Intelligence is a :ref:`stat <gameplay_stats>` that is unlocked by having
 :ref:`Source-File 5 <gameplay_sourcefiles>` (i.e. Destroying BitNode-5).
 
 Intelligence is unique because it is permanent and persistent. It never gets reset
-back to 1. However, gaining Intelligence experience is extremely slow. The methods
-of gaining Intelligence exp is also hidden. You won't know when you gain
-experience and how much. It is a stat that gradually builds up as you continue
-to play the game.
+back to 1. However, gaining Intelligence experience is extremely slow. It is a stat
+that gradually builds up as you continue to play the game.
 
 Intelligence will boost your production for many actions in the game, including:
 
@@ -18,3 +16,4 @@ Intelligence will boost your production for many actions in the game, including:
 * Crime success rate
 * Bladeburner
 * Reputation gain for companies & factions
+* Augmentation grafting speed

doc/source/advancedgameplay/sleeves.rst

@@ -39,7 +39,7 @@ There are two methods of obtaining Duplicate Sleeves:
 
 1. Destroy BitNode-10. Each completion give you one additional Duplicate Sleeve
 2. Purchase Duplicate Sleeves from :ref:`the faction The Covenant <gameplay_factions>`.
-   This is only available in BitNodes-10. Sleeves purchased this way are **permanent** (they persist
+   This is only available in BitNode-10. Sleeves purchased this way are **permanent** (they persist
    through BitNodes). You can purchase up to 5 Duplicate Sleeves from The Covenant.
 
 Synchronization
@@ -86,24 +86,7 @@ switching BitNodes. For example, if a sleeve has a memory of 10, then when you
 switch BitNodes its synchronization will initially be set to 10, rather than 1.
 
 Memory can only be increased by purchasing upgrades from The Covenant. Just like
-the ability to purchase additional sleeves, this is only available in BitNodes-10
-and above, and is only available after defeating BitNode-10 at least once.
+the ability to purchase additional sleeves, this is only available in BitNode-10.
 
 Memory is a persistent stat, meaning it never gets reset back to 1.
 The maximum possible value for a sleeve's memory is 100.
-
-Re-sleeving
-^^^^^^^^^^^
-Re-sleeving is the process of digitizing and transferring your consciousness into a
-new human body, or "sleeve". When you re-sleeve into a new body, your stat experience
-and Augmentations get replaced with those of the new body.
-
-In order to re-sleeve, you must purchase new bodies. This can be done at VitaLife in
-New Tokyo. Once you purchase a body to re-sleeve into, the effects will take
-place immediately.
-
-Note that resleeving **REMOVES** all of your currently-installed Augmentations,
-and replaces them with the ones provided by the purchased sleeve. However,
-Augmentations that are purchased but not installed will **not** be removed. If you have purchased
-an Augmentation and then re-sleeve into a body which already has that Augmentation,
-it will be removed since you cannot have duplicate Augmentations.

doc/source/advancedgameplay/sourcefiles.rst

@@ -5,7 +5,7 @@
 Source-Files
 ============
 Source-Files are a type of persistent upgrade that is more powerful than Augmentations.
-Source-Files are received by destroying a BitNode. There are many different BitNodes
+Source-Files are received by :ref:`destroying a BitNode <gameplay_bitnodes_howtodestroy>`. There are many different BitNodes
 in the game and each BitNode will grant a different Source-File when it is destroyed.
 
 A Source-File can be upgraded by destroying its corresponding BitNode a second or
@@ -53,6 +53,7 @@ List of all Source-Files
 +-------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
 || BitNode-10: Digital Carbon         || * Each level of this grants a Duplicate Sleeve.                                                                                                                         |
 ||                                    || * Allows the player to access the `Sleeve API <https://github.com/danielyxie/bitburner/blob/dev/markdown/bitburner.sleeve.md>`_ in other BitNodes.                      |
+||                                    || * Grants the player access to the VitaLife secret laboratory in other BitNodes. Also grants access to the Grafting API.                                                 |
 +-------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
 || BitNode-11: The Big Crash          || * Company favor increases both the player's salary and reputation gain at that                                                                                          |
 ||                                    || company by 1% per favor (rather than just the reputation gain).                                                                                                         |
@@ -62,4 +63,8 @@ List of all Source-Files
 || BitNode-12: The Recursion          || * There is no maximum level for this Source-File.                                                                                                                       |
 ||                                    || * Let the player start with Neuroflux Governor equal to the level of this                                                                                               |
 ||                                    || Source-File.                                                                                                                                                            |
-+-------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
++-------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
+|| BitNode-13: They're lunatics       || * This Source-File lets the Church of the Machine God appear in other BitNodes.                                                                                         |
+||                                    || * Each level of this Source-File increases the size of Stanek's Gift.                                                                                                   |
+||                                    ||                                                                                                                                                                         |
++-------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------+

doc/source/basicgameplay/augmentations.rst

@@ -2,7 +2,7 @@
 
 Augmentations
 =============
-Advances in science and medicine have lead to powerful new technologies
+Advances in science and medicine have led to powerful new technologies
 that allow people to augment themselves beyond normal human capabilities.
 There are many different types of Augmentations, ranging from cybernetic
 to genetic to biological. Acquiring these Augmentations enhances the
@@ -10,8 +10,9 @@ user's physical and mental faculties.
 
 Augmentations provide persistent upgrades in the form of multipliers.
 These multipliers apply to a wide variety of things such as stats,
-experience gain, and hacking, just to name a few. Your multipliers
-can be viewed in the 'Character' page (:ref:`keyboard shortcut <shortcuts>` Alt + c).
+experience gain, and hacking, just to name a few. The effects of 
+Autmentations stack multiplicatively. Your multiplierscan be viewed in 
+the 'Character' page (:ref:`keyboard shortcut <shortcuts>` Alt + c).
 
 How to acquire Augmentations
 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^
@@ -56,7 +57,7 @@ Here is everything you will KEEP when you install an Augmentation:
 
 * Every Augmentation you have installed
 * Scripts on your home computer
-* RAM Upgrades on your home computer
+* RAM/Core Upgrades on your home computer
 * World Stock Exchange account and TIX API Access
 
 .. _gameplay_augmentations_purchasingmultiple:
@@ -75,4 +76,6 @@ will cause the Augmentations to get progressively more expensive. When
 you purchase an Augmentation, the price of purchasing another Augmentation
 doubles. This multiplier stacks for each Augmentation you
 purchase. Once you install your purchased Augmentations, their costs
-are reset back to the original prices.
+are reset back to the original prices. You can only purchase each augmentation 
+once, with the exception of NeuroFlux Governor, which can be purchased infinitely
+at increasing cost.

doc/source/basicgameplay/codingcontracts.rst

@@ -32,6 +32,18 @@ an area to provide an answer.
 Interacting through Scripts
 ^^^^^^^^^^^^^^^^^^^^^^^^^^^
 See the `Coding Contract API <https://github.com/danielyxie/bitburner/blob/dev/markdown/bitburner.codingcontract.md>`_.
+Interacting with Coding Contracts via the Terminal can be tedious the more
+contracts you solve. Consider using the API to automate various aspects of
+your solution. For example, some contracts have long solutions while others
+have even longer solutions. You might want to use the API to automate the
+process of submitting your solution rather than copy and paste a long
+solution into an answer box.
+
+However, using the API comes at a cost. Like most functions in other APIs,
+each function in the Coding Contract API has a RAM cost. Depending on which
+function you use, the initial RAM on your home server might not be enough
+to allow you to use various API functions. Plan on upgrading the RAM on your
+home server if you want to use the Coding Contract API.
 
 Submitting Solutions
 ^^^^^^^^^^^^^^^^^^^^
@@ -84,142 +96,321 @@ The following is a list of all of the problem types that a Coding Contract can c
 The list contains the name of (i.e. the value returned by
 :js:func:`getContractType`) and a brief summary of the problem it poses.
 
-+------------------------------------+------------------------------------------------------------------------------------------+
-| Name                               | Problem Summary                                                                          |
-+====================================+==========================================================================================+
-| Find Largest Prime Factor          | | Given a number, find its largest prime factor. A prime factor                          |
-|                                    | | is a factor that is a prime number.                                                    |
-+------------------------------------+------------------------------------------------------------------------------------------+
-| Subarray with Maximum Sum          | | Given an array of integers, find the contiguous subarray (containing                   |
-|                                    | | at least one number) which has the largest sum and return that sum.                    |
-+------------------------------------+------------------------------------------------------------------------------------------+
-| Total Ways to Sum                  | | Given a number, how many different ways can that number be written as                  |
-|                                    | | a sum of at least two positive integers?                                               |
-+------------------------------------+------------------------------------------------------------------------------------------+
-| Spiralize Matrix                   | | Given an array of array of numbers representing a 2D matrix, return the                |
-|                                    | | elements of that matrix in clockwise spiral order.                                     |
-|                                    | |                                                                                        |
-|                                    | | Example: The spiral order of                                                           |
-|                                    | |                                                                                        |
-|                                    | |  [1, 2, 3, 4]                                                                          |
-|                                    | |  [5, 6, 7, 8]                                                                          |
-|                                    | |  [9, 10, 11, 12]                                                                       |
-|                                    | |                                                                                        |
-|                                    | | is [1, 2, 3, 4, 8, 12, 11, 10, 9, 5, 6, 7]                                             |
-+------------------------------------+------------------------------------------------------------------------------------------+
-| Array Jumping Game                 | | You are given an array of integers where each element represents the                   |
-|                                    | | maximum possible jump distance from that position. For example, if you                 |
-|                                    | | are at position i and your maximum jump length is n, then you can jump                 |
-|                                    | | to any position from i to i+n.                                                         |
-|                                    | |                                                                                        |
-|                                    | | Assuming you are initially positioned at the start of the array, determine             |
-|                                    | | whether you are able to reach the last index of the array.                     |
-+------------------------------------+------------------------------------------------------------------------------------------+
-| Merge Overlapping Intervals        | | Given an array of intervals, merge all overlapping intervals. An interval              |
-|                                    | | is an array with two numbers, where the first number is always less than               |
-|                                    | | the second (e.g. [1, 5]).                                                              |
-|                                    | |                                                                                        |
-|                                    | | The intervals must be returned in ASCENDING order.                                     |
-|                                    | |                                                                                        |
-|                                    | | Example:                                                                               |
-|                                    | |  [[1, 3], [8, 10], [2, 6], [10, 16]]                                                   |
-|                                    | | merges into [[1, 6], [8, 16]]                                                          |
-+------------------------------------+------------------------------------------------------------------------------------------+
-| Generate IP Addresses              | | Given a string containing only digits, return an array with all possible               |
-|                                    | | valid IP address combinations that can be created from the string.                     |
-|                                    | |                                                                                        |
-|                                    | | An octet in the IP address cannot begin with '0' unless the number itself              |
-|                                    | | is actually 0. For example, "192.168.010.1" is NOT a valid IP.                         |
-|                                    | |                                                                                        |
-|                                    | | Examples:                                                                              |
-|                                    | |  25525511135 -> [255.255.11.135, 255.255.111.35]                                       |
-|                                    | |  1938718066 -> [193.87.180.66]                                                         |
-+------------------------------------+------------------------------------------------------------------------------------------+
-| Algorithmic Stock Trader I         | | You are given an array of numbers representing stock prices, where the                 |
-|                                    | | i-th element represents the stock price on day i.                                      |
-|                                    | |                                                                                        |
-|                                    | | Determine the maximum possible profit you can earn using at most one                   |
-|                                    | | transaction (i.e. you can buy an sell the stock once).  If no profit                   |
-|                                    | | can be made, then the answer should be 0. Note that you must buy the stock             |
-|                                    | | before you can sell it.                                                                |
-+------------------------------------+------------------------------------------------------------------------------------------+
-| Algorithmic Stock Trader II        | | You are given an array of numbers representing stock prices, where the                 |
-|                                    | | i-th element represents the stock price on day i.                                      |
-|                                    | |                                                                                        |
-|                                    | | Determine the maximum possible profit you can earn using as many transactions          |
-|                                    | | as you'd like. A transaction is defined as buying and then selling one                 |
-|                                    | | share of the stock. Note that you cannot engage in multiple transactions at            |
-|                                    | | once. In other words, you must sell the stock before you buy it again. If no           |
-|                                    | | profit can be made, then the answer should be 0.                                       |
-+------------------------------------+------------------------------------------------------------------------------------------+
-| Algorithmic Stock Trader III       | | You are given an array of numbers representing stock prices, where the                 |
-|                                    | | i-th element represents the stock price on day i.                                      |
-|                                    | |                                                                                        |
-|                                    | | Determine the maximum possible profit you can earn using at most two                   |
-|                                    | | transactions. A transaction is defined as buying and then selling one share            |
-|                                    | | of the stock. Note that you cannot engage in multiple transactions at once.            |
-|                                    | | In other words, you must sell the stock before you buy it again. If no profit          |
-|                                    | | can be made, then the answer should be 0.                                              |
-+------------------------------------+------------------------------------------------------------------------------------------+
-| Algorithmic Stock Trader IV        | | You are given an array with two elements. The first element is an integer k.           |
-|                                    | | The second element is an array of numbers representing stock prices, where the         |
-|                                    | | i-th element represents the stock price on day i.                                      |
-|                                    | |                                                                                        |
-|                                    | | Determine the maximum possible profit you can earn using at most k transactions.       |
-|                                    | | A transaction is defined as buying and then selling one share of the stock.            |
-|                                    | | Note that you cannot engage in multiple transactions at once. In other words,          |
-|                                    | | you must sell the stock before you can buy it. If no profit can be made, then          |
-|                                    | | the answer should be 0.                                                                |
-+------------------------------------+------------------------------------------------------------------------------------------+
-| Minimum Path Sum in a Triangle     | | You are given a 2D array of numbers (array of array of numbers) that represents a      |
-|                                    | | triangle (the first array has one element, and each array has one more element than    |
-|                                    | | the one before it, forming a triangle). Find the minimum path sum from the top to the  |
-|                                    | | bottom of the triangle. In each step of the path, you may only move to adjacent        |
-|                                    | | numbers in the row below.                                                              |
-+------------------------------------+------------------------------------------------------------------------------------------+
-| Unique Paths in a Grid I           | | You are given an array with two numbers: [m, n]. These numbers represent a             |
-|                                    | | m x n grid. Assume you are initially positioned in the top-left corner of that         |
-|                                    | | grid and that you are trying to reach the bottom-right corner. On each step,           |
-|                                    | | you may only move down or to the right.                                                |
-|                                    | |                                                                                        |
-|                                    |                                                                                          |
-|                                    | | Determine how many unique paths there are from start to finish.                        |
-+------------------------------------+------------------------------------------------------------------------------------------+
-| Unique Paths in a Grid II          | | You are given a 2D array of numbers (array of array of numbers) representing           |
-|                                    | | a grid. The 2D array contains 1's and 0's, where 1 represents an obstacle and          |
-|                                    |                                                                                          |
-|                                    | | 0 represents a free space.                                                             |
-|                                    | |                                                                                        |
-|                                    | | Assume you are initially positioned in top-left corner of that grid and that you       |
-|                                    | | are trying to reach the bottom-right corner. In each step, you may only move down      |
-|                                    | | or to the right. Furthermore, you cannot move onto spaces which have obstacles.        |
-|                                    | |                                                                                        |
-|                                    | | Determine how many unique paths there are from start to finish.                        |
-+------------------------------------+------------------------------------------------------------------------------------------+
-| Sanitize Parentheses in Expression | | Given a string with parentheses and letters, remove the minimum number of invalid      |
-|                                    | | parentheses in order to validate the string. If there are multiple minimal ways        |
-|                                    | | to validate the string, provide all of the possible results.                           |
-|                                    | |                                                                                        |
-|                                    | | The answer should be provided as an array of strings. If it is impossible to validate  |
-|                                    | | the string, the result should be an array with only an empty string.                   |
-|                                    | |                                                                                        |
-|                                    | | Examples:                                                                              |
-|                                    | |  ()())() -> [()()(), (())()]                                                           |
-|                                    | |  (a)())() -> [(a)()(), (a())()]                                                        |
-|                                    | |  )( -> [""]                                                                            |
-+------------------------------------+------------------------------------------------------------------------------------------+
-| Find All Valid Math Expressions    | | You are given a string which contains only digits between 0 and 9 as well as a target  |
-|                                    | | number. Return all possible ways you can add the +, -, and * operators to the string   |
-|                                    | | of digits such that it evaluates to the target number.                                 |
-|                                    | |                                                                                        |
-|                                    | | The answer should be provided as an array of strings containing the valid expressions. |
-|                                    | |                                                                                        |
-|                                    | | NOTE: Numbers in an expression cannot have leading 0's                                 |
-|                                    | |                                                                                        |
-|                                    | | Examples:                                                                              |
-|                                    | |  Input: digits = "123", target = 6                                                     |
-|                                    | |  Output: [1+2+3, 1*2*3]                                                                |
-|                                    | |                                                                                        |
-|                                    | |  Input: digits = "105", target = 5                                                     |
-|                                    | |  Output: [1*0+5, 10-5]                                                                 |
-+------------------------------------+------------------------------------------------------------------------------------------+
++-----------------------------------------+------------------------------------------------------------------------------------------+
+| Name                                    | Problem Summary                                                                          |
++=========================================+==========================================================================================+
+| Find Largest Prime Factor               | | Given a number, find its largest prime factor. A prime factor                          |
+|                                         | | is a factor that is a prime number.                                                    |
++-----------------------------------------+------------------------------------------------------------------------------------------+
+| Subarray with Maximum Sum               | | Given an array of integers, find the contiguous subarray (containing                   |
+|                                         | | at least one number) which has the largest sum and return that sum.                    |
++-----------------------------------------+------------------------------------------------------------------------------------------+
+| Total Ways to Sum                       | | Given a number, how many different distinct ways can that number be written as         |
+|                                         | | a sum of at least two positive integers?                                               |
++-----------------------------------------+------------------------------------------------------------------------------------------+
+| Total Ways to Sum II                    | | You are given an array with two elements. The first element is an integer n.           |
+|                                         | | The second element is an array of numbers representing the set of available integers.  |
+|                                         | | How many different distinct ways can that number n be written as                       |
+|                                         | | a sum of integers contained in the given set?                                          |
+|                                         | | You may use each integer in the set zero or more times.                                |
++-----------------------------------------+------------------------------------------------------------------------------------------+
+| Spiralize Matrix                        | | Given an array of array of numbers representing a 2D matrix, return the                |
+|                                         | | elements of that matrix in clockwise spiral order.                                     |
+|                                         | |                                                                                        |
+|                                         | | Example: The spiral order of                                                           |
+|                                         | |                                                                                        |
+|                                         | |  [1, 2, 3, 4]                                                                          |
+|                                         | |  [5, 6, 7, 8]                                                                          |
+|                                         | |  [9, 10, 11, 12]                                                                       |
+|                                         | |                                                                                        |
+|                                         | | is [1, 2, 3, 4, 8, 12, 11, 10, 9, 5, 6, 7]                                             |
++-----------------------------------------+------------------------------------------------------------------------------------------+
+| Array Jumping Game                      | | You are given an array of integers where each element represents the                   |
+|                                         | | maximum possible jump distance from that position. For example, if you                 |
+|                                         | | are at position i and your maximum jump length is n, then you can jump                 |
+|                                         | | to any position from i to i+n.                                                         |
+|                                         | |                                                                                        |
+|                                         | | Assuming you are initially positioned at the start of the array, determine             |
+|                                         | | whether you are able to reach the last index of the array.                             |
++-----------------------------------------+------------------------------------------------------------------------------------------+
+| Array Jumping Game II                   | | You are given an array of integers where each element represents the                   |
+|                                         | | maximum possible jump distance from that position. For example, if you                 |
+|                                         | | are at position i and your maximum jump length is n, then you can jump                 |
+|                                         | | to any position from i to i+n.                                                         |
+|                                         | |                                                                                        |
+|                                         | | Assuming you are initially positioned at the start of the array, determine             |
+|                                         | | the minimum number of jumps to reach the end of the array.                             |
+|                                         | |                                                                                        |
+|                                         | | If it's impossible to reach the end, then the answer should be 0.                      |
++-----------------------------------------+------------------------------------------------------------------------------------------+
+| Merge Overlapping Intervals             | | Given an array of intervals, merge all overlapping intervals. An interval              |
+|                                         | | is an array with two numbers, where the first number is always less than               |
+|                                         | | the second (e.g. [1, 5]).                                                              |
+|                                         | |                                                                                        |
+|                                         | | The intervals must be returned in ASCENDING order.                                     |
+|                                         | |                                                                                        |
+|                                         | | Example:                                                                               |
+|                                         | |  [[1, 3], [8, 10], [2, 6], [10, 16]]                                                   |
+|                                         | | merges into [[1, 6], [8, 16]]                                                          |
++-----------------------------------------+------------------------------------------------------------------------------------------+
+| Generate IP Addresses                   | | Given a string containing only digits, return an array with all possible               |
+|                                         | | valid IP address combinations that can be created from the string.                     |
+|                                         | |                                                                                        |
+|                                         | | An octet in the IP address cannot begin with '0' unless the number itself              |
+|                                         | | is actually 0. For example, "192.168.010.1" is NOT a valid IP.                         |
+|                                         | |                                                                                        |
+|                                         | | Examples:                                                                              |
+|                                         | |  25525511135 -> [255.255.11.135, 255.255.111.35]                                       |
+|                                         | |  1938718066 -> [193.87.180.66]                                                         |
++-----------------------------------------+------------------------------------------------------------------------------------------+
+| Algorithmic Stock Trader I              | | You are given an array of numbers representing stock prices, where the                 |
+|                                         | | i-th element represents the stock price on day i.                                      |
+|                                         | |                                                                                        |
+|                                         | | Determine the maximum possible profit you can earn using at most one                   |
+|                                         | | transaction (i.e. you can buy an sell the stock once).  If no profit                   |
+|                                         | | can be made, then the answer should be 0. Note that you must buy the stock             |
+|                                         | | before you can sell it.                                                                |
++-----------------------------------------+------------------------------------------------------------------------------------------+
+| Algorithmic Stock Trader II             | | You are given an array of numbers representing stock prices, where the                 |
+|                                         | | i-th element represents the stock price on day i.                                      |
+|                                         | |                                                                                        |
+|                                         | | Determine the maximum possible profit you can earn using as many transactions          |
+|                                         | | as you'd like. A transaction is defined as buying and then selling one                 |
+|                                         | | share of the stock. Note that you cannot engage in multiple transactions at            |
+|                                         | | once. In other words, you must sell the stock before you buy it again. If no           |
+|                                         | | profit can be made, then the answer should be 0.                                       |
++-----------------------------------------+------------------------------------------------------------------------------------------+
+| Algorithmic Stock Trader III            | | You are given an array of numbers representing stock prices, where the                 |
+|                                         | | i-th element represents the stock price on day i.                                      |
+|                                         | |                                                                                        |
+|                                         | | Determine the maximum possible profit you can earn using at most two                   |
+|                                         | | transactions. A transaction is defined as buying and then selling one share            |
+|                                         | | of the stock. Note that you cannot engage in multiple transactions at once.            |
+|                                         | | In other words, you must sell the stock before you buy it again. If no profit          |
+|                                         | | can be made, then the answer should be 0.                                              |
++-----------------------------------------+------------------------------------------------------------------------------------------+
+| Algorithmic Stock Trader IV             | | You are given an array with two elements. The first element is an integer k.           |
+|                                         | | The second element is an array of numbers representing stock prices, where the         |
+|                                         | | i-th element represents the stock price on day i.                                      |
+|                                         | |                                                                                        |
+|                                         | | Determine the maximum possible profit you can earn using at most k transactions.       |
+|                                         | | A transaction is defined as buying and then selling one share of the stock.            |
+|                                         | | Note that you cannot engage in multiple transactions at once. In other words,          |
+|                                         | | you must sell the stock before you can buy it. If no profit can be made, then          |
+|                                         | | the answer should be 0.                                                                |
++-----------------------------------------+------------------------------------------------------------------------------------------+
+| Minimum Path Sum in a Triangle          | | You are given a 2D array of numbers (array of array of numbers) that represents a      |
+|                                         | | triangle (the first array has one element, and each array has one more element than    |
+|                                         | | the one before it, forming a triangle). Find the minimum path sum from the top to the  |
+|                                         | | bottom of the triangle. In each step of the path, you may only move to adjacent        |
+|                                         | | numbers in the row below.                                                              |
++-----------------------------------------+------------------------------------------------------------------------------------------+
+| Unique Paths in a Grid I                | | You are given an array with two numbers: [m, n]. These numbers represent a             |
+|                                         | | m x n grid. Assume you are initially positioned in the top-left corner of that         |
+|                                         | | grid and that you are trying to reach the bottom-right corner. On each step,           |
+|                                         | | you may only move down or to the right.                                                |
+|                                         | |                                                                                        |
+|                                         | |                                                                                        |
+|                                         | | Determine how many unique paths there are from start to finish.                        |
++-----------------------------------------+------------------------------------------------------------------------------------------+
+| Unique Paths in a Grid II               | | You are given a 2D array of numbers (array of array of numbers) representing           |
+|                                         | | a grid. The 2D array contains 1's and 0's, where 1 represents an obstacle and          |
+|                                         | |                                                                                        |
+|                                         | | 0 represents a free space.                                                             |
+|                                         | |                                                                                        |
+|                                         | | Assume you are initially positioned in top-left corner of that grid and that you       |
+|                                         | | are trying to reach the bottom-right corner. In each step, you may only move down      |
+|                                         | | or to the right. Furthermore, you cannot move onto spaces which have obstacles.        |
+|                                         | |                                                                                        |
+|                                         | | Determine how many unique paths there are from start to finish.                        |
++-----------------------------------------+------------------------------------------------------------------------------------------+
+| Shortest Path in a Grid                 | | You are given a 2D array of numbers (array of array of numbers) representing           |
+|                                         | | a grid. The 2D array contains 1's and 0's, where 1 represents an obstacle and          |
+|                                         | | 0 represents a free space.                                                             |
+|                                         | |                                                                                        |
+|                                         | | Assume you are initially positioned in top-left corner of that grid and that you       |
+|                                         | | are trying to reach the bottom-right corner. In each step, you may move to the up,     |
+|                                         | | down, left or right. Furthermore, you cannot move onto spaces which have obstacles.    |
+|                                         | |                                                                                        |
+|                                         | | Determine if paths exist from start to destination, and find the shortest one.         |
+|                                         | |                                                                                        |
+|                                         | | Examples:                                                                              |
+|                                         | |  [[0,1,0,0,0],                                                                         |
+|                                         | |   [0,0,0,1,0]] -> "DRRURRD"                                                            |
+|                                         | |  [[0,1],                                                                               |
+|                                         | |   [1,0]]       -> ""                                                                   |
+|                                         | |                                                                                        |
++-----------------------------------------+------------------------------------------------------------------------------------------+
+| Sanitize Parentheses in Expression      | | Given a string with parentheses and letters, remove the minimum number of invalid      |
+|                                         | | parentheses in order to validate the string. If there are multiple minimal ways        |
+|                                         | | to validate the string, provide all of the possible results.                           |
+|                                         | |                                                                                        |
+|                                         | | The answer should be provided as an array of strings. If it is impossible to validate  |
+|                                         | | the string, the result should be an array with only an empty string.                   |
+|                                         | |                                                                                        |
+|                                         | | Examples:                                                                              |
+|                                         | |  ()())() -> [()()(), (())()]                                                           |
+|                                         | |  (a)())() -> [(a)()(), (a())()]                                                        |
+|                                         | |  )( -> [""]                                                                            |
++-----------------------------------------+------------------------------------------------------------------------------------------+
+| Find All Valid Math Expressions         | | You are given a string which contains only digits between 0 and 9 as well as a target  |
+|                                         | | number. Return all possible ways you can add the +, -, and * operators to the string   |
+|                                         | | of digits such that it evaluates to the target number.                                 |
+|                                         | |                                                                                        |
+|                                         | | The answer should be provided as an array of strings containing the valid expressions. |
+|                                         | |                                                                                        |
+|                                         | | NOTE: Numbers in an expression cannot have leading 0's                                 |
+|                                         | | NOTE: The order of evaluation expects script operator precedence                       |
+|                                         | |                                                                                        |
+|                                         | | Examples:                                                                              |
+|                                         | |  Input: digits = "123", target = 6                                                     |
+|                                         | |  Output: [1+2+3, 1*2*3]                                                                |
+|                                         | |                                                                                        |
+|                                         | |  Input: digits = "105", target = 5                                                     |
+|                                         | |  Output: [1*0+5, 10-5]                                                                 |
++-----------------------------------------+------------------------------------------------------------------------------------------+
+| HammingCodes: Integer to Encoded Binary | | You are given a decimal value.                                                         |
+|                                         | | Convert it into a binary string and encode it as a 'Hamming-Code'. eg:                 |
+|                                         | | Value 8 will result into binary '1000', which will be encoded                          |
+|                                         | | with the pattern 'pppdpddd', where p is a paritybit and d a databit,                   |
+|                                         | | or '10101' (Value 21) will result into (pppdpdddpd) '1001101011'.                      |
+|                                         | | NOTE: You need an parity Bit on Index 0 as an 'overall'-paritybit.                     |
+|                                         | | NOTE 2: You should watch the HammingCode-video from 3Blue1Brown, which                 |
+|                                         | | explains the 'rule' of encoding,                                                       |
+|                                         | | including the first Index parity-bit mentioned on the first note.                      |
+|                                         | | Now the only one rule for this encoding:                                               |
+|                                         | |  It's not allowed to add additional leading '0's to the binary value                   |
+|                                         | | That means, the binary value has to be encoded as it is                                |
++-----------------------------------------+------------------------------------------------------------------------------------------+
+| HammingCodes: Encoded Binary to Integer | | You are given an encoded binary string.                                                |
+|                                         | | Treat it as a Hammingcode with 1 'possible' error on an random Index.                  |
+|                                         | | Find the 'possible' wrong bit, fix it and extract the decimal value, which is          |
+|                                         | | hidden inside the string.\n\n",                                                        |
+|                                         | | Note: The length of the binary string is dynamic, but it's encoding/decoding is        |
+|                                         | | following Hammings 'rule'\n",                                                          |
+|                                         | | Note 2: Index 0 is an 'overall' parity bit. Watch the Hammingcode-video from           |
+|                                         | | 3Blue1Brown for more information\n",                                                   |
+|                                         | | Note 3: There's a ~55% chance for an altered Bit. So... MAYBE                          |
+|                                         | | there is an altered Bit 😉\n",                                                         |
+|                                         | | Extranote for automation: return the decimal value as a string",                       |
++-----------------------------------------+------------------------------------------------------------------------------------------+
+| Proper 2-Coloring of a Graph            | | You are given data, representing a graph. Note that "graph", as used here, refers to   |
+|                                         | | the field of graph theory, and has no relation to statistics or plotting.              |
+|                                         | |                                                                                        |
+|                                         | | The first element of the data represents the number of vertices in the graph. Each     |
+|                                         | | vertex is a unique number between 0 and ${data[0] - 1}. The next element of the data   |
+|                                         | | represents the edges of the graph.                                                     |
+|                                         | |                                                                                        |
+|                                         | | Two vertices u,v in a graph are said to be adjacent if there exists an edge [u,v].     |
+|                                         | | Note that an edge [u,v] is the same as an edge [v,u], as order does not matter.        |
+|                                         | |                                                                                        |
+|                                         | | You must construct a 2-coloring of the graph, meaning that you have to assign each     |
+|                                         | | vertex in the graph a "color", either 0 or 1, such that no two adjacent vertices have  |
+|                                         | | the same color. Submit your answer in the form of an array, where element i            |
+|                                         | | represents the color of vertex i. If it is impossible to construct a 2-coloring of     |
+|                                         | | the given graph, instead submit an empty array.                                        |
+|                                         | |                                                                                        |
+|                                         | | Examples:                                                                              |
+|                                         | |                                                                                        |
+|                                         | | Input: [4, [[0, 2], [0, 3], [1, 2], [1, 3]]]                                           |
+|                                         | | Output: [0, 0, 1, 1]                                                                   |
+|                                         | |                                                                                        |
+|                                         | | Input: [3, [[0, 1], [0, 2], [1, 2]]]                                                   |
+|                                         | | Output: []                                                                             |
++-----------------------------------------+------------------------------------------------------------------------------------------+
+| Compression I: RLE Compression          | | Run-length encoding (RLE) is a data compression technique which encodes data as a      |
+|                                         | | series of runs of a repeated single character. Runs are encoded as a length, followed  |
+|                                         | | by the character itself. Lengths are encoded as a single ASCII digit; runs of 10       |
+|                                         | | characters or more are encoded by splitting them into multiple runs.                   |
+|                                         | |                                                                                        |
+|                                         | | You are given a string as input. Encode it using run-length encoding with the minimum  |
+|                                         | | possible output length.                                                                |
+|                                         | |                                                                                        |
+|                                         | | Examples:                                                                              |
+|                                         | |  aaaaabccc            ->  5a1b3c                                                       |
+|                                         | |  aAaAaA               ->  1a1A1a1A1a1A                                                 |
+|                                         | |  111112333            ->  511233                                                       |
+|                                         | |  zzzzzzzzzzzzzzzzzzz  ->  9z9z1z  (or 9z8z2z, etc.)                                    |
++-----------------------------------------+------------------------------------------------------------------------------------------+
+| Compression II: LZ Decompression        | | Lempel-Ziv (LZ) compression is a data compression technique which encodes data using   |
+|                                         | | references to earlier parts of the data. In this variant of LZ, data is encoded in two |
+|                                         | | types of chunk. Each chunk begins with a length L, encoded as a single ASCII digit     |
+|                                         | | from 1 - 9, followed by the chunk data, which is either:                               |
+|                                         | |                                                                                        |
+|                                         | |  1. Exactly L characters, which are to be copied directly into the uncompressed data.  |
+|                                         | |  2. A reference to an earlier part of the uncompressed data. To do this, the length    |
+|                                         | |     is followed by a second ASCII digit X: each of the L output characters is a copy   |
+|                                         | |     of the character X places before it in the uncompressed data.                      |
+|                                         | |                                                                                        |
+|                                         | | For both chunk types, a length of 0 instead means the chunk ends immediately, and the  |
+|                                         | | next character is the start of a new chunk. The two chunk types alternate, starting    |
+|                                         | | with type 1, and the final chunk may be of either type.                                |
+|                                         | |                                                                                        |
+|                                         | | You are given an LZ-encoded string. Decode it and output the original string.          |
+|                                         | |                                                                                        |
+|                                         | | Example: decoding '5aaabb450723abb' chunk-by-chunk                                     |
+|                                         | |  5aaabb           ->  aaabb                                                            |
+|                                         | |  5aaabb45         ->  aaabbaaab                                                        |
+|                                         | |  5aaabb450        ->  aaabbaaab                                                        |
+|                                         | |  5aaabb45072      ->  aaabbaaababababa                                                 |
+|                                         | |  5aaabb450723abb  ->  aaabbaaababababaabb                                              |
++-----------------------------------------+------------------------------------------------------------------------------------------+
+| Compression III: LZ Compression         | | Lempel-Ziv (LZ) compression is a data compression technique which encodes data using   |
+|                                         | | references to earlier parts of the data. In this variant of LZ, data is encoded in two |
+|                                         | | types of chunk. Each chunk begins with a length L, encoded as a single ASCII digit     |
+|                                         | | from 1 - 9, followed by the chunk data, which is either:                               |
+|                                         | |                                                                                        |
+|                                         | |  1. Exactly L characters, which are to be copied directly into the uncompressed data.  |
+|                                         | |  2. A reference to an earlier part of the uncompressed data. To do this, the length    |
+|                                         | |     is followed by a second ASCII digit X: each of the L output characters is a copy   |
+|                                         | |     of the character X places before it in the uncompressed data.                      |
+|                                         | |                                                                                        |
+|                                         | | For both chunk types, a length of 0 instead means the chunk ends immediately, and the  |
+|                                         | | next character is the start of a new chunk. The two chunk types alternate, starting    |
+|                                         | | with type 1, and the final chunk may be of either type.                                |
+|                                         | |                                                                                        |
+|                                         | | You are given a string as input. Encode it using Lempel-Ziv encoding with the minimum  |
+|                                         | | possible output length.                                                                |
+|                                         | |                                                                                        |
+|                                         | | Examples (some have other possible encodings of minimal length):                       |
+|                                         | |  abracadabra     ->  7abracad47                                                        |
+|                                         | |  mississippi     ->  4miss433ppi                                                       |
+|                                         | |  aAAaAAaAaAA     ->  3aAA53035                                                         |
+|                                         | |  2718281828      ->  627182844                                                         |
+|                                         | |  abcdefghijk     ->  9abcdefghi02jk                                                    |
+|                                         | |  aaaaaaaaaaaa    ->  3aaa91                                                            |
+|                                         | |  aaaaaaaaaaaaa   ->  1a91031                                                           |
+|                                         | |  aaaaaaaaaaaaaa  ->  1a91041                                                           |
++-----------------------------------------+------------------------------------------------------------------------------------------+
+| Encryption I: Caesar Cipher             | | Caesar cipher is one of the simplest encryption technique.  It is a type of            |
+|                                         | | substitution cipher in which each letter in the plaintext is replaced by a letter some |
+|                                         | | fixed number of positions down the alphabet. For example, with a left shift of 3, D    |
+|                                         | | would be replaced by A, E would become B, and A would become X (because of rotation).  |
+|                                         | | You are given an array with two elements. The first element is the plaintext, the      |
+|                                         | | second element is the left shift value. Return the ciphertext as uppercase string.     |
+|                                         | | Spaces remains the same.                                                               |
++-----------------------------------------+------------------------------------------------------------------------------------------+
+| Encryption II: Vigenère Cipher          | | Vigenère cipher is a type of polyalphabetic substitution. It uses the Vigenère square  |
+|                                         | | to encrypt and decrypt plaintext with a keyword.                                       |
+|                                         | |   Vignenère square:                                                                    |
+|                                         | |          A B C D E F G H I J K L M N O P Q R S T U V W X Y Z                           |
+|                                         | |        +----------------------------------------------------                           |
+|                                         | |      A | A B C D E F G H I J K L M N O P Q R S T U V W X Y Z                           |
+|                                         | |      B | B C D E F G H I J K L M N O P Q R S T U V W X Y Z A                           |
+|                                         | |      C | C D E F G H I J K L M N O P Q R S T U V W X Y Z A B                           |
+|                                         | |      D | D E F G H I J K L M N O P Q R S T U V W X Y Z A B C                           |
+|                                         | |      E | E F G H I J K L M N O P Q R S T U V W X Y Z A B C D                           |
+|                                         | |                   ...                                                                  |
+|                                         | |      Y | Y Z A B C D E F G H I J K L M N O P Q R S T U V W X                           |
+|                                         | |      Z | Z A B C D E F G H I J K L M N O P Q R S T U V W X Y                           |
+|                                         | | For encryption each letter of the plaintext is paired with the corresponding letter of |
+|                                         | | a repeating keyword. For example, the plaintext DASHBOARD is encrypted with the        |
+|                                         | | keyword LINUX:                                                                         |
+|                                         | |   Plaintext: DASHBOARD                                                                 |
+|                                         | |   Keyword:   LINUXLINU                                                                 |
+|                                         | | So, the first letter D is paired with the first letter of the key L. Therefore, row D  |
+|                                         | | and column L of the Vigenère square are used to get the first cipher letter O. This    |
+|                                         | | must be repeated for the whole ciphertext.                                             |
+|                                         | | You are given an array with two elements. The first element is the plaintext, the      |
+|                                         | | second element is the keyword. Return the ciphertext as uppercase string.              |
++-----------------------------------------+------------------------------------------------------------------------------------------+

doc/source/basicgameplay/companies.rst

@@ -7,6 +7,7 @@ these companies, you can apply for jobs.
 
 Working a job lets you earn money, experience, and reputation with that company.
 
-Information about all Companies
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
-TODO
+While working for a company, you can click "Do something else simultaneously" to be able 
+to do things while you continue to work in the background. There is a 20% penalty to the 
+related gains. Clicking the "Focus" button under the overview will return you to the 
+current work.   

doc/source/basicgameplay/crimes.rst

@@ -13,7 +13,12 @@ Basic Mechanics
 When you visit the 'Slums' you will see a list of buttons that show all of the
 available crimes. Simply select one of the options to begin attempting that
 crime. Attempting to commit a crime takes a certain amount of time. This time
-varies between crimes. During this time, you cannot do anything else.
+varies between crimes. 
+
+While doing criemes, you can click “Do something else simultaneously” 
+to be able to do things while you continue to do crimes in the background. There is a 
+20% penalty to the related gains. Clicking the “Focus” button under the overview 
+will return you to the current task.
 
 Crimes are not always successful. Your rate of success is determined by your
 stats (and Augmentation multipliers) and can be seen on the crime-selection
@@ -26,4 +31,28 @@ Harder crimes are typically more profitable, and also give more EXP.
 
 Crime details
 ^^^^^^^^^^^^^
-TODO
+Available crimes, and their descriptions, which all begin with "attempt to..."
+
+Shoplift	…shoplift from a low-end retailer
+
+Rob store 	…commit armed robbery on a high-end store
+
+Mug someone 	…mug a random person on the street
+
+Larceny 	…rob property from someone's house
+
+Deal Drugs 	…deal drugs
+
+Bond Forgery 	…forge corporate bonds
+
+Traffick illegal Arms 	…smuggle illegal arms into the city
+
+Homicide 	…murder a random person on the street
+
+Grand theft Auto 	…commit grand theft auto
+
+Kidnap and Ransom 	…kidnap and ransom a high-profile-target
+
+Assassinate 	…assassinate a high-profile target
+
+Heist 	…pull off the ultimate heist

doc/source/basicgameplay/factions.rst

@@ -2,6 +2,9 @@
 
 Factions
 ========
+
+.. warning:: This page contains spoilers regarding the game's story/plot-line.
+
 Throughout the game you may receive invitations from factions. There are
 many different factions, and each faction has different criteria for
 determining its potential members. Joining a faction and furthering
@@ -30,23 +33,41 @@ from faction to faction.
 
 List of Factions and their Requirements
 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+.. raw:: html
+
+	<details><summary><a>Early Game Factions</a></summary>
+
+.. _gameplay_factions:: 
+
++---------------------+--------------------+-----------------------------------------+-------------------------------+
+| Early Game          | Faction Name       | Requirements                            | Joining this Faction prevents |
+|  Factions           |                    |                                         | you from joining:             |
++                     +--------------------+-----------------------------------------+-------------------------------+
+|                     | CyberSec           | * Install a backdoor on the CSEC server |                               |
++                     +--------------------+-----------------------------------------+-------------------------------+
+|                     | Tian Di Hui        | * $1m                                   |                               |
+|                     |                    | * Hacking Level 50                      |                               |
+|                     |                    | * Be in Chongqing, New Tokyo, or Ishima |                               |
++                     +--------------------+-----------------------------------------+-------------------------------+
+|                     | Netburners         | * Hacking Level 80                      |                               |
+|                     |                    | * Total Hacknet Levels of 100           |                               |
+|                     |                    | * Total Hacknet RAM of 8                |                               |
+|                     |                    | * Total Hacknet Cores of 4              |                               |
++                     +--------------------+-----------------------------------------+-------------------------------+
+|                     | Shadows of Anarchy | * Successfully infiltrate a company     |                               |
++---------------------+--------------------+-----------------------------------------+-------------------------------+
+.. raw:: html
+
+	</details>
+	<details><summary><a>City Factions</a></summary>
+
+.. _gameplay_factions:: 
 
 +---------------------+----------------+-----------------------------------------+-------------------------------+
-| Early Game          | Faction Name   | Requirements                            | Joining this Faction prevents |
-|  Factions           |                |                                         | you from joining:             |
+| City Factions       | Faction Name   | Requirements                            | Joining this Faction prevents |
+|                     |                |                                         | you from joining:             |
 +                     +----------------+-----------------------------------------+-------------------------------+
-|                     | CyberSec       | * Install a backdoor on the CSEC server |                               |
-+                     +----------------+-----------------------------------------+-------------------------------+
-|                     | Tian Di Hui    | * $1m                                   |                               |
-|                     |                | * Hacking Level 50                      |                               |
-|                     |                | * Be in Chongqing, New Tokyo, or Ishima |                               |
-+                     +----------------+-----------------------------------------+-------------------------------+
-|                     | Netburners     | * Hacking Level 80                      |                               |
-|                     |                | * Total Hacknet Levels of 100           |                               |
-|                     |                | * Total Hacknet RAM of 8                |                               |
-|                     |                | * Total Hacknet Cores of 4              |                               |
-+---------------------+----------------+-----------------------------------------+-------------------------------+
-| City Factions       | Sector-12      | * Be in Sector-12                       | * Chongqing                   |
+|                     | Sector-12      | * Be in Sector-12                       | * Chongqing                   |
 |                     |                | * $15m                                  | * New Tokyo                   |
 |                     |                |                                         | * Ishima                      |
 |                     |                |                                         | * Volhaven                    |
@@ -74,8 +95,19 @@ List of Factions and their Requirements
 |                     |                |                                         | * New Tokyo                   |
 |                     |                |                                         | * Ishima                      |
 +---------------------+----------------+-----------------------------------------+-------------------------------+
-| Hacking             | NiteSec        | * Install a backdoor on the avmnite-02h |                               |
-| Groups              |                |   server                                |                               |
+.. raw:: html
+
+	</details>
+	<details><summary><a>Hacking Groups</a></summary>
+
+.. _gameplay_factions:: 
+
++---------------------+----------------+-----------------------------------------+-------------------------------+
+| Hacking             | Faction Name   | Requirements                            | Joining this Faction prevents |
+| Groups              |                |                                         | you from joining:             |
++                     +----------------+-----------------------------------------+-------------------------------+
+|                     | NiteSec        | * Install a backdoor on the avmnite-02h |                               |
+|                     |                |   server                                |                               |
 |                     |                |                                         |                               |
 +                     +----------------+-----------------------------------------+-------------------------------+
 |                     | The Black Hand | * Install a backdoor on the I.I.I.I     |                               |
@@ -86,40 +118,62 @@ List of Factions and their Requirements
 |                     |                |   server                                |                               |
 |                     |                |                                         |                               |
 +---------------------+----------------+-----------------------------------------+-------------------------------+
-| Megacorporations    | ECorp          | * Have 200k reputation with             |                               |
+.. raw:: html
+
+	</details>
+	<details><summary><a>Megacorporations</a></summary>
+
+.. _gameplay_factions:: 
+
++---------------------+----------------+-----------------------------------------+-------------------------------+
+| Megacorporations    | Faction Name   | Requirements                            | Joining this Faction prevents |
+|                     |                |                                         | you from joining:             |
++                     +----------------+-----------------------------------------+-------------------------------+
+|                     | ECorp          | * Have 400k reputation with             |                               |
 |                     |                |   the Corporation                       |                               |
 +                     +----------------+-----------------------------------------+-------------------------------+
-|                     | MegaCorp       | * Have 200k reputation with             |                               |
+|                     | MegaCorp       | * Have 400k reputation with             |                               |
 |                     |                |   the Corporation                       |                               |
 +                     +----------------+-----------------------------------------+-------------------------------+
-|                     | KuaiGong       | * Have 200k reputation with             |                               |
+|                     | KuaiGong       | * Have 400k reputation with             |                               |
 |                     | International  |   the Corporation                       |                               |
 +                     +----------------+-----------------------------------------+-------------------------------+
-|                     | Four Sigma     | * Have 200k reputation with             |                               |
+|                     | Four Sigma     | * Have 400k reputation with             |                               |
 |                     |                |   the Corporation                       |                               |
 +                     +----------------+-----------------------------------------+-------------------------------+
-|                     | NWO            | * Have 200k reputation with             |                               |
+|                     | NWO            | * Have 400k reputation with             |                               |
 |                     |                |   the Corporation                       |                               |
 +                     +----------------+-----------------------------------------+-------------------------------+
-|                     | Blade          | * Have 200k reputation with             |                               |
+|                     | Blade          | * Have 400k reputation with             |                               |
 |                     | Industries     |   the Corporation                       |                               |
 +                     +----------------+-----------------------------------------+-------------------------------+
-|                     | OmniTek        | * Have 200k reputation with             |                               |
+|                     | OmniTek        | * Have 400k reputation with             |                               |
 |                     | Incorporated   |   the Corporation                       |                               |
 +                     +----------------+-----------------------------------------+-------------------------------+
-|                     | Bachman &      | * Have 200k reputation with             |                               |
+|                     | Bachman &      | * Have 400k reputation with             |                               |
 |                     | Associates     |   the Corporation                       |                               |
 +                     +----------------+-----------------------------------------+-------------------------------+
-|                     | Clarke         | * Have 200k reputation with             |                               |
+|                     | Clarke         | * Have 400k reputation with             |                               |
 |                     | Incorporated   |   the Corporation                       |                               |
 +                     +----------------+-----------------------------------------+-------------------------------+
-|                     | Fulcrum Secret | * Have 250k reputation with             |                               |
+|                     | Fulcrum Secret | * Have 400k reputation with             |                               |
 |                     | Technologies   |   the Corporation                       |                               |
 |                     |                | * Install a backdoor on the             |                               |
 |                     |                |   fulcrumassets server                  |                               |
 +---------------------+----------------+-----------------------------------------+-------------------------------+
-| Criminal            | Slum Snakes    | * All Combat Stats of 30                |                               |
-| Organizations       |                | * -9 Karma                              |                               |
+.. raw:: html
+
+	</details>
+	<details><summary><a>Criminal Organizations</a></summary>
+
+.. _gameplay_factions:: 
+
++---------------------+----------------+-----------------------------------------+-------------------------------+
+| Criminal            | Faction Name   | Requirements                            | Joining this Faction prevents |
+| Organizations       |                |                                         | you from joining:             |
++                     +----------------+-----------------------------------------+-------------------------------+
+|                     | Slum Snakes    | * All Combat Stats of 30                |                               |
+|                     |                | * -9 Karma                              |                               |
 |                     |                | * $1m                                   |                               |
 +                     +----------------+-----------------------------------------+-------------------------------+
 |                     | Tetrads        | * Be in Chongqing, New Tokyo, or Ishima |                               |
@@ -150,8 +204,19 @@ List of Factions and their Requirements
 |                     |                | * -90 Karma                             |                               |
 |                     |                | * Not working for CIA or NSA            |                               |
 +---------------------+----------------+-----------------------------------------+-------------------------------+
-| Endgame             | The Covenant   | * 20 Augmentations                      |                               |
-| Factions            |                | * $75b                                  |                               |
+.. raw:: html
+
+	</details>
+	<details><summary><a>Endgame Factions</a></summary>
+
+.. _gameplay_factions:: 
+
++---------------------+----------------+-----------------------------------------+-------------------------------+
+| Endgame             | Faction Name   | Requirements                            | Joining this Faction prevents |
+| Factions            |                |                                         | you from joining:             |
++                     +----------------+-----------------------------------------+-------------------------------+
+|                     | The Covenant   | * 20 Augmentations                      |                               |
+|                     |                | * $75b                                  |                               |
 |                     |                | * Hacking Level of 850                  |                               |
 |                     |                | * All Combat Stats of 850               |                               |
 +                     +----------------+-----------------------------------------+-------------------------------+
@@ -165,3 +230,6 @@ List of Factions and their Requirements
 |                     |                | * Hacking Level of 1500                 |                               |
 |                     |                | * All Combat Stats of 1200              |                               |
 +---------------------+----------------+-----------------------------------------+-------------------------------+
+.. raw:: html
+
+	</details><br>

doc/source/basicgameplay/hacking.rst

@@ -107,3 +107,14 @@ starting security, rounded to the nearest integer. To be more precise::
 
 This means that a server's security level will not fall below this
 value if you are trying to weaken() it.
+
+Backdoors
+^^^^^^^^^
+Servers that can be hacked can also have backdoors installed. These backdoors
+will provide you with a benefit; the services may be cheaper, penalties may
+be reduced or there may be other results. Honeypots exist and will let factions
+know when you have succeeded at backdooring their system. Once you have a 
+backdoor installed, you can connect to that server directly. 
+
+When you visit a location in the city and see that the name is partially scrambled,
+this indicates that you have backdoored the server related to the location. 

doc/source/basicgameplay/servers.rst

@@ -21,23 +21,19 @@ can be used to check how much RAM a server has.
 
 Identifying Servers
 ^^^^^^^^^^^^^^^^^^^
-A server is identified by two properties: its IP address and its hostname.
-An IP address is a 32-bit number represented in dot-decimal notation.
-For example, "56.1.5.0" and "86.5.1.0" might be two IP addresses
-you see in the game. A hostname is a label assigned to a server.
+A server is identified by its hostname.
+A hostname is a label assigned to a server.
 A hostname will usually give you a general idea of what the server
 is. For example, the company Nova Medical might have a server with
 the hostname "nova-med".
 
-Hostnames and IP addresses are unique. This means that if one
-server has the IP address "1.1.1.1" and the hostname
-"some-server", then no other server in the game can have that
-IP address or that hostname.
+Hostnames are unique. This means that if one
+server has the the hostname "some-server", then no other server
+in the game can have that that hostname.
 
 There are many :ref:`Netscript Functions <netscriptfunctions>`
 and :ref:`terminal` commands in the game
-that will require you to target a specific server. This is done using
-either the IP address or the hostname of the server.
+that will require you to target a specific server by hostname.
 
 Player-owned Servers
 ^^^^^^^^^^^^^^^^^^^^

doc/source/basicgameplay/terminal.rst

@@ -8,15 +8,6 @@ on the navigation menu on the left-hand side of the game (you may need to expand
 the 'Hacking' header in order to see the 'Terminal' tab). Alternatively, the :ref:`keyboard
 shortcut <shortcuts>` Alt + t can be used to open the Terminal.
 
-Configuration
--------------
-
-The terminal has a configuration file called .fconf. To edit this file, go to
-the terminal and enter::
-
-    nano .fconf
-
-
 .. _terminal_filesystem:
 
 Filesystem (Directories)
@@ -54,7 +45,7 @@ files.
 
 Absolute vs Relative Paths
 ^^^^^^^^^^^^^^^^^^^^^^^^^^
-Many Terminal commands accept absolute both absolute and relative paths for specifying a
+Many Terminal commands accept both absolute and relative paths for specifying a
 file.
 
 An absolute path specifies the location of the file from the root directory (/).
@@ -239,7 +230,7 @@ connect
 
     $ connect [hostname/ip]
 
-Connect to a remote server. The hostname or IP address of the remote server must
+Connect to a remote server. The hostname of the remote server must
 be given as the argument to this command. Note that only servers that are immediately
 adjacent to the current server in the network can be connected to. To see which
 servers can be connected to, use the 'scan' command.
@@ -335,7 +326,7 @@ Then to kill this script the same arguments would have to be used::
 
     $ kill foo.script 50e3 sigma-cosmetics
 
-If you are killing the script using its PID, then the PID argument must be numeric. 
+If you are killing the script using its PID, then the PID argument must be numeric.
 
 killall
 ^^^^^^^
@@ -347,7 +338,7 @@ Kills all scripts on the current server.
 ls
 ^^
 
-    $ ls [dir] [| grep pattern]
+    $ ls [dir] [--grep pattern]
 
 Prints files and directories on the current server to the Terminal screen.
 
@@ -358,19 +349,21 @@ followed by the files (also in alphabetical order).
 The :code:`dir` optional parameter allows you to specify the directory for which to display
 files.
 
-The :code:`| grep pattern` optional parameter allows you to only display files and directories
+The :code:`--grep pattern` optional parameter allows you to only display files and directories
 with a certain pattern in their names.
 
+The :code:`-l` optional parameter allows you to force each item onto a single line.
+
 Examples::
 
     // List files/directories with the '.script' extension in the current directory
-    $ ls | grep .script
+    $ ls -l --grep .script
 
     // List files/directories with the '.js' extension in the root directory
-    $ ls / | grep .js
+    $ ls / -l --grep .js
 
     // List files/directories with the word 'purchase' in the name, in the :code:`scripts` directory
-    $ ls scripts | grep purchase
+    $ ls scripts -l --grep purchase
 
 
 lscpu
@@ -542,28 +535,6 @@ Then in order to check its logs with 'tail' the same arguments must be used::
 
     $ tail foo.script 10 50000
 
-theme
-^^^^^
-
-    $ theme [preset] | [#background #text #highlight]
-
-Change the color of the game's user interface
-
-This command can be called with a preset theme. Currently, the supported presets are:
-
-* default
-* muted
-* solarized
-
-However, you can also specify your own color scheme using hex values.
-To do so, you must specify three hex color values for the background
-color, the text color, and the highlight color. These hex values must
-be preceded by a pound sign (#) and must be either 3 or 6 digits. Example::
-
-    $ theme #ffffff #385 #235012
-
-A color picker such as Google's can be used to get your desired hex color values
-
 top
 ^^^
 

doc/source/changelog.rst

@@ -3,6 +3,531 @@
 Changelog
 =========
 
+v2.1.0 - 2022-09-23 Remote File API
+-----------------------------------
+
+Dev note
+
+* The most important change about this update is the introduction of the Remote File API (RFA).
+  With this we also deprecate the HTTP file API and the Visual Studio extension. Those things
+  were made during the rush of Steam and aren't well thought out. This new process works with
+  both the web and Steam version of the game and every text editor. Moving forward we also
+  won't be doing much, if any, upgrades to the in-game editor. We think it's good enough for
+  now and if you need more we recommend you hook up your favorite external editor.
+
+--- NEW FEATURES ---
+
+*  New Remote File API for transmitting files to the game (by @Hoekstraa)
+*  Added a new Augmentation, Z.O.Ë., which allows Sleeves to benefit from Stanek.
+
+--- FIXES ---
+
+API
+
+*  Remove incorrectly placed 's' in ns.tFormat() (by @LJNeon)
+*  More ports (previously max 20, now practically unlimited) (by @Hoekstraa)
+*  Corp functions now return copy of constant arrays instead of the original (by @Mughur)
+*  All the player sub-objects need to be copied for `getPlayer`. (by @MageKing17)
+*  add corp get<constant> functions, UI (by @Mughur)
+*  [danielyxie/bitburner#3860] destroyW0r1dD43m0n now properly gives achievements
+*  [danielyxie/bitburner#3890] favor now properly syncs across pages and the Donate achievement is now given correctly (by @Aerophia)
+*  getCrimeStats use bitnode multipliers in the output of crime stats (by @phyzical)
+*  add singularity function for exporting game save back (by @phyzical)
+
+CODING CONTRACTS
+
+*  inconsistent probability for generation between online and offline (by @quacksouls)
+*  Don't stringify answer if already a string (by @alainbryden)
+*  [danielyxie/bitburner#3755] change input handling for contract attempts (by @Snarling)
+
+CORPORATION
+
+*  [danielyxie/bitburner#3880], [danielyxie/bitburner#3876], [danielyxie/bitburner#3322], [danielyxie/bitburner#3138] Bunch of corporation fixes (by @Mughur)
+*  Gave investors some economics classes (by @Mughur)
+*  Limit shareholder priority on newly issued shares (by @Undeemiss)
+*  dont take research points for something already researched via api (by @phyzical)
+
+CORPORATION API
+
+*  Fix up param order for limitProductProduction to match docs (by @phyzical)
+*  [danielyxie/bitburner#3655] Expose exports from Material (by @Rasmoh)
+
+DOCUMENTATION
+
+*  update docs a bit more, amending some BN and SF texts (by @Mughur)
+*  Fixed Argument order for scp() (by @njalooo)
+*  Some typo fixes in Netscript functions (by @quacksouls)
+*  [danielyxie/bitburner#4033] Why use Coding Contract API (by @quacksouls)
+*  typo fix in description of Caesar cipher (by @quacksouls)
+*  typo fix in terminal.rst (by @BugiDev)
+*  Update bitburner.sleeve.settobladeburneraction.md (by @borisflagell)
+*  Correct documentation for `run()` with 0 threads. (by @MageKing17)
+*  Some doc updates (by @Mughur)
+*  fix documentation for remote api (by @hydroflame)
+
+NETSCRIPT
+
+*  Added functions to resize, move, and close tail windows
+*  [danielyxie/bitburner#2376] ns.exit now exits immediately (by @Snarling)
+*  [danielyxie/bitburner#4055] Fix dynamic ram check (by @Snarling)
+*  [danielyxie/bitburner#4037] ns1 wraps deeper layers correctly. (by @Snarling)
+*  [danielyxie/bitburner#3963] Prevent bladeburner.setActionLevel from setting invalid action levels (by @MPJ-K)
+*  Typo fixes in CodingContract, Hacknet, Singularity APIs (by @quacksouls)
+*  Fix a typo in doc of Singularity.travelToCity() (by @quacksouls)
+*  Update netscript definition file for scp, write, read, and flags (by @Snarling)
+*  Correct missing ! for boolean coercion in Corporation.createCorporation().  (by @Risenafis)
+*  Normalized Stock API logging (by @Snarling)
+*  [danielyxie/bitburner#3992] allow null duration in toast ns function (by @RollerKnobster)
+*  Correct missing `!` for boolean coercion in `singularity.workForCompany()`. (by @MageKing17)
+*  ns.scp and ns.write are now synchronous + fix exec race condition (by @Snarling)
+*  [danielyxie/bitburner#2931] atExit now allows synchronous ns functions (by @Snarling)
+*  Improve real life CPU and memory performance of scripts. (by @Snarling)
+*  Prompt Add user friendly message to avoid throwing recovery screen for invalid choices (by @phyzical)
+*  [danielyxie/bitburner#4081] Rerunning a script from tail window recalculates ram usage (by @Snarling)
+*  [danielyxie/bitburner#3962] The correct script will be closed even if the player modifies args (v2.0) (by @Snarling)
+*  Corrected ns formula for infiltration rewards (by @ezylot)
+*  Add singularity check for finishing company work (by @Snarling)
+
+SLEEVES
+
+*  [danielyxie/bitburner#3819] Allow using the regeneration chamber with sleeves to heal them. (by @coderanger)
+*  [danielyxie/bitburner#4063] fix crash when player tries to assign more than 3 sleeves to Bladeburner contracts (by @Snarling)
+*  [danielyxie/bitburner#4051] Sleeves no longer crash when player quits company sleeve was working (by @Snarling)
+*  [danielyxie/bitburner#4022], [danielyxie/bitburner#4024], [danielyxie/bitburner#4025], [danielyxie/bitburner#3998] (by @Mughur)
+*  Sleeve crime gain bitnode multiplier fix (by @Mughur)
+
+REMOTE FILE API
+
+*  NetscriptDefinitions retains export strings (by @Hoekstraa)
+*  Fix type of RFAMessages with non-String results (by @Hoekstraa)
+
+UI
+
+*  [danielyxie/bitburner#2962] add a setting to display middle time unit in Time Elapsed String (by @hydroflame)
+*  [danielyxie/bitburner#4106] fix incorrect experience display in Crime UI. (by @SilverNexus)
+*  Bitnode stats now show if BB/Corporation are disabled (by @Kelenius)
+*  Removed three empty lines from BB status screen (by @Kelenius)
+*  Add missing space to BN7 description (by @hex7cd)
+*  Improvements to crime work UI (by @Kelenius)
+*  [danielyxie/bitburner#3975], [danielyxie/bitburner#3882] Script Editor more responsive on resize, and fix dirty file indicator (by @Snarling)
+
+
+MISC
+
+*  Added weight to GangMemberTask construction call (by @ezylot)
+*  Fix ANSI display bugs (by @Snarling)
+*  Debounce updateRAM calls in script editor. (by @Snarling)
+*  [danielyxie/bitburner#3979] Allow characters & and ' in filenames (by @Snarling)
+*  [danielyxie/bitburner#3965] Corrected tutorial text (by @mihilt)
+*  Fix infil definitions.d.ts (by @phyzical)
+*  Modify PR template (by @Hoekstraa)
+*  crime gains, sleeve gang augs and faq (by @Mughur)
+*  [danielyxie/bitburner#3649] Preventing server starting security level from going above 100 (by @Shiiyu)
+*  Adds Shadows of Anarchy (by @Lagicrus)
+*  Added intormation about hacking managers to hacking algorithms page (by @Kelenius)
+*  Fix Jest CI Error (by @geggleto)
+*  multiple hasAugmentation checks didn't check if the augment was installed (by @Mughur)
+*  [danielyxie/bitburner#2442] & [danielyxie/bitburner#2795] (by @G4mingJon4s)
+*  Adds info regarding augments and focus (by @Lagicrus)
+*  Removed console.log line (by @dhosborne)
+*  Update some doc (by @hydroflame)
+*  trying to fix int problems (by @hydroflame)
+*  Fix broken ns filesnames (by @hydroflame)
+*  new formula functions (by @hydroflame)
+*  test fixes/md updates (by @phyzical)
+*  Remove "based" from positive adjectives in infiltrations (by @faangbait)
+*  minor fix in instance calculation (by @hydroflame)
+*  fix dynamic ram miscalc not triggering (by @hydroflame)
+*  Refactor game options into separate components (by @hydroflame)
+*  fix settings unfocusing on every key stroke (by @hydroflame)
+*  fix some stuff with the timestamp settings (by @hydroflame)
+*  Fix unique key problem with ascii elements (by @hydroflame)
+*  Improve wrong arg user message and add ui.windowSize (by @hydroflame)
+*  fix stack trace missing in some errors (by @hydroflame)
+*  Fix scp and write in ns1 (by @hydroflame)
+*  Did some changes of the remote api and added documentation (by @hydroflame)
+*  Add dummy function to generate a mock server or player for formulas stuff (by @hydroflame)
+*  fix compile error (by @hydroflame)
+*  regen doc (by @hydroflame)
+*  rm console log (by @hydroflame)
+*  regen doc (by @hydroflame)
+*  Added more info about blood program, change some aug descriptions (by @hydroflame)
+*  use triple equal (by @hydroflame)
+*  Minor improvements to Netscript Port loading and unloading (by @hydroflame)
+*  Fix hostname generation being weird about dash 0 added (by @hydroflame)
+*  upgrade version number. (by @hydroflame)
+*  Nerf noodle bar.
+
+
+v2.0.0 - 2022-07-19 Work rework
+-------------------------------
+
+  API break rewards
+
+* Everyone is awarded 10 NFG.
+* All work in progress program is auto completed.
+* All work in progress crafting is auto completed without adding entropy.
+
+  Work (Create program / Work for faction / Studying / etc ...)
+
+* Working has been rebuilt from the grounds up. The motivation for that change is that all
+  different types of work all required different cached variables on the main Player object.
+  This caused a lot of bugs and crashes. It's been reworked in such a way as to prevent bugs
+  and make it nearly trivial to add new kinds of work. However, since this caused a few API break
+  I've decided to mark this version following semver protocols and call it 2.0.0
+* Crime can be unfocused and auto loops, no more spam clicking.
+* All work type give their reward immediately. No need to stop work to bank rewards like reputation.
+* Faction and Company work no longer have a time limit.
+* Company work no longer reduces rep gain by half for quitting early.
+* Company faction require 400k rep to join (from 200k)
+* Backdooring company server reduces faction requirement to 300k.
+* All work generally no longer keep track of cumulative gains like exp and reputation since it's applied instantly.
+* getPlayer returns way less fields but does return the new 'currentWork' field, some fields are moved around.
+
+API breaks
+
+* workForCompany argument 'companyName' is now not-optional
+* commitCrime now has 'focus' optional parameter
+* using getScriptIncome to get total income has been separated to getTotalScriptIncome.
+* using getScriptExpGain to get total income has been separated to getTotalScriptExpGain.
+* scp has it's 2 last argument reversed, the signature is now (files, destination, optional_source)
+* ns.connect and other singularity function are no longer available at the top level.
+  They were already hidden from documentation but now they're gone.
+* stock.buy and stock.sell were renamed to stock.buyStock and stock.sellStock because 'buy' and 'sell'
+  are very common tokens.
+* corporation.bribe no longer allows to give shares as bribe.
+
+  Netscript
+
+* Add singularity.getCurrentWork
+* Add singularity.getAugmentationBasePrice
+* Add sleeve.getSleeveAugmentationPrice
+* Add sleeve.getSleeveAugmentationRepReq
+* Fix infiltration.getInfiltrationLocations
+* Singularity.goToLocation support for non-city-specific locations (@Ansopedian)
+* All corporation functions are synchronous. Job assignment only works on the following cycle. (@stalefishies)
+* Add batch functionality to NS spendHashes API (@undeemiss)
+* Fix #3661 Add missing memory property to Sleeve API (@borisflagell)
+* FIX#3732 Cannot assign two sleeve on "Take on contracts" regardless of contract type. (@borisflagell)
+
+  Corporation
+
+* Dividend fixes and exposing dividends info via scripts (@stalefishies)
+* Add big number format support in some Corporation's modal (@borisflagell)
+* Fix #3261 Industry overview number formatting (@nickofolas)
+
+  Multipliers
+
+* The main player object was also plagues with a million fields all called '*_mult'. Representing the different multipliers
+* These have been refactored in a field called 'mults'.
+
+  Misc. 
+
+* #3596 Enhanced terminal command parsing (@RevanProdigalKnight)
+* Fix #3366 Sleeve UI would sometimes displays the wrong stat while working out. (@borisflagell)
+* Two new encryption themed contracts - caesar and vigenere (@Markus-D-M)
+* Fixes #3132 several Sleeve can no longer works concurrently in the same company (@borisflagell)
+* FIX #3514 Clear recently killed tab on BN end event (@Daniel-Barbera)
+* HammingCodes description and implementation fixes (@s2ks)
+* FIX #3794 Sleeve were getting less shocked when hospitalized (was positive, should have detrimental) (@borisflagell)
+* Fix #3803 Servers can no longer have duplicate IPs (@crimsonhawk47)
+* Fix #3854 ctrl+c does not clear terminal input (@evil-tim)
+* Nerf noodle bar, obviously.
+
+
+v1.6.3 - 2022-04-01 Few stanek fixes
+------------------------------------
+
+  Stanek Gift 
+
+* Has a minimum size of 2x3
+* Active Fragment property 'avgCharge' renamed to 'highestCharge'
+* Formula for fragment effect updated to make 561% more sense. 
+  Now you can charge to your heart content.
+* Logs for the 'chargeFragment' function updated.
+
+  Misc. 
+
+* Nerf noodle bar.
+
+v1.6.0 - 2022-03-29 Grafting
+----------------------------
+
+** Vitalife secret lab **
+
+* A new mechanic called Augmentation Grafting has been added. Resleeving has been removed.
+* Credit to @nickofolas for his incredible work.
+
+** Stanek **
+
+* BREAKING: Many functions in the stanek API were renamed in order to avoid name collision with things like Map.prototype.get
+
+** UI **
+
+* Major update to Sleeve, Gang UI, and Create Program (@nickofolas)
+* re-add pre tags to support slash n in prompt (@jacktose)
+* Tabelize linked output of 'ls' (@Master-Guy)
+* Add the ability to filter open scripts (@phyzical)
+* Add minHeight to editor tabs (@nickofolas)
+* Properly expand gang equipment cards to fill entire screen (@nickofolas)
+* Add shortcut to Faction augmentations page from FactionsRoot (@nickofolas)
+* Fix extra space on editor tabs (@nickofolas)
+* Present offline message as list (@DSteve595)
+* add box showing remaining augments per faction (@jjayeon)
+* Add tab switching support to vim mode (@JParisFerrer)
+* Show current task on gang management screen (@zeddrak)
+* Fix for ui of gang members current task when set via api (@phyzical)
+* Don't hide irrelevant materials if their stock is not empty and hide irrelevant divisions from Export (@SagePtr)
+* Fix regex to enable alpha transparency hex codes (8 digits) (@surdaft)
+
+** API **
+
+* Added dark web functions to ns api
+* BREAKING: purchaseTor() should returns true if player already has Tor. (@DavidGrinberg, @waffleattack)
+* Implement getBonusTime in Corporation API (@t-wolfeadam)
+* Added functions to purchase TIX and WSI (@incubusnb)
+* purchaseSleeveAug checks shock value (@incubusnb)
+* Fix bug with hacknet api
+* Fix spendHashes bug
+* Added 0 cost of asleep() (@Master-Guy)
+* Fix some misleading corporation errors (@TheRealMaxion)
+* expose the inBladeburner on the player object (@phyzical)
+* added ram charge for stanek width and height (@phyzical)
+* Fix sufficient player money check to buy back shares. (@ChrissiQ)
+* Fix Static Ram Circumventing for some NS functions (@CrafterKolyan)
+* added CorporationSoftCap to NetscriptDefinitions (@phyzical)
+* Added definition of autocomplete() 'data' argument. (@tigercat2000)
+* Adding support for text/select options in Prompt command (@PhilipArmstead)
+* Added the ability to exportGame via api (@phyzical)
+
+** Arcade **
+
+* Added an arcade to New Tokyo where you can play a 4 year old version of bitburner.
+
+** Misc. **
+
+* Add a warning triggered while auto-saves are off. (@MartinFournier)
+* Log info for field analysis now displays actual rank gained. (@ApamNapat)
+* Removed BladeburnerSkillCost from skill point cost description. (@ApamNapat)
+* Fix handling for UpArrow in bladeburner console. (@dowinter)
+* Add GitHub action to check PRs for generated files. (@MartinFournier)
+* Cap Staneks gift at 25x25 to prevent crashes. (@waffleattack)
+* Remove old & unused files from repository. (@MartinFournier)
+* Factions on the factions screens are sorted by story progress / type. (@phyzical)
+* Fix log manager not picking up new runs of scripts. (@phyzical)
+* Added prettier to cicd.
+* UI improvements (@phyzical)
+* Documentation / Typos (@nanogyth, @Master-Guy, @incubusnb, @ApamNapat, @phyzical, @SagePtr)
+* Give player code a copy of Division.upgrades instead of the live object (@Ornedan)
+* Fix bug with small town achievement.
+* Fix bug with purchaseSleeveAug (@phyzical)
+* Check before unlocking corp upgrade (@gianfun)
+* General codebase improvements. (@phyzical, @Master-Guy, @ApamNapat)
+* Waiting on promises in NS1 no longer freezes the script. (@Master-Guy)
+* Fix bug with missing ramcost for tFormat (@TheMas3212)
+* Fix crash with new prompt
+* Quick fix to prevent division by 0 in terminal (@Master-Guy)
+* removed ip references (@phyzical, @Master-Guy)
+* Terminal now supports 'ls -l'
+* Fix negative number formatting (@Master-Guy)
+* Fix unique ip generation (@InDieTasten)
+* remove terminal command theme from docs (@phyzical)
+* Fix 'Augmentations Left' with gang factions (@nickofolas)
+* Attempt to fix 'bladeburner.process()' early routing issue (@MartinFournier)
+* work in progress augment fix (@phyzical)
+* Fixes missing space in Smart Supply (@TheRealMaxion)
+* Change license to Apache 2 with Commons Clause
+* updated regex sanitization (@mbrannen)
+* Sleeve fix for when faction isnt found (@phyzical)
+* Fix editor "close" naming (@phyzical)
+* Fix bug with sleeves where some factions would be listed as workable. (@phyzical)
+* Fix research tree of product industries post-prestige (@pd)
+* Added a check for exisiting industry type before expanding (@phyzical)
+* fix hackAnalyzeThreads returning infinity (@chrisrabe)
+* Make growthAnalyze more accurate (@dwRchyngqxs)
+* Add 'Zoom -> Reset Zoom' command to Steam (@smolgumball)
+* Add hasOwnProperty check to GetServer (@SagePtr)
+* Speed up employee productivity calculation (@pd)
+* Field Work and Security Work benefit from 'share' (@SagePtr)
+* Nerf noodle bar.
+
+
+v1.5.0 - Steam Cloud integration
+--------------------------------
+
+** Steam Cloud Saving **
+
+* Added support for steam cloud saving (@MartinFournier)
+
+** UI **
+
+* background now matches game primary color (@nickofolas)
+* page title contains version (@MartinFourier)
+* Major text editor improvements (@nickofolas)
+* Display bonus time on sleeve page (@MartinFourier)
+* Several UI improvements (@nickofolas, @smolgumball, @DrCuriosity, @phyzical)
+* Fix aug display in alpha (@Dominik Winter)
+* Fix display of corporation product equation (@SagePtr)
+* Make Bitverse more accessible (@ChrissiQ)
+* Make corporation warehouse more accessible (@ChrissiQ)
+* Make tab style more consistent (@nickofolas)
+
+** Netscript **
+
+* Fix bug with async.
+* Add 'printf' ns function (@Ninetailed)
+* Remove blob caching.
+* Fix formulas access check (@Ornedan)
+* Fix bug in exp calculation (@qcorradi)
+* Fix NaN comparison (@qcorradi)
+* Fix travelToCity with bad argument (@SlyCedix)
+* Fix bug where augs could not be purchased via sing (@reacocard)
+* Fix rounding error in donateToFaction (@Risenafis)
+* Fix bug with weakenAnalyze (@rhobes)
+* Prevent exploit with atExit (@Ornedan)
+* Double 'share' power
+
+** Corporations **
+
+* Fix bugs with corp API (@pigalot)
+* Add smart supply func to corp API (@pd)
+
+** Misc. **
+
+* The file API now allows GET and DELETE (@lordducky)
+* Force achievement calculation on BN completion (@SagePtr)
+* Cleanup in repository (@MartinFourier)
+* Several improvements to the electron version (@MartinFourier)
+* Fix bug with casino roulette (@jamie-mac)
+* Terminal history persists in savefile (@MartinFourier)
+* Fix tests (@jamie-mac)
+* Fix crash with electron windows tracker (@smolgumball)
+* Fix BN6/7 passive reputation gain (@BrianLDev)
+* Fix Sleeve not resetting on install (@waffleattack)
+* Sort joined factions (@jjayeon)
+* Update documentation / typo (@lethern, @Meowdoleon, @JohnnyUrosevic, @JosephDavidTalbot,
+  @pd, @lethern, @lordducky, @zeddrak, @fearnlj01, @reasonablytall, @MatthewTh0,
+  @SagePtr, @manniL, @Jedimaster4559, @loganville, @Arrow2thekn33, @wdpk, @fwolfst,
+  @fschoenfeldt, @Waladil, @AdamTReineke, @citrusmunch, @factubsio, @ashtongreen,
+  @ChrissiQ, @DJ-Laser, @waffleattack, @ApamNapat, @CrafterKolyan, @DSteve595)
+* Nerf noodle bar.
+
+v1.4.0 - 2022-01-18 Sharing is caring
+-------------------------------------
+
+** Computer sharing **
+
+* A new mechanic has been added, it's is invoked by calling the new function 'share'.
+  This mechanic helps you farm reputation faster.
+
+** gang **
+
+* Installing augs means losing a little bit of ascension multipliers.
+
+** Misc. **
+
+* Prevent gang API from performing actions for the type of gang they are not. (@TheMas3212)
+* Fix donation to gang faction. (@TheMas3212)
+* Fix gang check crashing the game. (@TheMas3212)
+* Make time compression more robust.
+* Fix bug with scp.
+* Add zoom to steam version. (@MartinFourier)
+* Fix donateToFaction accepts donation of NaN. (@woody-lam-cwl)
+* Show correct hash capacity gain on cache level upgrade tooltip. (@woody-lam-cwl)
+* Fix tests (@woody-lam-cwl)
+* Fix cache tooltip (@woody-lam-cwl)
+* Added script to prettify save file for debugging (@MartinFourier)
+* Update documentation / typos (@theit8514, @thadguidry, @tigercat2000, @SlyCedix, @Spacejoker, @KenJohansson,
+  @Ornedan, @JustAnOkapi, @nickofolas, @philarmstead, @TheMas3212, @dcragusa, @XxKingsxX-Pinu,
+  @paiv, @smolgumball, @zeddrak, @stinky-lizard, @nickofolas, @Feodoric, @daanflore,
+  @markusariliu, @mstruebing, @erplsf, @waffleattack, @Dexalt142, @AIT-OLPE, @deathly809, @BuckAMayzing,
+  @MartinFourier, @pigalot, @lethern)
+* Fix BN3+ achievement (@SagePtr)
+* Fix reputation carry over bug (@TheMas3212)
+* Add button to exit infiltrations (@TheMas3212)
+* Add dev menu achievement check (@TheMas3212)
+* Add 'host' config for electron server (@MartinFourier)
+* Suppress save toast only works for autosave (@MartinFourier)
+* Fix some achievements not triggering with 'backdoor' (@SagePtr)
+* Update Neuroflux Governor description.
+* Fix bug with electron server.
+* Fix bug with corporation employee assignment function (@Ornedan)
+* Add detailed information to terminal 'mem' command (@MartinFourier)
+* Add savestamp to savefile (@MartinFourier)
+* Dev menu can apply export bonus (@MartinFourier)
+* Icarus message no longer applies on top of itself (@Feodoric)
+* purchase augment via API can no longer buy Neuroflux when it shouldn't (@Feodoric)
+* Syntax highlighter should be smarter (@neuralsim)
+* Fix some miscalculation when calculating money stolen (@zeddrak)
+* Fix max cache achievement working with 0 cache (@MartinFourier)
+* Add achievements in the game, not just steam (@MartinFourier)
+* Overflow hash converts to money automatically (@MartinFourier)
+* Make mathjax load locally (@MartinFourier)
+* Make favor calculation more efficient (@kittycat2002)
+* Fix some scripts crashing the game on startup (@MartinFourier)
+* Toasts will appear above tail window (@MartinFourier)
+* Fix issue that can cause terminal actions to start on one server and end on another (@MartinFourier)
+* Fix 'fileExists' not correctly matching file names (@TheMas3212)
+* Refactor some code to be more efficient (@TheMas3212)
+* Fix exp gain for terminal grow and weaken (@nickofolas)
+* Refactor script death code to reject waiting promises instead of resolving (@Ornedan)
+* HP recalculates on defense exp gain (@TheMas3212)
+* Fix log for ascendMember (@TheMas3212)
+* Netscript ports clear on reset (@TheMas3212)
+* Fix bug related to company (@TheMas3212)
+* Fix bug where corporation handbook would not be correctly added (@TheMas3212)
+* Servers in hash upgrades are sorted alpha (@MartinFourier)
+* Fix very old save not properly migrating augmentation renamed in 0.56 (@MartinFourier)
+* Add font height and line height in theme settings (@MartinFourier)
+* Fix crash when quitting job (@MartinFourier)
+* Added save file validation system (@TheMas3212)
+* React and ReactDOM are now global objects (@pigalot)
+* 'nano' supports globs (@smolgumball)
+* Character overview can be dragged (@MartinFourier)
+* Job page updates in real time (@nickofolas)
+* Company favor gain uses the same calculation as faction, this is just performance
+  the value didn't change (@nickofolas)
+* ns2 files work with more import options (@theit8514)
+* Allow autocomplete for partial executables (@nickofolas)
+* Add support for contract completion (@nickofolas)
+* 'ls' link are clickable (@smolgumball)
+* Prevent steam from opening external LOCAL files (@MartinFourier)
+* Fix a bug with autocomplete (@Feodoric)
+* Optimise achievement checks (@Feodoric)
+* Hacknet server achievements grant associated hacknet node achievement (@Feodoric)
+* Fix display bug with hacknet (@Feodoric)
+* 'analyze' now says if the server is backdoored (@deathly809)
+* Add option to exclude running script from save (@MartinFourier)
+* Game now catches more errors and redirects to recovery page (@MartinFourier)
+* Fix bug with autocomplete (@nickofolas)
+* Add tooltip to unfocus work (@nickofolas)
+* Add detailst overview (@MartinFourier)
+* Fix focus bug (@deathly809)
+* Fix some NaN handling (@deathly809)
+* Added 'mv' ns function (@deathly809)
+* Add focus argument to some singularity functions (@nickofolas)
+* Fix some functions not disabling log correctly (@deathly809)
+* General UI improvements (@nickofolas)
+* Handle steamworks errors gravefully (@MartinFourier)
+* Fix some react component not unmounting correctly (@MartinFourier)
+* 'help' autocompletes (@nickofolas)
+* No longer push all achievements to steam (@Ornedan)
+* Recovery page has more information (@MartinFourier)
+* Added 'getGameInfo' ns function (@MartinFourier)
+* SF3.3 unlocks all corp API (@pigalot)
+* Major improvements to corp API (@pigalot)
+* Prevent seed money outside BN3 (@pigalot)
+* Fix bug where using keyboard shortcuts would crash if the feature is not available (@MartinFourier)\
+* Sidebar remains opened/closed on save (@MartinFourier)
+* Added tooltip to sidebar when closed (@MartinFourier)
+* Fix bug where Formulas.exe is not available when starting BN5 (@TheMas3212)
+* Fix CI (@tvanderpol)
+* Change shortcuts to match sidebar (@MartinFourier)
+* Format gang respect (@attrib)
+* Add modal to text editor with ram details (@nickofolas)
+* Fix several bugs with singularity focus (@nickofolas)
+* Nerf noodle bar.
+
 v1.3.0 - 2022-01-04 Cleaning up
 -------------------------------
 

doc/source/conf.py

@@ -64,9 +64,9 @@ documentation_title = '{0} Documentation'.format(project)
 # built documents.
 #
 # The short X.Y version.
-version = '1.3'
+version = '2.1'
 # The full version, including alpha/beta/rc tags.
-release = '1.3.0'
+release = '2.1.0'
 
 # The language for content autogenerated by Sphinx. Refer to documentation
 # for a list of supported languages.

doc/source/gamefrozen.rst

@@ -19,8 +19,55 @@ Then, to fix your script, make sure you have a sleep or any other timed function
         await ns.sleep(1000); // Add a 1s sleep to prevent freezing
     }
 
+Also make sure that each while loop gets to `awaited` function or `break`, for example the next snippet has a sleep 
+function, but it nor any possible conditional breaks are never reached and therefore will crash the game::
+
+    while(true) {
+        let currentMoney = ns.getServerMoneyAvailable("n00dles");
+        let maxMoney = ns.getServerMaxMoney("n00dles");
+        if (currentMoney < maxMoney/2){
+            await ns.grow("n00dles");
+        }
+        if (currentMoney === maxMoney){
+            break;
+        }
+    }
+
+If `n00dles` current money is, for example, 75% of the maximum money, the script will not reach neither `grow` nor `break` and crashes the game.
+Adding a sleep like in the first example, or changing the code so that `awaited` function or `break` is always reached, would prevent the crash.
+
+Common infinite loop when translating the server purchasing script in starting guide to :ref:`netscriptjs` is to have a 
+while loop, that's condition's change is conditional::
+
+    var ram = 8;
+    var i = 0;
+
+    while (i < ns.getPurchasedServerLimit()) {
+        if (ns.getServerMoneyAvailable("home") > ns.getPurchasedServerCost(ram)) {
+            var hostname = ns.purchaseServer("pserv-" + i, ram);
+            ns.scp("early-hack-template.script", hostname);
+            ns.exec("early-hack-template.script", hostname, 3);
+            ++i;
+        }
+    }
+
+if player does not currently have enough money to purchase a server, the `if`'s condition will be false and `++i` will not be reached.
+Since the script doesn't have `sleep` and value `i` will not change without the `if` being true, this will crash the game. Adding a `sleep`
+that is always reached would prevent the crash.
+
+Blackscreen
+-----------
+
+If the game window becomes a black screen without the game itself crashing, this is caused by 
+the game running too many concurrent scripts (the game runs on a browser and each tab can only 
+use so much ram until it crashes). Depending on which scripts are running and your hardware,
+this number can vary between 50000 to 100000 instances (in version 2.0.2. In prior versions this number 
+was about 1/5th of that). To prevent this from happening make sure to :ref:`multithread<gameplay_scripts_multithreadingscripts>`
+ the scripts as much as possible.
+
+
 Bug
 ---
 
 Otherwise, the game is probably frozen/stuck due to a bug. To report a bug, follow
-the guidelines `here <https://github.com/danielyxie/bitburner/blob/master/CONTRIBUTING.md#reporting-bugs>`_.
+the guidelines `here <https://github.com/danielyxie/bitburner/blob/master/doc/CONTRIBUTING.md#reporting-bugs>`_.

doc/source/guidesandtips/gettingstartedguideforbeginnerprogrammers.rst

@@ -62,7 +62,7 @@ To briefly summarize the information from the links above: Each server has a
 security level that affects how difficult it is to hack. Each server also has a
 certain amount of money, as well as a maximum amount of money it can hold. Hacking a
 server steals a percentage of that server's money. The :js:func:`hack` Netscript function
-is used to hack server. The :js:func:`grow` Netscript function is used to increase
+is used to hack a server. The :js:func:`grow` Netscript function is used to increase
 the amount of money available on a server. The :js:func:`weaken` Netscript function is
 used to decrease a server's security level.
 
@@ -860,6 +860,8 @@ Random Tips
 * At this stage in the game, your combat stats (strength, defense, etc.) are not nearly
   as useful as your hacking stat. Do not invest too much time or money into gaining combat
   stat exp.
+* As a rule of thumb, your hacking target should be the server with highest max money that's
+  required hacking level is under 1/3 of your hacking level. 
 
 
 

doc/source/guidesandtips/recommendedbitnodeorder.rst

@@ -15,6 +15,7 @@ BitNode-1: Source Genesis
 Description
     The first BitNode created by the Enders to imprison the minds of humans. It became
     the prototype and testing-grounds for all of the BitNodes that followed.
+
     This is the first BitNode that you play through. It has no special
     modifications or mechanics.
 
@@ -34,6 +35,8 @@ Difficulty
 BitNode-2: Rise of the Underworld
 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
 Description
+    From the shadows, they rose.
+
     Organized crime groups quickly filled the void of power left behind from the collapse of
     Western government in the 2050s. As society and civlization broke down, people quickly
     succumbed to the innate human impulse of evil and savagery. The organized crime
@@ -47,10 +50,12 @@ Description
     * Certain Factions (Slum Snakes, Tetrads, The Syndicate, The Dark Army, Speakers for the Dead,
       NiteSec, The Black Hand) give the player the ability to form and manage their own gangs. These gangs
       will earn the player money and reputation with the corresponding Faction
-    * Every Augmentation in the game will be available through the Factions listed above
+    * Every Augmentation* in the game will be available through the Factions listed above
     * For every Faction NOT listed above, reputation gains are halved
     * You will no longer gain passive reputation with Factions
 
+    (* except Neuroflux Governor, The Red Pill and augments of secret factions)
+
 Source-File
     :Max Level: 3
 
@@ -71,15 +76,17 @@ BitNode-3: Corporatocracy
 Description
     Our greatest illusion is that a healthy society can revolve around a
     single-minded pursuit of wealth.
+
     Sometime in the early 21st century economic and political globalization turned
     the world into a corporatocracy, and it never looked back. Now, the privileged
     elite will happily bankrupt their own countrymen, decimate their own community,
     and evict their neighbors from houses in their desperate bid to increase their wealth.
+    
     In this BitNode you can create and manage your own corporation. Running a successful corporation
     has the potential of generating massive profits. All other forms of income are reduced by 75%. Furthermore:
 
     * The price and reputation cost of all Augmentations is tripled
-    * The starting and maximum amount of money on servers is reduced by 75%
+    * The starting and maximum amount of money on servers is reduced by 80%
     * Server growth rate is reduced by 80%
     * You now only need 75 favour with a faction in order to donate to it, rather than 150
 
@@ -87,7 +94,7 @@ Source-File
     :Max Level: 3
 
     This Source-File lets you create corporations on other BitNodes (although
-    some BitNodes will disable this mechanic). This Source-File also increases your
+    some BitNodes will disable this mechanic) and level 3 permanently unlocks the full API. This Source-File also increases your
     charisma and company salary multipliers by:
 
     * Level 1: 8%
@@ -117,7 +124,11 @@ Source-File
     :Max Level: 3
 
     This Source-File lets you access and use the Singularity Functions in other BitNodes.
-    Each level of this Source-File will open up more Singularity Functions that you can use.
+    Each level of this Source-File will reduce RAM costs:
+
+    * Level 1: 16x
+    * Level 2: 4x
+    * Level 3: 1x
 
 Difficulty:
     Depending on what Source-Files you have unlocked before attempting this BitNode,
@@ -134,11 +145,11 @@ Description
     In this BitNode:
 
     * The base security level of servers is doubled
-    * The starting money on servers is halved, but the maximum money remains the same
+    * The starting money on servers is halved, but the maximum money is doubled
     * Most methods of earning money now give significantly less
     * Infiltration gives 50% more reputation and money
     * Corporations have 50% lower valuations and are therefore less profitable
-    * Augmentations are more expensive
+    * Augmentation price is doubled
     * Hacking experience gain rates are reduced
 
 Source-File
@@ -176,7 +187,7 @@ Description
 
     * Hacking and Hacknet Nodes will be less profitable
     * Your hacking level is reduced by 65%
-    * Hacking experience gain from scripts is reduced by 75%
+    * Hacking experience gain is reduced by 75%
     * Corporations have 80% lower valuations and are therefore less profitable
     * Working for companies is 50% less profitable
     * Crimes and Infiltration are 25% less profitable
@@ -215,7 +226,7 @@ Description
     * Augmentations are 3x more expensive
     * Hacking and Hacknet Nodes will be significantly less profitable
     * Your hacking level is reduced by 65%
-    * Hacking experience gain from scripts is reduced by 75%
+    * Hacking experience gain is reduced by 75%
     * Corporations have 80% lower valuations and are therefore less profitable
     * Working for companies is 50% less profitable
     * Crimes and Infiltration are 25% less profitable
@@ -280,7 +291,7 @@ Description
     In this BitNode:
 
     * Your stats are significantly decreased
-    * You cannnot purchase additional servers
+    * You cannot purchase additional servers
     * Hacking is significantly less profitable
 
 Source-File
@@ -295,6 +306,12 @@ Source-File
     (Note that the Level 3 effect of this Source-File only applies when entering a new BitNode, NOT
     when installing Augmentations.)
 
+    This Source-File also increases your hacknet multipliers by:
+
+    * Level 1: 8%
+    * Level 2: 12%
+    * Level 3: 14%
+
 Difficulty
     Hard
 
@@ -307,11 +324,13 @@ Description
     for the human consciousness. Mankind had finally achieved immortality - at least for those
     that could afford it.
 
-    This BitNode unlocks Sleeve technology. Sleeve technology allows you to:
+    This BitNode unlocks Sleeve and grafting technologies. Sleeve technology allows you to:
 
     1. Re-sleeve: Purchase and transfer your consciousness into a new body
     2. Duplicate Sleeves: Duplicate your consciousness into Synthoids, allowing you to perform different tasks synchronously
 
+    Grafting technology allows you to graft Augmentations, which is an alternative way of installing Augmentations.
+
     In this BitNode:
 
     * Your stats are significantly decreased
@@ -322,7 +341,7 @@ Description
 Source-File
     :Max Level: 3
 
-    This Source-File unlocks Sleeve technology in other BitNodes.
+    This Source-File unlocks Sleeve and grafting technologies in other BitNodes.
     Each level of this Source-File also grants you a Duplicate Sleeve.
 
 Difficulty
@@ -334,18 +353,19 @@ Description
     The 2050s was defined by the massive amounts of violent civil unrest and anarchic rebellion that rose all around the world. It was this period
     of disorder that eventually lead to the governmental reformation of many global superpowers, most notably
     the USA and China. But just as the world was slowly beginning to recover from these dark times, financial catastrophe hit.
+
     In many countries, the high cost of trying to deal with the civil disorder bankrupted the governments. In all of this chaos and confusion, hackers
     were able to steal billions of dollars from the world's largest electronic banks, prompting an international banking crisis as
     governments were unable to bail out insolvent banks. Now, the world is slowly crumbling in the middle of the biggest economic crisis of all time.
 
     In this BitNode:
 
-    * Your hacking stat and experience gain are halved
-    * The starting and maximum amount of money available on servers is significantly decreased
+    * Your hacking stat and experience gain are reduced
+    * The starting and maximum amount of money available on servers are reduced by 90%
     * The growth rate of servers is significantly reduced
     * Weakening a server is twice as effective
     * Company wages are decreased by 50%
-    * Corporation valuations are 99% lower and are therefore significantly less profitable
+    * Corporation valuations are 90% lower and are therefore significantly less profitable
     * Hacknet Node production is significantly decreased
     * Crime and Infiltration are more lucrative
     * Augmentations are twice as expensive
@@ -362,6 +382,12 @@ Source-File
     * Level 2: 48%
     * Level 3: 56%
 
+    This Source-File reduces the price increase for every aug bought by:
+
+    * Level 1: 4%
+    * Level 2: 6%
+    * Level 3: 7%
+
 Difficulty
     Hard
 
@@ -381,6 +407,47 @@ Source-File
 Difficulty
     Initially very easy, but then it (obviously) becomes harder as you continue to do it.
 
+BitNode-13: They're lunatics
+^^^^^^^^^^^^^^^^^^^^^^^^^
+Description
+    With the invention of Augmentations in the 2040s a religious group known as the Church of the Machine God has rallied far more support than anyone would have hoped.
+
+    Their leader, Allison "Mother" Stanek is said to have created her own Augmentation whose power goes beyond any other. Find her in Chongqing and gain her trust.
+
+    In this BitNode:
+
+    * Your hacking stat is reduced by 75% and exp by 90%
+    * Your combat stats are reduced by 30%
+    * Class and gym exp gains halved
+    * The starting and maximum amount of money available on servers is decreased
+    * The starting security on servers is significantly increased
+    * Hacking money is decreased by 80%
+    * Company wages are decreased by 60% and exp gains by 50%
+    * Hacknet Node production is decreased by 60%
+    * Crime money is decreased by 60% and exp gains by 50%
+    * Stockmarket data costs are increased 10-fold
+    * Corporation valuations are 99.9% lower and are therefore extremely less profitable
+    * The rank you gain from Bladeburner contracts/operations is reduced by 55%
+    * Bladeburner skills cost twice as many skill points
+    * Coding contracts rewards reduced by 60%
+    * Gangs gain are reduced significantly and offer low amount of Augmentations
+    * Size of Stanek's Gift is increased by 1 size
+
+Source-File
+    :Max Level: 3
+
+    Destroying this BitNode will give you Source-File 13, or if you already have this Source-File it will upgrade its level up to a maximum of 3. 
+    This Source-File lets the Church of the Machine God appear in other BitNodes.
+
+    Each level of this Source-File increases the size of Stanek's Gift.
+
+    * Level 1: 5x5
+    * Level 2: 6x6
+    * Level 3: 7x7
+
+Difficulty
+    Hard
+
 Recommended BitNodes
 --------------------
 As a player, you are not forced to tackle the BitNodes in any particular order. You are
@@ -390,9 +457,43 @@ are the recommended BitNodes for different things:
 
 For fast progression
 ^^^^^^^^^^^^^^^^^^^^
-.. note:: This does not recommend the absolute fastest path, as I don't know what
-          exactly the fastest path is. But it does recommend the BitNodes that are
-          commonly considered to be optimal by players.
+.. note:: These paths do not recommend the absolute fastest path, since speed of progression is 
+    highly dependant on playing style. Path 1 is the recommended path according to the discord community.
+
+Path 1 (new):
+
+1. (Optional) Repeat **BitNode-1: Source Genesis** until you max out its Source-File. Its Source-File
+   is extremely powerful, as it raises all multipliers by a significant amount. This also a let's you 
+   get used to augments and other features resetting.
+
+2. Do **BitNode-3: Corporatocracy** once to unlock the Corporation mechanic. This mechanic
+   has highest profit potential in the game.
+
+3. Do **BitNode-10: Digital Carbon** once to unlock sleeves and grafting. Sleeves are useful in all nodes
+   and grafting can be useful in future BitNodes (especially 8). It's recommended to buy all sleeves and 
+   their memory during the first run.
+
+    The ordering of the next three is dependant on playing style and wants/needs.
+
+4. Do **BitNode-5: Artificial Intelligence** once or twice. The intelligence stat it unlocks
+   will gradually build up as you continue to play the game, and will be helpful
+   in the future. The Source-File also provides hacking multipliers, which are
+   strong because hacking is typically one of the best ways of earning money.
+
+5. Do **BitNode-4: The Singularity**. Its Source-File does not directly make you
+   more powerful in any way, but it does unlock the `Singularity API <https://github.com/danielyxie/bitburner/blob/dev/markdown/bitburner.singularity.md>`_ which
+   let you automate significantly more aspects of the game. Consider repeating until Level 3, 
+   since each level decreases the RAM cost of Singularity functions.
+
+6. Do **BitNode-2: Rise of the Underworld** once to unlock the gang mechanic. This mechanic
+   has high profit potential and offers large amounts of Augmentations in a single faction.
+   Having sleeves (Source-File 10) greatly reduces the time it takes to get access to gangs 
+   outside this BitNode.
+
+7. Do **BitNode-9: Hacktocracy** to unlock the Hacknet Server mechanic. You can
+   consider repeating it as well, as its Level 2 and 3 effects are pretty helpful as well.
+
+Path 2 (old):
 
 1. Repeat **BitNode-1: Source Genesis** until you max out its Source-File. Its Source-File
    is extremely powerful, as it raises all multipliers by a significant amount.
@@ -479,6 +580,9 @@ simple money-generator to a more interesting mechanic.
 **BitNode-10: Digital Carbon** unlocks two new mechanics: Re-Sleeving and
 Duplicate Sleeves.
 
+**BitNode-13: They're lunatics** unlocks Stanek's Gift. This gift can improve skills, 
+hacknet production and costs, working and crime gains as well hacking power and speed.
+
 For a Challenge
 ^^^^^^^^^^^^^^^
 In general, the higher BitNodes are more difficult than the lower ones.

doc/source/index.rst

@@ -24,12 +24,14 @@ secrets that you've been searching for.
     Basic documentation <netscript>
     Basic Gameplay <basicgameplay>
     Advanced Gameplay <advancedgameplay>
+    Remote API <remoteapi.rst>
     Keyboard Shortcuts <shortcuts>
     Game Frozen or Stuck? <gamefrozen>
     Guides & Tips <guidesandtips>
     Tools & Resources <toolsandresources>
     Changelog <changelog>
     v1.0.0 script migration guide <v1.0.0_migration.rst>
+    v2.0.0 script migration guide <v2.0.0_migration.rst>
     404 <404.rst>
     Donate <https://paypal.me/danielyxie>
 

doc/source/netscript/advancedfunctions/inject_html.rst

@@ -21,7 +21,7 @@ To automatically enter commands in the terminal (only works if looking at the te
     terminalInput[handler].onChange({target:terminalInput});
 
     // Simulate an enter press
-    terminalInput[handler].onKeyDown({keyCode:13,preventDefault:()=>null});
+    terminalInput[handler].onKeyDown({key:'Enter',preventDefault:()=>null});
 
 
 To add lines to the terminal (only works if looking at the terminal):
@@ -32,4 +32,4 @@ To add lines to the terminal (only works if looking at the terminal):
     const list = document.getElementById("generic-react-container").querySelector("ul");
 
     // Inject some HTML.
-    list.insertAdjacentHTML('beforeend',`<li><p color=lime>whatever custom html</p></li>`)
+    list.insertAdjacentHTML('beforeend',`<li><p color=lime>whatever custom html</p></li>`)

doc/source/netscript/basicfunctions/scp.rst

@@ -1,14 +1,14 @@
 scp() Netscript Function
 ========================
 
-.. js:function:: scp(files[, source], destination)
+.. js:function:: scp(files, destination [, source])
 
     :RAM cost: 0.6 GB
     :param string/array files: Filename or an array of filenames of script/literature files to copy
+    :param string destination: Hostname of the destination server, which is the server to which the file will be copied.
     :param string source:
         Hostname of the source server, which is the server from which the file will be copied.
         This argument is optional and if it's omitted the source will be the current server.
-    :param string destination: Hostname of the destination server, which is the server to which the file will be copied.
     :returns: ``true`` if the copy was a success.
 
     Copies a script or literature (.lit) file(s) to another server. The
@@ -26,8 +26,8 @@ scp() Netscript Function
         scp("hack-template.script", "foodnstuff"); // returns: true
 
         //Copies "foo.lit" from the helios server to the "home" computer
-        scp("foo.lit", "helios", "home"); // returns: true
+        scp("foo.lit", "home", "helios"); // returns: true
 
         //Tries to copy three files from "rothman-uni" to "home" computer
         files = ["foo1.lit", "foo2.script", "foo3.script"];
-        scp(files, "rothman-uni", "home"); // returns: true
+        scp(files, "home", "rothman-uni"); // returns: true

doc/source/netscript/basicfunctions/scriptKill.rst

@@ -15,4 +15,4 @@ scriptKill() Netscript Function
 
     .. code-block:: javascript
 
-        scriptKill("demo.script"); // returns: true
+        scriptKill("demo.script", "home"); // returns: true

doc/source/netscript/basicfunctions/spawn.rst

@@ -23,4 +23,4 @@ spawn() Netscript Function
 
     .. code-block:: javascript
 
-        spawn('foo.script', 10, 'foodnstuff', 90); // "run foo.script 10 foodnstuff 90" in 10 seconds.
+        spawn('foo.script', 10, 'foodnstuff', 90); // "run foo.script foodnstuff 90 -t 10" in 10 seconds.

doc/source/netscript/netscriptjs.rst

@@ -51,11 +51,9 @@ Here is a summary of all rules you need to follow when writing Netscript JS code
     * grow
     * weaken
     * sleep
+    * asleep
     * prompt
     * wget
-    * scp
-    * write
-    * writePort
 
 * Any function that contains :code:`await` must be declared as :code:`async`
 
@@ -147,9 +145,7 @@ You may have noticed that every new ns2 file will contains the following comment
 
 .. code-block:: javascript
 
-    /**
-    * @param {NS} ns
-    **/
+    /** @param {NS} ns */
 
 This comment is used to help the text editor autocomplete functions in the Netscript API. You can enable it by pressing ctrl+space after `ns.`
 

doc/source/netscript/netscriptscriptarguments.rst

@@ -23,3 +23,14 @@ into a script using::
     args.length
 
 **WARNING: Do not try to modify the args array. This will break the game.**
+
+
+example for accessing arguments in ns2 from terminal execution:
+terminal command:
+run name_of_script.js -t 10 --tail argument1 argument2
+
+ns2 script:
+
+const args_obj = arguments[0]
+const argument1 = (args_obj.server.args[0])
+const argument2 = (args_obj.server.args[1])

doc/source/remoteapi.rst

@@ -0,0 +1,206 @@
+
+Remote API
+==========
+
+All versions of Bitburner can use websockets to connect to a server.
+That server can then perform a number of actions.
+Most commonly this is used in conjunction with an external text editor or API
+in order to make writing scripts easier, or even use typescript.
+
+To make use of this Remote API through the official server, look here: https://github.com/bitburner-official/typescript-template.
+If you want to make your own server, see below for API details.
+
+This API uses the JSON RCP 2.0 protocol. Inputs are in the following form:
+
+    .. code-block:: javascript
+
+        {
+            "jsonrpc": "2.0",
+            "id": number,
+            "method": string,
+            "params": any
+        }
+
+Outputs:
+
+    .. code-block:: javascript
+
+        {
+            "jsonrpc": "2.0",
+            "id": number,
+            "result": any,
+            "error": any
+        }
+
+
+Methods
+-------
+
+`pushFile`
+^^^^^^^^^^
+    Create or update a file.
+
+    .. code-block:: javascript
+
+        {
+            "jsonrpc": "2.0",
+            "id": number,
+            "method": "pushFile",
+            "params": {
+                filename: string;
+                content: string;
+                server: string;
+            }
+        }
+
+    .. code-block:: javascript
+
+        {
+            "jsonrpc": "2.0",
+            "id": number,
+            "result": "OK"
+        }
+
+`getFile`
+^^^^^^^^^
+    Read a file and it's content.
+
+    .. code-block:: javascript
+
+        {
+            "jsonrpc": "2.0",
+            "id": number,
+            "method": "getFile",
+            "params": {
+                filename: string;
+                server: string;
+            }
+        }
+
+    .. code-block:: javascript
+
+        {
+            "jsonrpc": "2.0",
+            "id": number,
+            "result": string
+        }
+
+`deleteFile`
+^^^^^^^^^^^^
+    Delete a file.
+
+    .. code-block:: javascript
+
+        {
+            "jsonrpc": "2.0",
+            "id": number,
+            "method": "deleteFile",
+            "params": {
+                filename: string;
+                server: string;
+            }
+        }
+
+    .. code-block:: javascript
+
+        {
+            "jsonrpc": "2.0",
+            "id": number,
+            "result": "OK"
+        }
+
+`getFileNames`
+^^^^^^^^^^^^^^
+    List all file names on a server.
+
+    .. code-block:: javascript
+
+        {
+            "jsonrpc": "2.0",
+            "id": number,
+            "method": "getFileNames",
+            "params": {
+                server: string;
+            }
+        }
+
+    .. code-block:: javascript
+
+        {
+            "jsonrpc": "2.0",
+            "id": number,
+            "result": string[]
+        }
+
+`getAllFiles`
+^^^^^^^^^^^^^
+    Get the content of all files on a server.
+
+    .. code-block:: javascript
+
+        {
+            "jsonrpc": "2.0",
+            "id": number,
+            "method": "getAllFiles",
+            "params": {
+                server: string;
+            }
+        }
+
+    .. code-block:: javascript
+
+        {
+            "jsonrpc": "2.0",
+            "id": number,
+            "result": {
+                filename: string,
+                content: string
+            }[]
+        }
+
+`calculateRam`
+^^^^^^^^^^^^^^
+    Calculate the in-game ram cost of a script.
+
+    .. code-block:: javascript
+
+        {
+            "jsonrpc": "2.0",
+            "id": number,
+            "method": "calculateRam",
+            "params": {
+                filename: string;
+                server: string;
+            }
+        }
+
+    .. code-block:: javascript
+
+        {
+            "jsonrpc": "2.0",
+            "id": number,
+            "result": number
+        }
+
+
+`getDefinitionFile`
+^^^^^^^^^^^^^^^^^^^
+    Get the definition file of the API.
+
+    .. code-block:: javascript
+
+        {
+            "jsonrpc": "2.0",
+            "id": number,
+            "method": "getDefinitionFile"
+        }
+
+    .. code-block:: javascript
+
+        {
+            "jsonrpc": "2.0",
+            "id": number,
+            "result": string
+        }
+
+

doc/source/v2.0.0_migration.rst

@@ -0,0 +1,109 @@
+v2.0.0 Migration Guide
+======================
+
+In v2.0.0 a few more API have been broken.
+
+Working
+-------
+
+    Working has been rebuilt from the grounds up. The motivation for that change is that all
+    different types of work all required different cached variables on the main Player object.
+    This caused a lot of bugs and crashes. It's been reworked in such a way as to prevent bugs
+    and make it nearly trivial to add new kinds of work.
+    All work type give their reward immediately. No need to stop work to bank rewards like reputation.
+    Faction and Company work no longer have a time limit.
+    Company work no longer reduces rep gain by half for quitting early.
+    Company faction require 400k rep to join (from 200k)
+    Backdooring company server reduces faction requirement to 300k.
+    All types of work generally no longer keep track of cumulative gains like exp and reputation since it's applied instantly.
+
+commitCrime
+-----------
+
+    crime now loops, meaning after finishing one shoplift you start the next one with no input. While the signature
+    has not changed its behavior has. It also has a new 'focus' parameters.
+
+getPlayer
+---------
+
+    The following work-related fields are not longer included: 
+
+    * workChaExpGained
+    * currentWorkFactionName
+    * workDexExpGained
+    * workHackExpGained
+    * createProgramReqLvl
+    * workStrExpGained
+    * companyName
+    * crimeType
+    * workRepGained
+    * workChaExpGainRate
+    * workType
+    * workStrExpGainRate
+    * isWorking
+    * workRepGainRate
+    * workDefExpGained
+    * currentWorkFactionDescription
+    * workHackExpGainRate
+    * workAgiExpGainRate
+    * workDexExpGainRate
+    * workMoneyGained
+    * workMoneyLossRate
+    * workMoneyGainRate
+    * createProgramName
+    * workDefExpGainRate
+    * workAgiExpGained
+    * className
+
+    The reason for that is that these fields are all, in one way or another, included in the new work field 'currentWork'.
+    Some of these values are also irrelevant.
+    Take a look at the new singularity.getCurrentWork function.
+
+    All fields ending in _mult have been moved to the 'mults' struct.
+    For example: getPlayer().hacking_skill_mult => getPlayer().mults.hacking_skill
+
+    skills have been moved to the skills struct
+    For example: getPlayer().hacking => getPlayer().skills.hacking
+
+    exp have been moved to the exp struct
+    For example: getPlayer().hacking_exp => getPlayer().exp.hacking
+
+    hp have been moved to the hp struct
+    For example: getPlayer().max_hp => getPlayer().hp.max or hp.current
+
+    hasWseAccount, hasTixApiAccess, has4SData, has4SDataTixApi have been removed and replaced with similar stock functions
+
+workForCompany
+--------------
+
+    The argument 'companyName' is now not-optional.
+
+
+getScriptIncome & getScriptExpGain
+----------------------------------
+
+    Those 2 functions used to have a call where no arguments would return the total for all scripts. This caused weird signature.
+    If you want to get the total income/exp for all scripts used the new getTotalScriptIncome / getTotalScriptExpGain instead.
+
+scp
+---
+
+    scp has it's 2 last argument reversed, the signature is now scp(files, destination, optional_source)
+
+Singularity
+-----------
+
+    A while ago top level singularity function were deprecated in favor of the singularity namespace.
+    This means calls like 'ns.connect' need to be changed to 'ns.singularity.connect'
+
+
+stock.buy, stock.sell, stock.short
+----------------------------------
+    
+    These functions were renamed to stock.buyStock, stock.sellStock, and stock.buyShort because 'buy', 'sell', and 'short'
+    are very common tokens that would trick the ram calculation.
+
+corporation.bribe
+-----------------
+
+    The ability to give shares as bribe has been removed. The signature is now bribe(faction, money)

doc/source/ystatic/dark_theme.css

@@ -1,453 +0,0 @@
-:root {
-  --dark-text-color: #0c0;
-  --dark-link-color: #090;
-}
-
-body {
-  color: #000;
-}
-
-.wy-nav-content-wrap {
-  background-color: #000;
-}
-
-.wy-nav-content {
-  background-color: #000;
-}
-
-.section {
-  color: var(--dark-text-color);
-}
-
-.rst-content .highlighted {
-  background: #333;
-  box-shadow: none;
-}
-
-.highlight {
-  background-color: #17181c;
-}
-
-.highlight .nn {
-  color: var(--dark-text-color);
-}
-
-.highlight .nb {
-  color: #8bb8df;
-}
-
-.highlight .kn,
-.highlight .kc,
-.highlight .k {
-  color: #41c2ea;
-}
-
-.highlight .s1,
-.highlight .s2 {
-  color: #b3e87f;
-}
-
-.highlight .nt {
-  color: #ccb350;
-}
-
-.highlight .c1 {
-  color: #686868;
-}
-
-.rst-content div[class^="highlight"] {
-  border-color: #1a1a1a;
-}
-
-.icon,
-.icon-home {
-  color: var(--dark-link-color);
-}
-
-.wy-nav-content a,
-.wy-nav-content a:visited {
-  color: var(--dark-link-color) !important;
-  text-decoration: underline;
-}
-
-.btn-neutral {
-  background-color: #17181c !important;
-}
-
-.btn-neutral:hover {
-  background-color: #101114 !important;
-}
-
-.btn-neutral:visited {
-  color: #c1c1c1 !important;
-}
-
-.btn {
-  box-shadow: none;
-}
-
-footer {
-  color: #bdbdbd;
-}
-
-.wy-nav-side {
-  background-color: #000;
-  border: 1px solid #333;
-}
-
-.wy-menu-vertical > a {
-  color: var(--dark-text-color);
-}
-
-.wy-menu-vertical li.current {
-  background-color: #000;
-}
-
-.wy-menu-vertical li.current > a,
-.wy-menu-vertical li.on a {
-  background-color: #000;
-  color: var(--dark-text-color);
-}
-
-.wy-menu-vertical li.toctree-l1.current > a,
-.wy-menu-vertical li.current a {
-  border-color: #000;
-}
-
-.wy-menu-vertical header,
-.wy-menu-vertical p.caption {
-  color: var(--dark-text-color);
-}
-
-html.writer-html4 .rst-content dl:not(.docutils) > dt,
-html.writer-html5
-  .rst-content
-  dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.glossary):not(.simple)
-  > dt {
-  background-color: #333;
-}
-
-.wy-menu-vertical li.current a {
-  color: #090;
-}
-.wy-menu-vertical a {
-  color: var(--dark-text-color);
-}
-
-.wy-menu-vertical li.current a:hover {
-  background-color: #222;
-}
-
-.wy-menu-vertical a:hover,
-.wy-menu-vertical li.current > a:hover,
-.wy-menu-vertical li.on a:hover {
-  background-color: #000;
-  color: var(--dark-text-color);
-}
-
-.wy-menu-vertical li.toctree-l2.current > a,
-.wy-menu-vertical li.toctree-l2.current li.toctree-l3 > a {
-  background-color: #000;
-}
-
-.wy-side-nav-search {
-  background-color: #000;
-  color: var(--dark-text-color);
-}
-
-.wy-side-nav-search .wy-dropdown > a,
-.wy-side-nav-search > a {
-  color: var(--dark-text-color);
-}
-
-.wy-side-nav-search input[type="text"] {
-  border-left: 0px;
-  border-right: 0px;
-  border-top: 0px;
-  border-radius: 0px;
-  box-shadow: none;
-  border-bottom-color: #0c0;
-  background-color: #333;
-  color: var(--dark-text-color);
-}
-
-.theme-switcher {
-  background-color: #0b0c0d;
-  color: var(--dark-text-color);
-}
-
-writer-html4 .rst-content dl:not(.docutils) > dt,
-writer-html5 .rst-content dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.glossary):not(.simple) > dt {
-  background-color: #0b0b0b;
-  color: #007dce;
-  border-color: #282828;
-}
-
-.rst-content code,
-.rst-content tt {
-  color: var(--dark-text-color);
-}
-
-writer-html4 .rst-content dl:not(.docutils) dl:not(.field-list) > dt,
-writer-html5
-  .rst-content
-  dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.glossary):not(.simple)
-  dl:not(.field-list)
-  > dt {
-  background-color: #0f0f0f;
-  color: #959595;
-  border-color: #2b2b2b;
-}
-
-.rst-content code,
-.rst-content tt,
-code {
-  background-color: #2d2d2d;
-  border-color: #1c1c1c;
-}
-
-.rst-content code.xref,
-.rst-content tt.xref,
-a .rst-content code,
-a .rst-content tt {
-  color: #cecece;
-}
-
-.rst-content .hint,
-.rst-content .important,
-.rst-content .tip,
-.rst-content .wy-alert-success.admonition,
-.rst-content .wy-alert-success.admonition-todo,
-.rst-content .wy-alert-success.attention,
-.rst-content .wy-alert-success.caution,
-.rst-content .wy-alert-success.danger,
-.rst-content .wy-alert-success.error,
-.rst-content .wy-alert-success.note,
-.rst-content .wy-alert-success.seealso,
-.rst-content .wy-alert-success.warning,
-.wy-alert.wy-alert-success {
-  background-color: #00392e;
-}
-
-.rst-content .hint .admonition-title,
-.rst-content .hint .wy-alert-title,
-.rst-content .important .admonition-title,
-.rst-content .important .wy-alert-title,
-.rst-content .tip .admonition-title,
-.rst-content .tip .wy-alert-title,
-.rst-content .wy-alert-success.admonition-todo .admonition-title,
-.rst-content .wy-alert-success.admonition-todo .wy-alert-title,
-.rst-content .wy-alert-success.admonition .admonition-title,
-.rst-content .wy-alert-success.admonition .wy-alert-title,
-.rst-content .wy-alert-success.attention .admonition-title,
-.rst-content .wy-alert-success.attention .wy-alert-title,
-.rst-content .wy-alert-success.caution .admonition-title,
-.rst-content .wy-alert-success.caution .wy-alert-title,
-.rst-content .wy-alert-success.danger .admonition-title,
-.rst-content .wy-alert-success.danger .wy-alert-title,
-.rst-content .wy-alert-success.error .admonition-title,
-.rst-content .wy-alert-success.error .wy-alert-title,
-.rst-content .wy-alert-success.note .admonition-title,
-.rst-content .wy-alert-success.note .wy-alert-title,
-.rst-content .wy-alert-success.seealso .admonition-title,
-.rst-content .wy-alert-success.seealso .wy-alert-title,
-.rst-content .wy-alert-success.warning .admonition-title,
-.rst-content .wy-alert-success.warning .wy-alert-title,
-.rst-content .wy-alert.wy-alert-success .admonition-title,
-.wy-alert.wy-alert-success .rst-content .admonition-title,
-.wy-alert.wy-alert-success .wy-alert-title {
-  background-color: #006a56;
-}
-
-.rst-content .note,
-.rst-content .seealso,
-.rst-content .wy-alert-info.admonition,
-.rst-content .wy-alert-info.admonition-todo,
-.rst-content .wy-alert-info.attention,
-.rst-content .wy-alert-info.caution,
-.rst-content .wy-alert-info.danger,
-.rst-content .wy-alert-info.error,
-.rst-content .wy-alert-info.hint,
-.rst-content .wy-alert-info.important,
-.rst-content .wy-alert-info.tip,
-.rst-content .wy-alert-info.warning,
-.wy-alert.wy-alert-info {
-  background-color: #002c4d;
-}
-
-.rst-content .note .admonition-title,
-.rst-content .note .wy-alert-title,
-.rst-content .seealso .admonition-title,
-.rst-content .seealso .wy-alert-title,
-.rst-content .wy-alert-info.admonition-todo .admonition-title,
-.rst-content .wy-alert-info.admonition-todo .wy-alert-title,
-.rst-content .wy-alert-info.admonition .admonition-title,
-.rst-content .wy-alert-info.admonition .wy-alert-title,
-.rst-content .wy-alert-info.attention .admonition-title,
-.rst-content .wy-alert-info.attention .wy-alert-title,
-.rst-content .wy-alert-info.caution .admonition-title,
-.rst-content .wy-alert-info.caution .wy-alert-title,
-.rst-content .wy-alert-info.danger .admonition-title,
-.rst-content .wy-alert-info.danger .wy-alert-title,
-.rst-content .wy-alert-info.error .admonition-title,
-.rst-content .wy-alert-info.error .wy-alert-title,
-.rst-content .wy-alert-info.hint .admonition-title,
-.rst-content .wy-alert-info.hint .wy-alert-title,
-.rst-content .wy-alert-info.important .admonition-title,
-.rst-content .wy-alert-info.important .wy-alert-title,
-.rst-content .wy-alert-info.tip .admonition-title,
-.rst-content .wy-alert-info.tip .wy-alert-title,
-.rst-content .wy-alert-info.warning .admonition-title,
-.rst-content .wy-alert-info.warning .wy-alert-title,
-.rst-content .wy-alert.wy-alert-info .admonition-title,
-.wy-alert.wy-alert-info .rst-content .admonition-title,
-.wy-alert.wy-alert-info .wy-alert-title {
-  background-color: #004a7b;
-}
-
-.rst-content dl:not(.docutils) dt {
-  background-color: #333;
-}
-
-.rst-content {
-  color: var(--dark-text-color);
-}
-
-.rst-content .admonition-todo,
-.rst-content .attention,
-.rst-content .caution,
-.rst-content .warning,
-.rst-content .wy-alert-warning.admonition,
-.rst-content .wy-alert-warning.danger,
-.rst-content .wy-alert-warning.error,
-.rst-content .wy-alert-warning.hint,
-.rst-content .wy-alert-warning.important,
-.rst-content .wy-alert-warning.note,
-.rst-content .wy-alert-warning.seealso,
-.rst-content .wy-alert-warning.tip,
-.wy-alert.wy-alert-warning {
-  background-color: #533500;
-}
-
-.rst-content .admonition-todo .admonition-title,
-.rst-content .admonition-todo .wy-alert-title,
-.rst-content .attention .admonition-title,
-.rst-content .attention .wy-alert-title,
-.rst-content .caution .admonition-title,
-.rst-content .caution .wy-alert-title,
-.rst-content .warning .admonition-title,
-.rst-content .warning .wy-alert-title,
-.rst-content .wy-alert-warning.admonition .admonition-title,
-.rst-content .wy-alert-warning.admonition .wy-alert-title,
-.rst-content .wy-alert-warning.danger .admonition-title,
-.rst-content .wy-alert-warning.danger .wy-alert-title,
-.rst-content .wy-alert-warning.error .admonition-title,
-.rst-content .wy-alert-warning.error .wy-alert-title,
-.rst-content .wy-alert-warning.hint .admonition-title,
-.rst-content .wy-alert-warning.hint .wy-alert-title,
-.rst-content .wy-alert-warning.important .admonition-title,
-.rst-content .wy-alert-warning.important .wy-alert-title,
-.rst-content .wy-alert-warning.note .admonition-title,
-.rst-content .wy-alert-warning.note .wy-alert-title,
-.rst-content .wy-alert-warning.seealso .admonition-title,
-.rst-content .wy-alert-warning.seealso .wy-alert-title,
-.rst-content .wy-alert-warning.tip .admonition-title,
-.rst-content .wy-alert-warning.tip .wy-alert-title,
-.rst-content .wy-alert.wy-alert-warning .admonition-title,
-.wy-alert.wy-alert-warning .rst-content .admonition-title,
-.wy-alert.wy-alert-warning .wy-alert-title {
-  background-color: #803b00;
-}
-
-.rst-content .danger,
-.rst-content .error,
-.rst-content .wy-alert-danger.admonition,
-.rst-content .wy-alert-danger.admonition-todo,
-.rst-content .wy-alert-danger.attention,
-.rst-content .wy-alert-danger.caution,
-.rst-content .wy-alert-danger.hint,
-.rst-content .wy-alert-danger.important,
-.rst-content .wy-alert-danger.note,
-.rst-content .wy-alert-danger.seealso,
-.rst-content .wy-alert-danger.tip,
-.rst-content .wy-alert-danger.warning,
-.wy-alert.wy-alert-danger {
-  background-color: #82231a;
-}
-
-.rst-content .danger .admonition-title,
-.rst-content .danger .wy-alert-title,
-.rst-content .error .admonition-title,
-.rst-content .error .wy-alert-title,
-.rst-content .wy-alert-danger.admonition-todo .admonition-title,
-.rst-content .wy-alert-danger.admonition-todo .wy-alert-title,
-.rst-content .wy-alert-danger.admonition .admonition-title,
-.rst-content .wy-alert-danger.admonition .wy-alert-title,
-.rst-content .wy-alert-danger.attention .admonition-title,
-.rst-content .wy-alert-danger.attention .wy-alert-title,
-.rst-content .wy-alert-danger.caution .admonition-title,
-.rst-content .wy-alert-danger.caution .wy-alert-title,
-.rst-content .wy-alert-danger.hint .admonition-title,
-.rst-content .wy-alert-danger.hint .wy-alert-title,
-.rst-content .wy-alert-danger.important .admonition-title,
-.rst-content .wy-alert-danger.important .wy-alert-title,
-.rst-content .wy-alert-danger.note .admonition-title,
-.rst-content .wy-alert-danger.note .wy-alert-title,
-.rst-content .wy-alert-danger.seealso .admonition-title,
-.rst-content .wy-alert-danger.seealso .wy-alert-title,
-.rst-content .wy-alert-danger.tip .admonition-title,
-.rst-content .wy-alert-danger.tip .wy-alert-title,
-.rst-content .wy-alert-danger.warning .admonition-title,
-.rst-content .wy-alert-danger.warning .wy-alert-title,
-.rst-content .wy-alert.wy-alert-danger .admonition-title,
-.wy-alert.wy-alert-danger .rst-content .admonition-title,
-.wy-alert.wy-alert-danger .wy-alert-title {
-  background-color: #b9372b;
-}
-
-.wy-nav-top {
-  background-color: #0b152d;
-}
-
-.rst-content table.docutils thead,
-.rst-content table.field-list thead,
-.wy-table thead {
-  color: var(--dark-text-color);
-}
-
-.rst-content table.docutils:not(.field-list) tr:nth-child(2n-1) td,
-.wy-table-backed,
-.wy-table-odd td,
-.wy-table-striped tr:nth-child(2n-1) td {
-  background-color: #333;
-}
-
-.rst-content table.docutils:not(.field-list) tr:nth-child(2n) td,
-.wy-table-backed,
-.wy-table-odd td,
-.wy-table-striped tr:nth-child(2n) td {
-  background-color: #444;
-}
-
-.rst-content table.docutils td,
-.wy-table-bordered-all td,
-writer-html5 .rst-content table.docutils th,
-.rst-content table.docutils,
-.wy-table-bordered-all {
-  border-color: #262626;
-}
-
-.rst-content table.docutils caption,
-.rst-content table.field-list caption,
-.wy-table caption {
-  color: var(--dark-text-color);
-}
-
-.wy-menu-vertical li.toctree-l3.current > a,
-.wy-menu-vertical li.toctree-l3.current li.toctree-l4 > a {
-  background-color: #000;
-}
-
-.wy-side-nav-search > div.version {
-  color: var(--dark-text-color);
-}

electron/achievements.js

@@ -6,18 +6,18 @@ async function enableAchievementsInterval(window) {
   // If the Steam API could not be initialized on game start, we'll abort this.
   if (global.greenworksError) return;
 
-   // This is backward but the game fills in an array called `document.achievements` and we retrieve it from
+  // This is backward but the game fills in an array called `document.achievements` and we retrieve it from
   // here. Hey if it works it works.
   const steamAchievements = greenworks.getAchievementNames();
-  log.debug(`All Steam achievements ${JSON.stringify(steamAchievements)}`);
-  const playerAchieved = (await Promise.all(steamAchievements.map(checkSteamAchievement))).filter(name => !!name);
+  log.silly(`All Steam achievements ${JSON.stringify(steamAchievements)}`);
+  const playerAchieved = (await Promise.all(steamAchievements.map(checkSteamAchievement))).filter((name) => !!name);
   log.debug(`Player has Steam achievements ${JSON.stringify(playerAchieved)}`);
   const intervalID = setInterval(async () => {
     try {
       const playerAchievements = await window.webContents.executeJavaScript("document.achievements");
       for (const ach of playerAchievements) {
         if (!steamAchievements.includes(ach)) continue; // Don't try activating achievements that don't exist Steam-side
-        if (playerAchieved.includes(ach)) continue;     // Don't spam achievements that have already been recorded
+        if (playerAchieved.includes(ach)) continue; // Don't spam achievements that have already been recorded
         log.info(`Granting Steam achievement ${ach}`);
         greenworks.activateAchievement(ach, () => undefined);
         playerAchieved.push(ach);
@@ -26,7 +26,7 @@ async function enableAchievementsInterval(window) {
       log.error(error);
 
       // The interval probably did not get cleared after a window kill
-      log.warn('Clearing achievements timer');
+      log.warn("Clearing achievements timer");
       clearInterval(intervalID);
       return;
     }
@@ -36,10 +36,14 @@ async function enableAchievementsInterval(window) {
 
 function checkSteamAchievement(name) {
   return new Promise((resolve) => {
-    greenworks.getAchievement(name, playerHas => resolve(playerHas ? name : ""), err => {
-      log.warn(`Failed to get Steam achievement ${name} status: ${err}`);
-      resolve("");
-    });
+    greenworks.getAchievement(
+      name,
+      (playerHas) => resolve(playerHas ? name : ""),
+      (err) => {
+        log.warn(`Failed to get Steam achievement ${name} status: ${err}`);
+        resolve("");
+      },
+    );
   });
 }
 
@@ -50,5 +54,6 @@ function disableAchievementsInterval(window) {
 }
 
 module.exports = {
-  enableAchievementsInterval, disableAchievementsInterval
-}
+  enableAchievementsInterval,
+  disableAchievementsInterval,
+};

electron/api-server.js

@@ -12,20 +12,27 @@ async function initialize(win) {
   window = win;
   server = http.createServer(async function (req, res) {
     let body = "";
+    res.setHeader("Content-Type", "application/json");
 
     req.on("data", (chunk) => {
       body += chunk.toString(); // convert Buffer to string
     });
-    req.on("end", () => {
-      const providedToken = req.headers?.authorization?.replace('Bearer ', '') ?? '';
+
+    req.on("end", async () => {
+      const providedToken = req.headers?.authorization?.replace("Bearer ", "") ?? "";
       const isValid = providedToken === getAuthenticationToken();
       if (isValid) {
-        log.debug('Valid authentication token');
+        log.debug("Valid authentication token");
       } else {
-        log.log('Invalid authentication token');
+        log.log("Invalid authentication token");
         res.writeHead(401);
-        res.write('Invalid authentication token');
-        res.end();
+
+        res.end(
+          JSON.stringify({
+            success: false,
+            msg: "Invalid authentication token",
+          }),
+        );
         return;
       }
 
@@ -35,24 +42,68 @@ async function initialize(win) {
       } catch (error) {
         log.warn(`Invalid body data`);
         res.writeHead(400);
-        res.write('Invalid body data');
-        res.end();
+        res.end(
+          JSON.stringify({
+            success: false,
+            msg: "Invalid body data",
+          }),
+        );
+
         return;
       }
 
-      if (data) {
-        window.webContents.executeJavaScript(`document.saveFile("${data.filename}", "${data.code}")`).then((result) => {
-          res.write(result);
-          res.end();
-        });
+      let result;
+      switch (req.method) {
+        // Request files
+        case "GET":
+          result = await window.webContents.executeJavaScript(`document.getFiles()`);
+          break;
+
+        // Create or update files
+        // Support POST for VScode implementation
+        case "POST":
+        case "PUT":
+          if (!data) {
+            log.warn(`Invalid script update request - No data`);
+            res.writeHead(400);
+            res.end(
+              JSON.stringify({
+                success: false,
+                msg: "Invalid script update request - No data",
+              }),
+            );
+            return;
+          }
+
+          result = await window.webContents.executeJavaScript(`document.saveFile("${data.filename}", "${data.code}")`);
+          break;
+
+        // Delete files
+        case "DELETE":
+          result = await window.webContents.executeJavaScript(`document.deleteFile("${data.filename}")`);
+          break;
       }
+
+      if (!result.res) {
+        //We've encountered an error
+        res.writeHead(400);
+        log.warn(`Api Server Error`, result.msg);
+      }
+
+      res.end(
+        JSON.stringify({
+          success: result.res,
+          msg: result.msg,
+          data: result.data,
+        }),
+      );
     });
   });
 
-  const autostart = config.get('autostart', false);
+  const autostart = config.get("autostart", false);
   if (autostart) {
     try {
-      await enable()
+      await enable();
     } catch (error) {
       return Promise.reject(error);
     }
@@ -61,15 +112,14 @@ async function initialize(win) {
   return Promise.resolve();
 }
 
-
 function enable() {
   if (isListening()) {
-    log.warn('API server already listening');
+    log.warn("API server already listening");
     return Promise.resolve();
   }
 
-  const port = config.get('port', 9990);
-  const host = config.get('host', '127.0.0.1');
+  const port = config.get("port", 9990);
+  const host = config.get("host", "127.0.0.1");
   log.log(`Starting http server on port ${port} - listening on ${host}`);
 
   // https://stackoverflow.com/a/62289870
@@ -81,13 +131,10 @@ function enable() {
         resolve();
       }
     });
-    server.once('error', (err) => {
+    server.once("error", (err) => {
       if (!startFinished) {
         startFinished = true;
-        console.log(
-          'There was an error starting the server in the error listener:',
-          err
-        );
+        console.log("There was an error starting the server in the error listener:", err);
         reject(err);
       }
     });
@@ -96,11 +143,11 @@ function enable() {
 
 function disable() {
   if (!isListening()) {
-    log.warn('API server not listening');
+    log.warn("API server not listening");
     return Promise.resolve();
   }
 
-  log.log('Stopping http server');
+  log.log("Stopping http server");
   return server.close();
 }
 
@@ -118,31 +165,35 @@ function isListening() {
 
 function toggleAutostart() {
   const newValue = !isAutostart();
-  config.set('autostart', newValue);
+  config.set("autostart", newValue);
   log.log(`New autostart value is '${newValue}'`);
 }
 
 function isAutostart() {
-  return config.get('autostart');
+  return config.get("autostart");
 }
 
 function getAuthenticationToken() {
-  const token = config.get('token');
+  const token = config.get("token");
   if (token) return token;
 
   const newToken = generateToken();
-  config.set('token', newToken);
+  config.set("token", newToken);
   return newToken;
 }
 
 function generateToken() {
   const buffer = crypto.randomBytes(48);
-  return buffer.toString('base64')
+  return buffer.toString("base64");
 }
 
 module.exports = {
   initialize,
-  enable, disable, toggleServer,
-  toggleAutostart, isAutostart,
-  getAuthenticationToken, isListening,
-}
+  enable,
+  disable,
+  toggleServer,
+  toggleAutostart,
+  isAutostart,
+  getAuthenticationToken,
+  isListening,
+};

electron/exit.html

@@ -1,9 +1,8 @@
 <!DOCTYPE html>
 <html lang="en">
   <head>
-    <meta charset="utf-8"/>
+    <meta charset="utf-8" />
     <title>Bitburner</title>
-    <link rel="stylesheet" href="main.css" />
     <style>
       body {
         background-color: black;

electron/export.html

@@ -1,9 +1,8 @@
 <!DOCTYPE html>
 <html lang="en">
   <head>
-    <meta charset="utf-8"/>
+    <meta charset="utf-8" />
     <title>Bitburner</title>
-    <link rel="stylesheet" href="main.css" />
     <style>
       body {
         background-color: black;

electron/gameWindow.js

@@ -8,20 +8,43 @@ const api = require("./api-server");
 const cp = require("child_process");
 const path = require("path");
 const fs = require("fs");
+const { windowTracker } = require("./windowTracker");
 const { fileURLToPath } = require("url");
 
 const debug = process.argv.includes("--debug");
 
 async function createWindow(killall) {
   const setStopProcessHandler = global.app_handlers.stopProcess;
+  app.setAppUserModelId("Bitburner");
+
+  let icon;
+  if (process.platform == "linux") {
+    icon = path.join(__dirname, "icon.png");
+  }
+
+  const tracker = windowTracker("main");
   const window = new BrowserWindow({
+    icon,
     show: false,
     backgroundThrottling: false,
     backgroundColor: "#000000",
+    title: "Bitburner",
+    x: tracker.state.x,
+    y: tracker.state.y,
+    width: tracker.state.width,
+    height: tracker.state.height,
+    minWidth: 600,
+    minHeight: 400,
+    webPreferences: {
+      nativeWindowOpen: true,
+      preload: path.join(__dirname, "preload.js"),
+    },
   });
 
+  setTimeout(() => tracker.track(window), 1000);
+  if (tracker.state.isMaximized) window.maximize();
+
   window.removeMenu();
-  window.maximize();
   noScripts = killall ? { query: { noScripts: killall } } : {};
   window.loadFile("index.html", noScripts);
   window.show();
@@ -29,12 +52,12 @@ async function createWindow(killall) {
 
   window.webContents.on("new-window", async function (e, url) {
     // Let's make sure sure we have a proper url
-    let parsedUrl
+    let parsedUrl;
     try {
       parsedUrl = new URL(url);
     } catch (_) {
       // This is an invalid url, let's just do nothing
-      log.warn(`Invalid url found: ${url}`)
+      log.warn(`Invalid url found: ${url}`);
       e.preventDefault();
       return;
     }
@@ -51,11 +74,13 @@ async function createWindow(killall) {
 
       if (!isChild) {
         // If we're not relative to our app's path let's abort
-        log.warn(`Requested path ${filePath.dir}${path.sep}${filePath.base} is not relative to the app: ${appPath.dir}${path.sep}${appPath.base}`)
+        log.warn(
+          `Requested path ${filePath.dir}${path.sep}${filePath.base} is not relative to the app: ${appPath.dir}${path.sep}${appPath.base}`,
+        );
         e.preventDefault();
       } else if (!fileExists) {
         // If the file does not exist let's abort
-        log.warn(`Requested path ${filePath.dir}${path.sep}${filePath.base} does not exist`)
+        log.warn(`Requested path ${filePath.dir}${path.sep}${filePath.base} does not exist`);
         e.preventDefault();
       }
 
@@ -67,7 +92,7 @@ async function createWindow(killall) {
       let urlToOpen = parsedUrl.toString();
       if (parsedUrl.search) {
         log.log(`Cannot open a path with parameters: ${parsedUrl.search}`);
-        urlToOpen = urlToOpen.replace(parsedUrl.search, '');
+        urlToOpen = urlToOpen.replace(parsedUrl.search, "");
         // It would be possible to launch an URL with parameter using this, but it would mess up the process again...
         // const escapedUri = parsedUrl.href.replace('&', '^&');
         // cp.spawn("cmd.exe", ["/c", "start", escapedUri], { detached: true, stdio: "ignore" });

electron/greenworks.js

@@ -3,215 +3,301 @@
 // found in the LICENSE file.
 
 // The source code can be found in https://github.com/greenheartgames/greenworks
-var fs = require('fs');
+var fs = require("fs");
 
 var greenworks;
 
-if (process.platform == 'darwin') {
-  if (process.arch == 'x64')
-    greenworks = require('./lib/greenworks-osx64');
-  else if (process.arch == 'ia32')
-    greenworks = require('./lib/greenworks-osx32');
-} else if (process.platform == 'win32') {
-  if (process.arch == 'x64')
-    greenworks = require('./lib/greenworks-win64');
-  else if (process.arch == 'ia32')
-    greenworks = require('./lib/greenworks-win32');
-} else if (process.platform == 'linux') {
-  if (process.arch == 'x64')
-    greenworks = require('./lib/greenworks-linux64');
-  else if (process.arch == 'ia32')
-    greenworks = require('./lib/greenworks-linux32');
+if (process.platform == "darwin") {
+  if (process.arch == "x64") greenworks = require("./lib/greenworks-osx64");
+  else if (process.arch == "ia32") greenworks = require("./lib/greenworks-osx32");
+} else if (process.platform == "win32") {
+  if (process.arch == "x64") greenworks = require("./lib/greenworks-win64");
+  else if (process.arch == "ia32") greenworks = require("./lib/greenworks-win32");
+} else if (process.platform == "linux") {
+  if (process.arch == "x64") greenworks = require("./lib/greenworks-linux64");
+  else if (process.arch == "ia32") greenworks = require("./lib/greenworks-linux32");
 }
 
 function error_process(err, error_callback) {
-  if (err && error_callback)
-    error_callback(err);
+  if (err && error_callback) error_callback(err);
 }
 
-greenworks.ugcGetItems = function(options, ugc_matching_type, ugc_query_type,
-    success_callback, error_callback) {
-  if (typeof options !== 'object') {
-    error_callback = success_callback;
-    success_callback = ugc_query_type;
-    ugc_query_type = ugc_matching_type;
-    ugc_matching_type = options;
-    options = {
-      'app_id': greenworks.getAppId(),
-      'page_num': 1
+if (greenworks) {
+  greenworks.ugcGetItems = function (options, ugc_matching_type, ugc_query_type, success_callback, error_callback) {
+    if (typeof options !== "object") {
+      error_callback = success_callback;
+      success_callback = ugc_query_type;
+      ugc_query_type = ugc_matching_type;
+      ugc_matching_type = options;
+      options = {
+        app_id: greenworks.getAppId(),
+        page_num: 1,
+      };
     }
-  }
-  greenworks._ugcGetItems(options, ugc_matching_type, ugc_query_type,
-      success_callback, error_callback);
-}
-
-greenworks.ugcGetUserItems = function(options, ugc_matching_type,
-    ugc_list_sort_order, ugc_list, success_callback, error_callback) {
-  if (typeof options !== 'object') {
-    error_callback = success_callback;
-    success_callback = ugc_list;
-    ugc_list = ugc_list_sort_order;
-    ugc_list_sort_order = ugc_matching_type;
-    ugc_matching_type = options;
-    options = {
-      'app_id': greenworks.getAppId(),
-      'page_num': 1
-    }
-  }
-  greenworks._ugcGetUserItems(options, ugc_matching_type, ugc_list_sort_order,
-      ugc_list, success_callback, error_callback);
-}
-
-greenworks.ugcSynchronizeItems = function (options, sync_dir, success_callback,
-    error_callback) {
-  if (typeof options !== 'object') {
-    error_callback = success_callback;
-    success_callback = sync_dir;
-    sync_dir = options;
-    options = {
-      'app_id': greenworks.getAppId(),
-      'page_num': 1
-    }
-  }
-  greenworks._ugcSynchronizeItems(options, sync_dir, success_callback,
-      error_callback);
-}
-
-greenworks.publishWorkshopFile = function(options, file_path, image_path, title,
-    description, success_callback, error_callback) {
-  if (typeof options !== 'object') {
-    error_callback = success_callback;
-    success_callback = description;
-    description = title;
-    title = image_path;
-    image_path = file_path;
-    file_path = options;
-    options = {
-      'app_id': greenworks.getAppId(),
-      'tags': []
-    }
-  }
-  greenworks._publishWorkshopFile(options, file_path, image_path, title,
-      description, success_callback, error_callback);
-}
-
-greenworks.updatePublishedWorkshopFile = function(options,
-    published_file_handle, file_path, image_path, title, description,
-    success_callback, error_callback) {
-  if (typeof options !== 'object') {
-    error_callback = success_callback;
-    success_callback = description;
-    description = title;
-    title = image_path;
-    image_path = file_path;
-    file_path = published_file_handle;
-    published_file_handle = options;
-    options = {
-      'tags': [] // No tags are set
-    }
-  }
-  greenworks._updatePublishedWorkshopFile(options, published_file_handle,
-     file_path, image_path, title, description, success_callback,
-     error_callback);
-}
-
-// An utility function for publish related APIs.
-// It processes remains steps after saving files to Steam Cloud.
-function file_share_process(file_name, image_name, next_process_func,
-    error_callback, progress_callback) {
-  if (progress_callback)
-    progress_callback("Completed on saving files on Steam Cloud.");
-  greenworks.fileShare(file_name, function() {
-    greenworks.fileShare(image_name, function() {
-      next_process_func();
-    }, function(err) { error_process(err, error_callback); });
-  }, function(err) { error_process(err, error_callback); });
-}
-
-// Publishing user generated content(ugc) to Steam contains following steps:
-// 1. Save file and image to Steam Cloud.
-// 2. Share the file and image.
-// 3. publish the file to workshop.
-greenworks.ugcPublish = function(file_name, title, description, image_name,
-    success_callback, error_callback, progress_callback) {
-  var publish_file_process = function() {
-    if (progress_callback)
-      progress_callback("Completed on sharing files.");
-    greenworks.publishWorkshopFile(file_name, image_name, title, description,
-        function(publish_file_id) { success_callback(publish_file_id); },
-        function(err) { error_process(err, error_callback); });
-  };
-  greenworks.saveFilesToCloud([file_name, image_name], function() {
-    file_share_process(file_name, image_name, publish_file_process,
-        error_callback, progress_callback);
-  }, function(err) { error_process(err, error_callback); });
-}
-
-// Update publish ugc steps:
-// 1. Save new file and image to Steam Cloud.
-// 2. Share file and images.
-// 3. Update published file.
-greenworks.ugcPublishUpdate = function(published_file_id, file_name, title,
-    description, image_name, success_callback, error_callback,
-    progress_callback) {
-  var update_published_file_process = function() {
-    if (progress_callback)
-      progress_callback("Completed on sharing files.");
-    greenworks.updatePublishedWorkshopFile(published_file_id,
-        file_name, image_name, title, description,
-        function() { success_callback(); },
-        function(err) { error_process(err, error_callback); });
+    greenworks._ugcGetItems(options, ugc_matching_type, ugc_query_type, success_callback, error_callback);
   };
 
-  greenworks.saveFilesToCloud([file_name, image_name], function() {
-    file_share_process(file_name, image_name, update_published_file_process,
-        error_callback, progress_callback);
-  }, function(err) { error_process(err, error_callback); });
-}
-
-// Greenworks Utils APIs implmentation.
-greenworks.Utils.move = function(source_dir, target_dir, success_callback,
-    error_callback) {
-  fs.rename(source_dir, target_dir, function(err) {
-    if (err) {
-      if (error_callback) error_callback(err);
-      return;
+  greenworks.ugcGetUserItems = function (
+    options,
+    ugc_matching_type,
+    ugc_list_sort_order,
+    ugc_list,
+    success_callback,
+    error_callback,
+  ) {
+    if (typeof options !== "object") {
+      error_callback = success_callback;
+      success_callback = ugc_list;
+      ugc_list = ugc_list_sort_order;
+      ugc_list_sort_order = ugc_matching_type;
+      ugc_matching_type = options;
+      options = {
+        app_id: greenworks.getAppId(),
+        page_num: 1,
+      };
     }
-    if (success_callback)
-      success_callback();
-  });
-}
+    greenworks._ugcGetUserItems(
+      options,
+      ugc_matching_type,
+      ugc_list_sort_order,
+      ugc_list,
+      success_callback,
+      error_callback,
+    );
+  };
 
-greenworks.init = function() {
-  if (this.initAPI()) return true;
-  if (!this.isSteamRunning())
-    throw new Error("Steam initialization failed. Steam is not running.");
-  var appId;
-  try {
-    appId = fs.readFileSync('steam_appid.txt', 'utf8');
-  } catch (e) {
-    throw new Error("Steam initialization failed. Steam is running," +
-                    "but steam_appid.txt is missing. Expected to find it in: " +
-                    require('path').resolve('steam_appid.txt'));
+  greenworks.ugcSynchronizeItems = function (options, sync_dir, success_callback, error_callback) {
+    if (typeof options !== "object") {
+      error_callback = success_callback;
+      success_callback = sync_dir;
+      sync_dir = options;
+      options = {
+        app_id: greenworks.getAppId(),
+        page_num: 1,
+      };
+    }
+    greenworks._ugcSynchronizeItems(options, sync_dir, success_callback, error_callback);
+  };
+
+  greenworks.publishWorkshopFile = function (
+    options,
+    file_path,
+    image_path,
+    title,
+    description,
+    success_callback,
+    error_callback,
+  ) {
+    if (typeof options !== "object") {
+      error_callback = success_callback;
+      success_callback = description;
+      description = title;
+      title = image_path;
+      image_path = file_path;
+      file_path = options;
+      options = {
+        app_id: greenworks.getAppId(),
+        tags: [],
+      };
+    }
+    greenworks._publishWorkshopFile(
+      options,
+      file_path,
+      image_path,
+      title,
+      description,
+      success_callback,
+      error_callback,
+    );
+  };
+
+  greenworks.updatePublishedWorkshopFile = function (
+    options,
+    published_file_handle,
+    file_path,
+    image_path,
+    title,
+    description,
+    success_callback,
+    error_callback,
+  ) {
+    if (typeof options !== "object") {
+      error_callback = success_callback;
+      success_callback = description;
+      description = title;
+      title = image_path;
+      image_path = file_path;
+      file_path = published_file_handle;
+      published_file_handle = options;
+      options = {
+        tags: [], // No tags are set
+      };
+    }
+    greenworks._updatePublishedWorkshopFile(
+      options,
+      published_file_handle,
+      file_path,
+      image_path,
+      title,
+      description,
+      success_callback,
+      error_callback,
+    );
+  };
+
+  // An utility function for publish related APIs.
+  // It processes remains steps after saving files to Steam Cloud.
+  function file_share_process(file_name, image_name, next_process_func, error_callback, progress_callback) {
+    if (progress_callback) progress_callback("Completed on saving files on Steam Cloud.");
+    greenworks.fileShare(
+      file_name,
+      function () {
+        greenworks.fileShare(
+          image_name,
+          function () {
+            next_process_func();
+          },
+          function (err) {
+            error_process(err, error_callback);
+          },
+        );
+      },
+      function (err) {
+        error_process(err, error_callback);
+      },
+    );
   }
-  if (!/^\d+ *\r?\n?$/.test(appId)) {
-    throw new Error("Steam initialization failed. " +
-                    "steam_appid.txt appears to be invalid; " +
-                    "it should contain a numeric ID: " + appId);
-  }
-  throw new Error("Steam initialization failed, but Steam is running, " +
-                  "and steam_appid.txt is present and valid." +
-                  "Maybe that's not really YOUR app ID? " + appId.trim());
+
+  // Publishing user generated content(ugc) to Steam contains following steps:
+  // 1. Save file and image to Steam Cloud.
+  // 2. Share the file and image.
+  // 3. publish the file to workshop.
+  greenworks.ugcPublish = function (
+    file_name,
+    title,
+    description,
+    image_name,
+    success_callback,
+    error_callback,
+    progress_callback,
+  ) {
+    var publish_file_process = function () {
+      if (progress_callback) progress_callback("Completed on sharing files.");
+      greenworks.publishWorkshopFile(
+        file_name,
+        image_name,
+        title,
+        description,
+        function (publish_file_id) {
+          success_callback(publish_file_id);
+        },
+        function (err) {
+          error_process(err, error_callback);
+        },
+      );
+    };
+    greenworks.saveFilesToCloud(
+      [file_name, image_name],
+      function () {
+        file_share_process(file_name, image_name, publish_file_process, error_callback, progress_callback);
+      },
+      function (err) {
+        error_process(err, error_callback);
+      },
+    );
+  };
+
+  // Update publish ugc steps:
+  // 1. Save new file and image to Steam Cloud.
+  // 2. Share file and images.
+  // 3. Update published file.
+  greenworks.ugcPublishUpdate = function (
+    published_file_id,
+    file_name,
+    title,
+    description,
+    image_name,
+    success_callback,
+    error_callback,
+    progress_callback,
+  ) {
+    var update_published_file_process = function () {
+      if (progress_callback) progress_callback("Completed on sharing files.");
+      greenworks.updatePublishedWorkshopFile(
+        published_file_id,
+        file_name,
+        image_name,
+        title,
+        description,
+        function () {
+          success_callback();
+        },
+        function (err) {
+          error_process(err, error_callback);
+        },
+      );
+    };
+
+    greenworks.saveFilesToCloud(
+      [file_name, image_name],
+      function () {
+        file_share_process(file_name, image_name, update_published_file_process, error_callback, progress_callback);
+      },
+      function (err) {
+        error_process(err, error_callback);
+      },
+    );
+  };
+
+  // Greenworks Utils APIs implmentation.
+  greenworks.Utils.move = function (source_dir, target_dir, success_callback, error_callback) {
+    fs.rename(source_dir, target_dir, function (err) {
+      if (err) {
+        if (error_callback) error_callback(err);
+        return;
+      }
+      if (success_callback) success_callback();
+    });
+  };
+
+  greenworks.init = function () {
+    if (this.initAPI()) return true;
+    if (!this.isSteamRunning()) throw new Error("Steam initialization failed. Steam is not running.");
+    var appId;
+    try {
+      appId = fs.readFileSync("steam_appid.txt", "utf8");
+    } catch (e) {
+      throw new Error(
+        "Steam initialization failed. Steam is running," +
+          "but steam_appid.txt is missing. Expected to find it in: " +
+          require("path").resolve("steam_appid.txt"),
+      );
+    }
+    if (!/^\d+ *\r?\n?$/.test(appId)) {
+      throw new Error(
+        "Steam initialization failed. " +
+          "steam_appid.txt appears to be invalid; " +
+          "it should contain a numeric ID: " +
+          appId,
+      );
+    }
+    throw new Error(
+      "Steam initialization failed, but Steam is running, " +
+        "and steam_appid.txt is present and valid." +
+        "Maybe that's not really YOUR app ID? " +
+        appId.trim(),
+    );
+  };
+
+  var EventEmitter = require("events").EventEmitter;
+  greenworks.__proto__ = EventEmitter.prototype;
+  EventEmitter.call(greenworks);
+
+  greenworks._steam_events.on = function () {
+    greenworks.emit.apply(greenworks, arguments);
+  };
+
+  process.versions["greenworks"] = greenworks._version;
 }
 
-var EventEmitter = require('events').EventEmitter;
-greenworks.__proto__ = EventEmitter.prototype;
-EventEmitter.call(greenworks);
-
-greenworks._steam_events.on = function () {
-  greenworks.emit.apply(greenworks, arguments);
-};
-
-process.versions['greenworks'] = greenworks._version;
-
 module.exports = greenworks;

electron/main.js

@@ -1,24 +1,31 @@
 /* eslint-disable no-process-exit */
 /* eslint-disable @typescript-eslint/no-var-requires */
-const { app, dialog, BrowserWindow } = require("electron");
+const { app, dialog, BrowserWindow, ipcMain } = require("electron");
 const log = require("electron-log");
 const greenworks = require("./greenworks");
 const api = require("./api-server");
 const gameWindow = require("./gameWindow");
 const achievements = require("./achievements");
 const utils = require("./utils");
+const storage = require("./storage");
+const debounce = require("lodash/debounce");
+const Config = require("electron-config");
+const config = new Config();
+
+log.transports.file.level = config.get("file-log-level", "info");
+log.transports.console.level = config.get("console-log-level", "debug");
 
 log.catchErrors();
 log.info(`Started app: ${JSON.stringify(process.argv)}`);
 
-process.on('uncaughtException', function () {
+process.on("uncaughtException", function () {
   // The exception will already have been logged by electron-log
   process.exit(1);
 });
 
 // We want to fail gracefully if we cannot connect to Steam
 try {
-  if (greenworks.init()) {
+  if (greenworks && greenworks.init()) {
     log.info("Steam API has been initialized.");
   } else {
     const error = "Steam API has failed to initialize.";
@@ -30,6 +37,8 @@ try {
   global.greenworksError = ex.message;
 }
 
+let isRestoreDisabled = false;
+
 function setStopProcessHandler(app, window, enabled) {
   const closingWindowHandler = async (e) => {
     // We need to prevent the default closing event to add custom logic
@@ -41,76 +50,182 @@ function setStopProcessHandler(app, window, enabled) {
     // Shutdown the http server
     api.disable();
 
+    // Trigger debounced saves right now before closing
+    try {
+      await saveToDisk.flush();
+    } catch (error) {
+      log.error(error);
+    }
+    try {
+      await saveToCloud.flush();
+    } catch (error) {
+      log.error(error);
+    }
+
     // Because of a steam limitation, if the player has launched an external browser,
     // steam will keep displaying the game as "Running" in their UI as long as the browser is up.
     // So we'll alert the player to close their browser.
     if (global.app_playerOpenedExternalLink) {
       await dialog.showMessageBox({
-        title: 'Bitburner',
-        message: 'You may have to close your browser to properly exit the game.',
-        detail: 'Steam will keep tracking Bitburner as "Running" if any process started within the game is still running.' +
-          ' This includes launching an external link, which opens up your browser.',
-        type: 'warning', buttons: ['OK']
+        title: "Bitburner",
+        message: "You may have to close your browser to properly exit the game.",
+        detail:
+          'Steam will keep tracking Bitburner as "Running" if any process started within the game is still running.' +
+          " This includes launching an external link, which opens up your browser.",
+        type: "warning",
+        buttons: ["OK"],
       });
     }
     // We'll try to execute javascript on the page to see if we're stuck
     let canRunJS = false;
-    window.webContents.executeJavaScript('window.stop(); document.close()', true)
-      .then(() => canRunJS = true);
+    window.webContents.executeJavaScript("window.stop(); document.close()", true).then(() => (canRunJS = true));
     setTimeout(() => {
       // Wait a few milliseconds to prevent a race condition before loading the exit screen
       window.webContents.stop();
-      window.loadFile("exit.html")
+      window.loadFile("exit.html");
     }, 20);
 
     // Wait 200ms, if the promise has not yet resolved, let's crash the process since we're possibly in a stuck scenario
     setTimeout(() => {
       if (!canRunJS) {
         // We're stuck, let's crash the process
-        log.warn('Forcefully crashing the renderer process');
+        log.warn("Forcefully crashing the renderer process");
         window.webContents.forcefullyCrashRenderer();
       }
 
-      log.debug('Destroying the window');
+      log.debug("Destroying the window");
       window.destroy();
     }, 200);
-  }
+  };
 
   const clearWindowHandler = () => {
     window = null;
   };
 
   const stopProcessHandler = () => {
-    log.info('Quitting the app...');
+    log.info("Quitting the app...");
     app.isQuiting = true;
     app.quit();
     process.exit(0);
   };
 
+  const receivedGameReadyHandler = async (event, arg) => {
+    if (!window) {
+      log.warn("Window was undefined in game info handler");
+      return;
+    }
+
+    log.debug("Received game information", arg);
+    window.gameInfo = { ...arg };
+    await storage.prepareSaveFolders(window);
+
+    const restoreNewest = config.get("onload-restore-newest", true);
+    if (restoreNewest && !isRestoreDisabled) {
+      try {
+        await storage.restoreIfNewerExists(window);
+      } catch (error) {
+        log.error("Could not restore newer file", error);
+      }
+    }
+  };
+
+  const receivedDisableRestoreHandler = async (event, arg) => {
+    if (!window) {
+      log.warn("Window was undefined in disable import handler");
+      return;
+    }
+
+    log.debug(`Disabling auto-restore for ${arg.duration}ms.`);
+    isRestoreDisabled = true;
+    setTimeout(() => {
+      isRestoreDisabled = false;
+      log.debug("Re-enabling auto-restore");
+    }, arg.duration);
+  };
+
+  const receivedGameSavedHandler = async (event, arg) => {
+    if (!window) {
+      log.warn("Window was undefined in game saved handler");
+      return;
+    }
+
+    const { save, ...other } = arg;
+    log.silly("Received game saved info", { ...other, save: `${save.length} bytes` });
+
+    if (storage.isAutosaveEnabled()) {
+      saveToDisk(save, arg.fileName);
+    }
+    if (storage.isCloudEnabled()) {
+      const minimumPlaytime = 1000 * 60 * 15;
+      const playtime = window.gameInfo.player.playtime;
+      log.silly(window.gameInfo);
+      if (playtime > minimumPlaytime) {
+        saveToCloud(save);
+      } else {
+        log.debug(`Auto-save to cloud disabled for save game under ${minimumPlaytime}ms (${playtime}ms)`);
+      }
+    }
+  };
+
+  const saveToCloud = debounce(
+    async (save) => {
+      log.debug("Saving to Steam Cloud ...");
+      try {
+        const playerId = window.gameInfo.player.identifier;
+        await storage.pushGameSaveToSteamCloud(save, playerId);
+        log.silly("Saved Game to Steam Cloud");
+      } catch (error) {
+        log.error(error);
+        utils.writeToast(window, "Could not save to Steam Cloud.", "error", 5000);
+      }
+    },
+    config.get("cloud-save-min-time", 1000 * 60 * 15),
+    { leading: true },
+  );
+
+  const saveToDisk = debounce(
+    async (save, fileName) => {
+      log.debug("Saving to Disk ...");
+      try {
+        const file = await storage.saveGameToDisk(window, { save, fileName });
+        log.silly(`Saved Game to '${file.replaceAll("\\", "\\\\")}'`);
+      } catch (error) {
+        log.error(error);
+        utils.writeToast(window, "Could not save to disk", "error", 5000);
+      }
+    },
+    config.get("disk-save-min-time", 1000 * 60 * 5),
+    { leading: true },
+  );
+
   if (enabled) {
-    log.debug('Adding closing handlers');
+    log.debug("Adding closing handlers");
+    ipcMain.on("push-game-ready", receivedGameReadyHandler);
+    ipcMain.on("push-game-saved", receivedGameSavedHandler);
+    ipcMain.on("push-disable-restore", receivedDisableRestoreHandler);
     window.on("closed", clearWindowHandler);
-    window.on("close", closingWindowHandler)
+    window.on("close", closingWindowHandler);
     app.on("window-all-closed", stopProcessHandler);
   } else {
-    log.debug('Removing closing handlers');
+    log.debug("Removing closing handlers");
+    ipcMain.removeAllListeners();
     window.removeListener("closed", clearWindowHandler);
     window.removeListener("close", closingWindowHandler);
     app.removeListener("window-all-closed", stopProcessHandler);
   }
 }
 
-function startWindow(noScript) {
-  gameWindow.createWindow(noScript);
+async function startWindow(noScript) {
+  return gameWindow.createWindow(noScript);
 }
 
 global.app_handlers = {
   stopProcess: setStopProcessHandler,
   createWindow: startWindow,
-}
+};
 
 app.whenReady().then(async () => {
-  log.info('Application is ready!');
+  log.info("Application is ready!");
 
   if (process.argv.includes("--export-save")) {
     const window = new BrowserWindow({ show: false });
@@ -119,15 +234,15 @@ app.whenReady().then(async () => {
     setStopProcessHandler(app, window, true);
     await utils.exportSave(window);
   } else {
-    startWindow(process.argv.includes("--no-scripts"));
-  }
-
-  if (global.greenworksError) {
-    dialog.showMessageBox({
-      title: 'Bitburner',
-      message: 'Could not connect to Steam',
-      detail: `${global.greenworksError}\n\nYou won't be able to receive achievements until this is resolved and you restart the game.`,
-      type: 'warning', buttons: ['OK']
-    });
+    const window = await startWindow(process.argv.includes("--no-scripts"));
+    if (global.greenworksError) {
+      await dialog.showMessageBox(window, {
+        title: "Bitburner",
+        message: "Could not connect to Steam",
+        detail: `${global.greenworksError}\n\nYou won't be able to receive achievements until this is resolved and you restart the game.`,
+        type: "warning",
+        buttons: ["OK"],
+      });
+    }
   }
 });

electron/menu.js

@@ -1,11 +1,206 @@
 /* eslint-disable @typescript-eslint/no-var-requires */
-const { Menu, clipboard, dialog } = require("electron");
+const { app, Menu, clipboard, dialog, shell } = require("electron");
 const log = require("electron-log");
+const Config = require("electron-config");
 const api = require("./api-server");
 const utils = require("./utils");
+const storage = require("./storage");
+const config = new Config();
 
 function getMenu(window) {
+  const canZoomIn = utils.getZoomFactor() <= 2;
+  const zoomIn = () => {
+    const currentZoom = utils.getZoomFactor();
+    const newZoom = currentZoom + 0.1;
+    if (newZoom <= 2.0) {
+      utils.setZoomFactor(window, newZoom);
+      refreshMenu(window);
+    } else {
+      log.log("Max zoom out");
+      utils.writeToast(window, "Cannot zoom in anymore", "warning");
+    }
+  };
+
+  const canZoomOut = utils.getZoomFactor() >= 0.5;
+  const zoomOut = () => {
+    const currentZoom = utils.getZoomFactor();
+    const newZoom = currentZoom - 0.1;
+    if (newZoom >= 0.5) {
+      utils.setZoomFactor(window, newZoom);
+      refreshMenu(window);
+    } else {
+      log.log("Max zoom in");
+      utils.writeToast(window, "Cannot zoom out anymore", "warning");
+    }
+  };
+
+  const canResetZoom = utils.getZoomFactor() !== 1;
+  const resetZoom = () => {
+    utils.setZoomFactor(window, 1);
+    refreshMenu(window);
+    log.log("Reset zoom");
+  };
+
   return Menu.buildFromTemplate([
+    {
+      label: "File",
+      submenu: [
+        {
+          label: "Save Game",
+          click: () => window.webContents.send("trigger-save"),
+        },
+        {
+          label: "Export Save",
+          click: () => window.webContents.send("trigger-game-export"),
+        },
+        {
+          label: "Export Scripts",
+          click: async () => window.webContents.send("trigger-scripts-export"),
+        },
+        {
+          type: "separator",
+        },
+        {
+          label: "Load Last Save",
+          click: async () => {
+            try {
+              const saveGame = await storage.loadLastFromDisk(window);
+              window.webContents.send("push-save-request", { save: saveGame });
+            } catch (error) {
+              log.error(error);
+              utils.writeToast(window, "Could not load last save from disk", "error", 5000);
+            }
+          },
+        },
+        {
+          label: "Load From File",
+          click: async () => {
+            const defaultPath = await storage.getSaveFolder(window);
+            const result = await dialog.showOpenDialog(window, {
+              title: "Load From File",
+              defaultPath: defaultPath,
+              buttonLabel: "Load",
+              filters: [
+                { name: "Game Saves", extensions: ["json", "json.gz", "txt"] },
+                { name: "All", extensions: ["*"] },
+              ],
+              properties: ["openFile", "dontAddToRecent"],
+            });
+            if (result.canceled) return;
+            const file = result.filePaths[0];
+
+            try {
+              const saveGame = await storage.loadFileFromDisk(file);
+              window.webContents.send("push-save-request", { save: saveGame });
+            } catch (error) {
+              log.error(error);
+              utils.writeToast(window, "Could not load save from disk", "error", 5000);
+            }
+          },
+        },
+        {
+          label: "Load From Steam Cloud",
+          enabled: storage.isCloudEnabled(),
+          click: async () => {
+            try {
+              const saveGame = await storage.getSteamCloudSaveString();
+              await storage.pushSaveGameForImport(window, saveGame, false);
+            } catch (error) {
+              log.error(error);
+              utils.writeToast(window, "Could not load from Steam Cloud", "error", 5000);
+            }
+          },
+        },
+        {
+          type: "separator",
+        },
+        {
+          label: "Compress Disk Saves (.gz)",
+          type: "checkbox",
+          checked: storage.isSaveCompressionEnabled(),
+          click: (menuItem) => {
+            storage.setSaveCompressionConfig(menuItem.checked);
+            utils.writeToast(window, `${menuItem.checked ? "Enabled" : "Disabled"} Save Compression`, "info", 5000);
+            refreshMenu(window);
+          },
+        },
+        {
+          label: "Auto-Save to Disk",
+          type: "checkbox",
+          checked: storage.isAutosaveEnabled(),
+          click: (menuItem) => {
+            storage.setAutosaveConfig(menuItem.checked);
+            utils.writeToast(window, `${menuItem.checked ? "Enabled" : "Disabled"} Auto-Save to Disk`, "info", 5000);
+            refreshMenu(window);
+          },
+        },
+        {
+          label: "Auto-Save to Steam Cloud",
+          type: "checkbox",
+          enabled: !global.greenworksError,
+          checked: storage.isCloudEnabled(),
+          click: (menuItem) => {
+            storage.setCloudEnabledConfig(menuItem.checked);
+            utils.writeToast(
+              window,
+              `${menuItem.checked ? "Enabled" : "Disabled"} Auto-Save to Steam Cloud`,
+              "info",
+              5000,
+            );
+            refreshMenu(window);
+          },
+        },
+        {
+          label: "Restore Newest on Load",
+          type: "checkbox",
+          checked: config.get("onload-restore-newest", true),
+          click: (menuItem) => {
+            config.set("onload-restore-newest", menuItem.checked);
+            utils.writeToast(
+              window,
+              `${menuItem.checked ? "Enabled" : "Disabled"} Restore Newest on Load`,
+              "info",
+              5000,
+            );
+            refreshMenu(window);
+          },
+        },
+        {
+          type: "separator",
+        },
+        {
+          label: "Open Directory",
+          submenu: [
+            {
+              label: "Open Game Directory",
+              click: () => shell.openPath(app.getAppPath()),
+            },
+            {
+              label: "Open Saves Directory",
+              click: async () => {
+                const path = await storage.getSaveFolder(window);
+                shell.openPath(path);
+              },
+            },
+            {
+              label: "Open Logs Directory",
+              click: () => shell.openPath(app.getPath("logs")),
+            },
+            {
+              label: "Open Data Directory",
+              click: () => shell.openPath(app.getPath("userData")),
+            },
+          ],
+        },
+        {
+          type: "separator",
+        },
+        {
+          label: "Quit",
+          click: () => app.quit(),
+        },
+      ],
+    },
     {
       label: "Edit",
       submenu: [
@@ -52,29 +247,29 @@ function getMenu(window) {
       label: "API Server",
       submenu: [
         {
-          label: api.isListening() ? 'Disable Server' : 'Enable Server',
-          click: (async () => {
+          label: api.isListening() ? "Disable Server" : "Enable Server",
+          click: async () => {
             let success = false;
             try {
               await api.toggleServer();
               success = true;
             } catch (error) {
               log.error(error);
-              utils.showErrorBox('Error Toggling Server', error);
+              utils.showErrorBox("Error Toggling Server", error);
             }
             if (success && api.isListening()) {
               utils.writeToast(window, "Started API Server", "success");
             } else if (success && !api.isListening()) {
               utils.writeToast(window, "Stopped API Server", "success");
             } else {
-              utils.writeToast(window, 'Error Toggling Server', "error");
+              utils.writeToast(window, "Error Toggling Server", "error");
             }
             refreshMenu(window);
-          })
+          },
         },
         {
-          label: api.isAutostart() ? 'Disable Autostart' : 'Enable Autostart',
-          click: (async () => {
+          label: api.isAutostart() ? "Disable Autostart" : "Enable Autostart",
+          click: async () => {
             api.toggleAutostart();
             if (api.isAutostart()) {
               utils.writeToast(window, "Enabled API Server Autostart", "success");
@@ -82,77 +277,90 @@ function getMenu(window) {
               utils.writeToast(window, "Disabled API Server Autostart", "success");
             }
             refreshMenu(window);
-          })
+          },
         },
         {
-          label: 'Copy Auth Token',
-          click: (async () => {
+          label: "Copy Auth Token",
+          click: async () => {
             const token = api.getAuthenticationToken();
-            log.log('Wrote authentication token to clipboard');
+            log.log("Wrote authentication token to clipboard");
             clipboard.writeText(token);
             utils.writeToast(window, "Copied Authentication Token to Clipboard", "info");
-          })
+          },
         },
         {
-          type: 'separator',
+          type: "separator",
         },
         {
-          label: 'Information',
+          label: "Information",
           click: () => {
-            dialog.showMessageBox({
-              type: 'info',
-              title: 'Bitburner > API Server Information',
-              message: 'The API Server is used to write script files to your in-game home.',
-              detail: 'There is an official Visual Studio Code extension that makes use of that feature.\n\n' +
-                'It allows you to write your script file in an external IDE and have them pushed over to the game automatically.\n' +
-                'If you want more information, head over to: https://github.com/bitburner-official/bitburner-vscode.',
-                buttons: ['Dismiss', 'Open Extension Link (GitHub)'],
+            dialog
+              .showMessageBox({
+                type: "info",
+                title: "Bitburner > API Server Information",
+                message: "The API Server is used to write script files to your in-game home.",
+                detail:
+                  "There is an official Visual Studio Code extension that makes use of that feature.\n\n" +
+                  "It allows you to write your script file in an external IDE and have them pushed over to the game automatically.\n" +
+                  "If you want more information, head over to: https://github.com/bitburner-official/bitburner-vscode.",
+                buttons: ["Dismiss", "Open Extension Link (GitHub)"],
                 defaultId: 0,
                 cancelId: 0,
                 noLink: true,
-            }).then(({response}) => {
-              if (response === 1) {
-                utils.openExternal('https://github.com/bitburner-official/bitburner-vscode');
-              }
-            });
-          }
-        }
-      ]
+              })
+              .then(({ response }) => {
+                if (response === 1) {
+                  utils.openExternal("https://github.com/bitburner-official/bitburner-vscode");
+                }
+              });
+          },
+        },
+      ],
     },
     {
       label: "Zoom",
       submenu: [
         {
           label: "Zoom In",
-          enabled: utils.getZoomFactor() <= 2,
+          enabled: canZoomIn,
           accelerator: "CommandOrControl+numadd",
-          click: () => {
-            const currentZoom = utils.getZoomFactor();
-            const newZoom = currentZoom + 0.1;
-            if (newZoom <= 2.0) {
-              utils.setZoomFactor(window, newZoom);
-              refreshMenu(window);
-            } else {
-              log.log('Max zoom out')
-              utils.writeToast(window, "Cannot zoom in anymore", "warning");
-            }
-          },
+          click: zoomIn,
+        },
+        {
+          label: "Zoom In (non numpad)",
+          enabled: canZoomIn,
+          visible: false,
+          accelerator: "CommandOrControl+Plus",
+          acceleratorWorksWhenHidden: true,
+          click: zoomIn,
         },
         {
           label: "Zoom Out",
-          enabled: utils.getZoomFactor() >= 0.5,
+          enabled: canZoomOut,
           accelerator: "CommandOrControl+numsub",
-          click: () => {
-            const currentZoom = utils.getZoomFactor();
-            const newZoom = currentZoom - 0.1;
-            if (newZoom >= 0.5) {
-              utils.setZoomFactor(window, newZoom);
-              refreshMenu(window);
-            } else {
-              log.log('Max zoom in')
-              utils.writeToast(window, "Cannot zoom out anymore", "warning");
-            }
-          },
+          click: zoomOut,
+        },
+        {
+          label: "Zoom Out (non numpad)",
+          enabled: canZoomOut,
+          accelerator: "CommandOrControl+-",
+          visible: false,
+          acceleratorWorksWhenHidden: true,
+          click: zoomOut,
+        },
+        {
+          label: "Reset Zoom",
+          enabled: canResetZoom,
+          accelerator: "CommandOrControl+num0",
+          click: resetZoom,
+        },
+        {
+          label: "Reset Zoom (non numpad)",
+          enabled: canResetZoom,
+          accelerator: "CommandOrControl+0",
+          visible: false,
+          acceleratorWorksWhenHidden: true,
+          click: resetZoom,
         },
       ],
     },
@@ -163,6 +371,17 @@ function getMenu(window) {
           label: "Activate",
           click: () => window.webContents.openDevTools(),
         },
+        {
+          label: "Delete Steam Cloud Data",
+          enabled: !global.greenworksError,
+          click: async () => {
+            try {
+              await storage.deleteCloudFile();
+            } catch (error) {
+              log.error(error);
+            }
+          },
+        },
       ],
     },
   ]);
@@ -173,5 +392,6 @@ function refreshMenu(window) {
 }
 
 module.exports = {
-  getMenu, refreshMenu,
-}
+  getMenu,
+  refreshMenu,
+};

electron/package-lock.json

@@ -1,15 +1,16 @@
 {
   "name": "bitburner",
-  "version": "1.0.0",
+  "version": "1.6.4",
   "lockfileVersion": 2,
   "requires": true,
   "packages": {
     "": {
       "name": "bitburner",
-      "version": "1.0.0",
+      "version": "1.6.4",
       "dependencies": {
         "electron-config": "^2.0.0",
-        "electron-log": "^4.4.4"
+        "electron-log": "^4.4.4",
+        "lodash": "^4.17.21"
       }
     },
     "node_modules/conf": {
@@ -104,6 +105,11 @@
         "node": ">=4"
       }
     },
+    "node_modules/lodash": {
+      "version": "4.17.21",
+      "resolved": "https://registry.npmjs.org/lodash/-/lodash-4.17.21.tgz",
+      "integrity": "sha512-v2kDEe57lecTulaDIuNTPy3Ry4gLGJ6Z1O3vE1krgXZNrsQ+LFTGHVxVjcXPs17LhbZVGedAJv8XZ1tvj5FvSg=="
+    },
     "node_modules/make-dir": {
       "version": "1.3.0",
       "resolved": "https://registry.npmjs.org/make-dir/-/make-dir-1.3.0.tgz",
@@ -259,6 +265,11 @@
         "path-exists": "^3.0.0"
       }
     },
+    "lodash": {
+      "version": "4.17.21",
+      "resolved": "https://registry.npmjs.org/lodash/-/lodash-4.17.21.tgz",
+      "integrity": "sha512-v2kDEe57lecTulaDIuNTPy3Ry4gLGJ6Z1O3vE1krgXZNrsQ+LFTGHVxVjcXPs17LhbZVGedAJv8XZ1tvj5FvSg=="
+    },
     "make-dir": {
       "version": "1.3.0",
       "resolved": "https://registry.npmjs.org/make-dir/-/make-dir-1.3.0.tgz",

electron/package.json

@@ -1,6 +1,6 @@
 {
   "name": "bitburner",
-  "version": "1.0.0",
+  "version": "1.6.4",
   "description": "A cyberpunk-themed programming incremental game",
   "main": "main.js",
   "author": "Daniel Xie & Olivier Gagnon",
@@ -16,6 +16,8 @@
     "./dist/**/*",
     "./node_modules/**/*",
     "./public/**/*",
+    "./src/**",
+    "./lib/**,",
     "*.js"
   ],
   "directories": {
@@ -23,6 +25,7 @@
   },
   "dependencies": {
     "electron-config": "^2.0.0",
-    "electron-log": "^4.4.4"
+    "electron-log": "^4.4.4",
+    "lodash": "^4.17.21"
   }
 }

electron/preload.js

@@ -0,0 +1,36 @@
+/* eslint-disable @typescript-eslint/no-var-requires */
+const { ipcRenderer, contextBridge } = require("electron");
+const log = require("electron-log");
+
+contextBridge.exposeInMainWorld("electronBridge", {
+  send: (channel, data) => {
+    log.log("Send on channel " + channel);
+    // whitelist channels
+    let validChannels = [
+      "get-save-data-response",
+      "get-save-info-response",
+      "push-game-saved",
+      "push-game-ready",
+      "push-import-result",
+      "push-disable-restore",
+    ];
+    if (validChannels.includes(channel)) {
+      ipcRenderer.send(channel, data);
+    }
+  },
+  receive: (channel, func) => {
+    log.log("Receive on channel " + channel);
+    let validChannels = [
+      "get-save-data-request",
+      "get-save-info-request",
+      "push-save-request",
+      "trigger-save",
+      "trigger-game-export",
+      "trigger-scripts-export",
+    ];
+    if (validChannels.includes(channel)) {
+      // Deliberately strip event as it includes `sender`
+      ipcRenderer.on(channel, (event, ...args) => func(...args));
+    }
+  },
+});

electron/storage.js

@@ -0,0 +1,403 @@
+/* eslint-disable @typescript-eslint/no-var-requires */
+const { app, ipcMain } = require("electron");
+const zlib = require("zlib");
+const path = require("path");
+const fs = require("fs/promises");
+const { promisify } = require("util");
+const gzip = promisify(zlib.gzip);
+const gunzip = promisify(zlib.gunzip);
+
+const greenworks = require("./greenworks");
+const log = require("electron-log");
+const flatten = require("lodash/flatten");
+const Config = require("electron-config");
+const config = new Config();
+
+// https://stackoverflow.com/a/69418940
+const dirSize = async (directory) => {
+  const files = await fs.readdir(directory);
+  const stats = files.map((file) => fs.stat(path.join(directory, file)));
+  return (await Promise.all(stats)).reduce((accumulator, { size }) => accumulator + size, 0);
+};
+
+const getDirFileStats = async (directory) => {
+  const files = await fs.readdir(directory);
+  const stats = files.map((f) => {
+    const file = path.join(directory, f);
+    return fs.stat(file).then((stat) => ({ file, stat }));
+  });
+  const data = await Promise.all(stats);
+  return data;
+};
+
+const getNewestFile = async (directory) => {
+  const data = await getDirFileStats(directory);
+  return data.sort((a, b) => b.stat.mtime.getTime() - a.stat.mtime.getTime())[0];
+};
+
+const getAllSaves = async (window) => {
+  const rootDirectory = await getSaveFolder(window, true);
+  const data = await fs.readdir(rootDirectory, { withFileTypes: true });
+  const savesPromises = data
+    .filter((e) => e.isDirectory())
+    .map((dir) => path.join(rootDirectory, dir.name))
+    .map((dir) => getDirFileStats(dir));
+  const saves = await Promise.all(savesPromises);
+  const flat = flatten(saves);
+  return flat;
+};
+
+async function prepareSaveFolders(window) {
+  const rootFolder = await getSaveFolder(window, true);
+  const currentFolder = await getSaveFolder(window);
+  const backupsFolder = path.join(rootFolder, "/_backups");
+  await prepareFolders(rootFolder, currentFolder, backupsFolder);
+}
+
+async function prepareFolders(...folders) {
+  for (const folder of folders) {
+    try {
+      // Making sure the folder exists
+      // eslint-disable-next-line no-await-in-loop
+      await fs.stat(folder);
+    } catch (error) {
+      if (error.code === "ENOENT") {
+        log.warn(`'${folder}' not found, creating it...`);
+        // eslint-disable-next-line no-await-in-loop
+        await fs.mkdir(folder);
+      } else {
+        log.error(error);
+      }
+    }
+  }
+}
+
+async function getFolderSizeInBytes(saveFolder) {
+  try {
+    return await dirSize(saveFolder);
+  } catch (error) {
+    log.error(error);
+  }
+}
+
+function setAutosaveConfig(value) {
+  config.set("autosave-enabled", value);
+}
+
+function isAutosaveEnabled() {
+  return config.get("autosave-enabled", true);
+}
+
+function setSaveCompressionConfig(value) {
+  config.set("save-compression-enabled", value);
+}
+
+function isSaveCompressionEnabled() {
+  return config.get("save-compression-enabled", true);
+}
+
+function setCloudEnabledConfig(value) {
+  config.set("cloud-enabled", value);
+}
+
+async function getSaveFolder(window, root = false) {
+  if (root) return path.join(app.getPath("userData"), "/saves");
+  const identifier = window.gameInfo?.player?.identifier ?? "";
+  return path.join(app.getPath("userData"), "/saves", `/${identifier}`);
+}
+
+function isCloudEnabled() {
+  // If the Steam API could not be initialized on game start, we'll abort this.
+  if (global.greenworksError) return false;
+
+  // If the user disables it in Steam there's nothing we can do
+  if (!greenworks.isCloudEnabledForUser()) return false;
+
+  // Let's check the config file to see if it's been overriden
+  const enabledInConf = config.get("cloud-enabled", true);
+  if (!enabledInConf) return false;
+
+  const isAppEnabled = greenworks.isCloudEnabled();
+  if (!isAppEnabled) greenworks.enableCloud(true);
+
+  return true;
+}
+
+function saveCloudFile(name, content) {
+  return new Promise((resolve, reject) => {
+    greenworks.saveTextToFile(name, content, resolve, reject);
+  });
+}
+
+function getFirstCloudFile() {
+  const nbFiles = greenworks.getFileCount();
+  if (nbFiles === 0) throw new Error("No files in cloud");
+  const file = greenworks.getFileNameAndSize(0);
+  log.silly(`Found ${nbFiles} files.`);
+  log.silly(`First File: ${file.name} (${file.size} bytes)`);
+  return file.name;
+}
+
+function getCloudFile() {
+  const file = getFirstCloudFile();
+  return new Promise((resolve, reject) => {
+    greenworks.readTextFromFile(file, resolve, reject);
+  });
+}
+
+function deleteCloudFile() {
+  const file = getFirstCloudFile();
+  return new Promise((resolve, reject) => {
+    greenworks.deleteFile(file, resolve, reject);
+  });
+}
+
+async function getSteamCloudQuota() {
+  return new Promise((resolve, reject) => {
+    greenworks.getCloudQuota(resolve, reject);
+  });
+}
+
+async function backupSteamDataToDisk(currentPlayerId) {
+  const nbFiles = greenworks.getFileCount();
+  if (nbFiles === 0) return;
+
+  const file = greenworks.getFileNameAndSize(0);
+  const previousPlayerId = file.name.replace(".json.gz", "");
+  if (previousPlayerId !== currentPlayerId) {
+    const backupSave = await getSteamCloudSaveString();
+    const backupFile = path.join(app.getPath("userData"), "/saves/_backups", `${previousPlayerId}.json.gz`);
+    const buffer = Buffer.from(backupSave, "base64").toString("utf8");
+    saveContent = await gzip(buffer);
+    await fs.writeFile(backupFile, saveContent, "utf8");
+    log.debug(`Saved backup game to '${backupFile}`);
+  }
+}
+
+async function pushGameSaveToSteamCloud(base64save, currentPlayerId) {
+  if (!isCloudEnabled) return Promise.reject("Steam Cloud is not Enabled");
+
+  try {
+    backupSteamDataToDisk(currentPlayerId);
+  } catch (error) {
+    log.error(error);
+  }
+
+  const steamSaveName = `${currentPlayerId}.json.gz`;
+
+  // Let's decode the base64 string so GZIP is more efficient.
+  const buffer = Buffer.from(base64save, "base64");
+  const compressedBuffer = await gzip(buffer);
+  // We can't use utf8 for some reason, steamworks is unhappy.
+  const content = compressedBuffer.toString("base64");
+  log.debug(`Uncompressed: ${base64save.length} bytes`);
+  log.debug(`Compressed: ${content.length} bytes`);
+  log.debug(`Saving to Steam Cloud as ${steamSaveName}`);
+
+  try {
+    await saveCloudFile(steamSaveName, content);
+  } catch (error) {
+    log.error(error);
+  }
+}
+
+async function getSteamCloudSaveString() {
+  if (!isCloudEnabled()) return Promise.reject("Steam Cloud is not Enabled");
+  log.debug(`Fetching Save in Steam Cloud`);
+  const cloudString = await getCloudFile();
+  const gzippedBase64Buffer = Buffer.from(cloudString, "base64");
+  const uncompressedBuffer = await gunzip(gzippedBase64Buffer);
+  const content = uncompressedBuffer.toString("base64");
+  log.debug(`Compressed: ${cloudString.length} bytes`);
+  log.debug(`Uncompressed: ${content.length} bytes`);
+  return content;
+}
+
+async function saveGameToDisk(window, saveData) {
+  const currentFolder = await getSaveFolder(window);
+  let saveFolderSizeBytes = await getFolderSizeInBytes(currentFolder);
+  const maxFolderSizeBytes = config.get("autosave-quota", 1e8); // 100Mb per playerIndentifier
+  const remainingSpaceBytes = maxFolderSizeBytes - saveFolderSizeBytes;
+  log.debug(`Folder Usage: ${saveFolderSizeBytes} bytes`);
+  log.debug(`Folder Capacity: ${maxFolderSizeBytes} bytes`);
+  log.debug(
+    `Remaining: ${remainingSpaceBytes} bytes (${((saveFolderSizeBytes / maxFolderSizeBytes) * 100).toFixed(2)}% used)`,
+  );
+  const shouldCompress = isSaveCompressionEnabled();
+  const fileName = saveData.fileName;
+  const file = path.join(currentFolder, fileName + (shouldCompress ? ".gz" : ""));
+  try {
+    let saveContent = saveData.save;
+    if (shouldCompress) {
+      // Let's decode the base64 string so GZIP is more efficient.
+      const buffer = Buffer.from(saveContent, "base64").toString("utf8");
+      saveContent = await gzip(buffer);
+    }
+    await fs.writeFile(file, saveContent, "utf8");
+    log.debug(`Saved Game to '${file}'`);
+    log.debug(`Save Size: ${saveContent.length} bytes`);
+  } catch (error) {
+    log.error(error);
+  }
+
+  const fileStats = await getDirFileStats(currentFolder);
+  const oldestFiles = fileStats
+    .sort((a, b) => a.stat.mtime.getTime() - b.stat.mtime.getTime())
+    .map((f) => f.file)
+    .filter((f) => f !== file);
+
+  while (saveFolderSizeBytes > maxFolderSizeBytes && oldestFiles.length > 0) {
+    const fileToRemove = oldestFiles.shift();
+    log.debug(`Over Quota -> Removing "${fileToRemove}"`);
+    try {
+      // eslint-disable-next-line no-await-in-loop
+      await fs.unlink(fileToRemove);
+    } catch (error) {
+      log.error(error);
+    }
+
+    // eslint-disable-next-line no-await-in-loop
+    saveFolderSizeBytes = await getFolderSizeInBytes(currentFolder);
+    log.debug(`Save Folder: ${saveFolderSizeBytes} bytes`);
+    log.debug(
+      `Remaining: ${maxFolderSizeBytes - saveFolderSizeBytes} bytes (${(
+        (saveFolderSizeBytes / maxFolderSizeBytes) *
+        100
+      ).toFixed(2)}% used)`,
+    );
+  }
+
+  return file;
+}
+
+async function loadLastFromDisk(window) {
+  const folder = await getSaveFolder(window);
+  const last = await getNewestFile(folder);
+  log.debug(`Last modified file: "${last.file}" (${last.stat.mtime.toLocaleString()})`);
+  return loadFileFromDisk(last.file);
+}
+
+async function loadFileFromDisk(path) {
+  const buffer = await fs.readFile(path);
+  let content;
+  if (path.endsWith(".gz")) {
+    const uncompressedBuffer = await gunzip(buffer);
+    content = uncompressedBuffer.toString("base64");
+    log.debug(`Uncompressed file content (new size: ${content.length} bytes)`);
+  } else {
+    content = buffer.toString("utf8");
+    log.debug(`Loaded file with ${content.length} bytes`);
+  }
+  return content;
+}
+
+function getSaveInformation(window, save) {
+  return new Promise((resolve) => {
+    ipcMain.once("get-save-info-response", async (event, data) => {
+      resolve(data);
+    });
+    window.webContents.send("get-save-info-request", save);
+  });
+}
+
+function getCurrentSave(window) {
+  return new Promise((resolve) => {
+    ipcMain.once("get-save-data-response", (event, data) => {
+      resolve(data);
+    });
+    window.webContents.send("get-save-data-request");
+  });
+}
+
+function pushSaveGameForImport(window, save, automatic) {
+  ipcMain.once("push-import-result", async (event, arg) => {
+    log.debug(`Was save imported? ${arg.wasImported ? "Yes" : "No"}`);
+  });
+  window.webContents.send("push-save-request", { save, automatic });
+}
+
+async function restoreIfNewerExists(window) {
+  const currentSave = await getCurrentSave(window);
+  const currentData = await getSaveInformation(window, currentSave.save);
+  const steam = {};
+  const disk = {};
+
+  try {
+    steam.save = await getSteamCloudSaveString();
+    steam.data = await getSaveInformation(window, steam.save);
+  } catch (error) {
+    log.error("Could not retrieve steam file");
+    log.debug(error);
+  }
+
+  try {
+    const saves = (await getAllSaves()).sort((a, b) => b.stat.mtime.getTime() - a.stat.mtime.getTime());
+    if (saves.length > 0) {
+      disk.save = await loadFileFromDisk(saves[0].file);
+      disk.data = await getSaveInformation(window, disk.save);
+    }
+  } catch (error) {
+    log.error("Could not retrieve disk file");
+    log.debug(error);
+  }
+
+  const lowPlaytime = 1000 * 60 * 15;
+  let bestMatch;
+  if (!steam.data && !disk.data) {
+    log.info("No data to import");
+  } else if (!steam.data) {
+    // We'll just compare using the lastSave field for now.
+    log.debug("Best potential save match: Disk");
+    bestMatch = disk;
+  } else if (!disk.data) {
+    log.debug("Best potential save match: Steam Cloud");
+    bestMatch = steam;
+  } else if (steam.data.lastSave >= disk.data.lastSave || steam.data.playtime + lowPlaytime > disk.data.playtime) {
+    // We want to prioritze steam data if the playtime is very close
+    log.debug("Best potential save match: Steam Cloud");
+    bestMatch = steam;
+  } else {
+    log.debug("Best potential save match: disk");
+    bestMatch = disk;
+  }
+  if (bestMatch) {
+    if (bestMatch.data.lastSave > currentData.lastSave + 5000) {
+      // We add a few seconds to the currentSave's lastSave to prioritize it
+      log.info("Found newer data than the current's save file");
+      log.silly(bestMatch.data);
+      await pushSaveGameForImport(window, bestMatch.save, true);
+      return true;
+    } else if (bestMatch.data.playtime > currentData.playtime && currentData.playtime < lowPlaytime) {
+      log.info("Found older save, but with more playtime, and current less than 15 mins played");
+      log.silly(bestMatch.data);
+      await pushSaveGameForImport(window, bestMatch.save, true);
+      return true;
+    } else {
+      log.debug("Current save data is the freshest");
+      return false;
+    }
+  }
+}
+
+module.exports = {
+  getCurrentSave,
+  getSaveInformation,
+  restoreIfNewerExists,
+  pushSaveGameForImport,
+  pushGameSaveToSteamCloud,
+  getSteamCloudSaveString,
+  getSteamCloudQuota,
+  deleteCloudFile,
+  saveGameToDisk,
+  loadLastFromDisk,
+  loadFileFromDisk,
+  getSaveFolder,
+  prepareSaveFolders,
+  getAllSaves,
+  isCloudEnabled,
+  setCloudEnabledConfig,
+  isAutosaveEnabled,
+  setAutosaveConfig,
+  isSaveCompressionEnabled,
+  setSaveCompressionConfig,
+};

electron/utils.js

@@ -9,61 +9,61 @@ const Config = require("electron-config");
 const config = new Config();
 
 function reloadAndKill(window, killScripts) {
-  const setStopProcessHandler = global.app_handlers.stopProcess
+  const setStopProcessHandler = global.app_handlers.stopProcess;
   const createWindowHandler = global.app_handlers.createWindow;
 
-  log.info('Reloading & Killing all scripts...');
+  log.info("Reloading & Killing all scripts...");
   setStopProcessHandler(app, window, false);
 
   achievements.disableAchievementsInterval(window);
   api.disable();
 
   window.webContents.forcefullyCrashRenderer();
-  window.on('closed', () => {
+  window.on("closed", () => {
     // Wait for window to be closed before opening the new one to prevent race conditions
-    log.debug('Opening new window');
+    log.debug("Opening new window");
     createWindowHandler(killScripts);
-  })
+  });
 
   window.close();
 }
 
 function promptForReload(window) {
   detachUnresponsiveAppHandler(window);
-  dialog.showMessageBox({
-    type: 'error',
-    title: 'Bitburner > Application Unresponsive',
-    message: 'The application is unresponsive, possibly due to an infinite loop in your scripts.',
-    detail:' Did you forget a ns.sleep(x)?\n\n' +
-      'The application will be restarted for you, do you want to kill all running scripts?',
-    buttons: ['Restart', 'Cancel'],
-    defaultId: 0,
-    checkboxLabel: 'Kill all running scripts',
-    checkboxChecked: true,
-    noLink: true,
-  }).then(({response, checkboxChecked}) => {
-    if (response === 0) {
-      reloadAndKill(window, checkboxChecked);
-    } else {
-      attachUnresponsiveAppHandler(window);
-    }
-  });
+  dialog
+    .showMessageBox({
+      type: "error",
+      title: "Bitburner > Application Unresponsive",
+      message: "The application is unresponsive, possibly due to an infinite loop in your scripts.",
+      detail:
+        " Did you forget a ns.sleep(x)?\n\n" +
+        "The application will be restarted for you, do you want to kill all running scripts?",
+      buttons: ["Restart", "Cancel"],
+      defaultId: 0,
+      checkboxLabel: "Kill all running scripts",
+      checkboxChecked: true,
+      noLink: true,
+    })
+    .then(({ response, checkboxChecked }) => {
+      if (response === 0) {
+        reloadAndKill(window, checkboxChecked);
+      } else {
+        attachUnresponsiveAppHandler(window);
+      }
+    });
 }
 
 function attachUnresponsiveAppHandler(window) {
   window.unresponsiveHandler = () => promptForReload(window);
-  window.on('unresponsive', window.unresponsiveHandler);
+  window.on("unresponsive", window.unresponsiveHandler);
 }
 
 function detachUnresponsiveAppHandler(window) {
-  window.off('unresponsive', window.unresponsiveHandler);
+  window.off("unresponsive", window.unresponsiveHandler);
 }
 
 function showErrorBox(title, error) {
-  dialog.showErrorBox(
-    title,
-    `${error.name}\n\n${error.message}`
-  );
+  dialog.showErrorBox(title, `${error.name}\n\n${error.message}`);
 }
 
 function exportSaveFromIndexedDb() {
@@ -71,15 +71,15 @@ function exportSaveFromIndexedDb() {
     const dbRequest = indexedDB.open("bitburnerSave");
     dbRequest.onsuccess = () => {
       const db = dbRequest.result;
-      const transaction = db.transaction(['savestring'], "readonly");
-      const store = transaction.objectStore('savestring');
-      const request = store.get('save');
+      const transaction = db.transaction(["savestring"], "readonly");
+      const store = transaction.objectStore("savestring");
+      const request = store.get("save");
       request.onsuccess = () => {
-        const file = new Blob([request.result], {type: 'text/plain'});
+        const file = new Blob([request.result], { type: "text/plain" });
         const a = document.createElement("a");
         const url = URL.createObjectURL(file);
         a.href = url;
-        a.download = 'save.json';
+        a.download = "save.json";
         document.body.appendChild(a);
         a.click();
         setTimeout(function () {
@@ -87,24 +87,21 @@ function exportSaveFromIndexedDb() {
           window.URL.revokeObjectURL(url);
           resolve();
         }, 0);
-      }
-    }
+      };
+    };
   });
 }
 
 async function exportSave(window) {
-  await window.webContents
-    .executeJavaScript(`${exportSaveFromIndexedDb.toString()}; exportSaveFromIndexedDb();`, true);
+  await window.webContents.executeJavaScript(`${exportSaveFromIndexedDb.toString()}; exportSaveFromIndexedDb();`, true);
 }
 
 async function writeTerminal(window, message, type = null) {
-  await window.webContents
-    .executeJavaScript(`window.appNotifier.terminal("${message}", "${type}");`, true)
+  await window.webContents.executeJavaScript(`window.appNotifier.terminal("${message}", "${type}");`, true);
 }
 
 async function writeToast(window, message, type = "info", duration = 2000) {
-  await window.webContents
-    .executeJavaScript(`window.appNotifier.toast("${message}", "${type}", ${duration});`, true)
+  await window.webContents.executeJavaScript(`window.appNotifier.toast("${message}", "${type}", ${duration});`, true);
 }
 
 function openExternal(url) {
@@ -113,7 +110,7 @@ function openExternal(url) {
 }
 
 function getZoomFactor() {
-  const configZoom = config.get('zoom', 1);
+  const configZoom = config.get("zoom", 1);
   return configZoom;
 }
 
@@ -121,14 +118,20 @@ function setZoomFactor(window, zoom = null) {
   if (zoom === null) {
     zoom = 1;
   } else {
-    config.set('zoom', zoom);
+    config.set("zoom", zoom);
   }
   window.webContents.setZoomFactor(zoom);
 }
 
 module.exports = {
-  reloadAndKill, showErrorBox, exportSave,
-  attachUnresponsiveAppHandler, detachUnresponsiveAppHandler,
-  openExternal, writeTerminal, writeToast,
-  getZoomFactor, setZoomFactor,
-}
+  reloadAndKill,
+  showErrorBox,
+  exportSave,
+  attachUnresponsiveAppHandler,
+  detachUnresponsiveAppHandler,
+  openExternal,
+  writeTerminal,
+  writeToast,
+  getZoomFactor,
+  setZoomFactor,
+};

electron/windowTracker.js

@@ -0,0 +1,68 @@
+/* eslint-disable @typescript-eslint/no-var-requires */
+const { screen } = require("electron");
+const log = require("electron-log");
+const debounce = require("lodash/debounce");
+const Config = require("electron-config");
+const config = new Config();
+
+// https://stackoverflow.com/a/68627253
+const windowTracker = (windowName) => {
+  let window, windowState;
+
+  const setBounds = () => {
+    // Restore from appConfig
+    if (config.has(`window.${windowName}`)) {
+      windowState = config.get(`window.${windowName}`);
+      return;
+    }
+
+    const size = screen.getPrimaryDisplay().workAreaSize;
+
+    // Default
+    windowState = {
+      x: undefined,
+      y: undefined,
+      width: size.width,
+      height: size.height,
+      isMaximized: true,
+    };
+  };
+
+  const saveState = debounce(() => {
+    if (!window || window.isDestroyed()) {
+      log.silly(`Saving window state failed because window is not available`);
+      return;
+    }
+
+    if (!windowState.isMaximized) {
+      windowState = window.getBounds();
+    }
+
+    windowState.isMaximized = window.isMaximized();
+    log.silly(`Saving window.${windowName} to configs`);
+    config.set(`window.${windowName}`, windowState);
+    log.silly(windowState);
+  }, 1000);
+
+  const track = (win) => {
+    window = win;
+    ["resize", "move", "close"].forEach((event) => {
+      win.on(event, saveState);
+    });
+  };
+
+  setBounds();
+
+  return {
+    state: {
+      x: windowState.x,
+      y: windowState.y,
+      width: windowState.width,
+      height: windowState.height,
+      isMaximized: windowState.isMaximized,
+    },
+    track,
+  };
+};
+
+module.exports = { windowTracker };

index.html

@@ -72,6 +72,6 @@
     </style>
   <link rel="shortcut icon" href="favicon.ico"></head>
   <body>
-    <div id="root"/>
-  <script type="text/javascript" src="dist/vendor.bundle.js"></script><script type="text/javascript" src="main.bundle.js"></script></body>
+    <div id="root" style="display:flex"/>
+  <script type="text/javascript" src="dist/vendor.bundle.js"></script><script type="text/javascript" src="dist/main.bundle.js"></script></body>
 </html>

jest.config.js

@@ -1,11 +1,14 @@
 module.exports = {
-  setupFiles: ["./jest.setup.js"],
   moduleFileExtensions: ["ts", "tsx", "js", "jsx"],
   transform: {
     "^.+\\.(js|jsx|ts|tsx)$": "babel-jest",
   },
-  testPathIgnorePatterns: [
-    '.cypress', 'node_modules', 'dist',
-  ],
+  testPathIgnorePatterns: [".cypress", "node_modules", "dist"],
   testEnvironment: "jsdom",
+  moduleNameMapper: {
+    "\\.(jpg|jpeg|png|gif|eot|otf|webp|svg|ttf|woff|woff2|mp4|webm|wav|mp3|m4a|aac|oga)$":
+      "<rootDir>/test/__mocks__/fileMock.js",
+    "\\.(css|less)$": "<rootDir>/test/__mocks__/styleMock.js",
+    "\\!!raw-loader!.*$": "<rootDir>/test/__mocks__/rawLoader.js",
+  },
 };

jest.setup.js

@@ -1,2 +0,0 @@
-import "regenerator-runtime/runtime";
-global.$ = require("jquery");