Release 2.6.1 (#1300)

Fixes UI bug described at https://discord.com/channels/415207508303544321/415213413745164318/1240361787564490854

.git_blame_ignore_revs

@@ -0,0 +1,191 @@
+## What is this?
+##   Some git commits contain mostly prettier/lint changes and aren't as valuable when
+##   using `git blame`.  This file contains a list of hashes that identify such commits
+##   in a way that git can use.
+
+## Tell git to use this file with:
+##   git config --local blame.ignoreRevsFile .git_blame_ignore_revs
+
+## This file was created by cleaning up and filtering the output of this command line:
+##   git log --grep "[Pp]rettier"
+
+## All that's really needed here are the actual 40-digit hashes of
+## the commits.  I left the author/date info in as it helped when I
+## was filtering this list to just formatting changes.
+
+4c9ca4990450740785a4dc95a75de53aeac724df
+# Author: omuretsu
+# Date:   Fri Jun 23 10:14:18 2023 -0400
+
+07b1eefe33b16251e0e67ae3231db2059defb1cc
+# Author: omuretsu
+# Date:   Tue Feb 7 21:16:18 2023 -0500
+
+bbe6421b067b0d0b876c42e49dafcbbb6458ef8d
+# Author: borisflagell
+# Date:   Tue Oct 11 15:33:55 2022 +0300
+
+ed0a28d29272ba2d5716618b73d231bca1ad79d1
+# Author: hydroflame
+# Date:   Sun Oct 9 00:22:25 2022 -0400
+
+a1f90d77ce708efb968d7e7ddb804b9862f2f460
+# Author: Snarling
+# Date:   Tue Sep 27 19:58:14 2022 -0400
+
+6be884a9ad42e9920be233302a066dea01766c8e
+# Author: borisflagell
+# Date:   Sat May 28 01:15:05 2022 +0200
+
+51ba358464ce5787ef472531e0bdb2b6b239955e
+# Author: Markus-D-M
+# Date:   Wed May 25 21:27:58 2022 +0200
+
+9091441389182a261438ec16ea17edcf11ab6f39
+# Author: borisflagell
+# Date:   Mon May 23 19:43:46 2022 +0200
+
+5bc1d293ca14f717d967ff4a345fe1ace1ffdd4c
+# Author: borisflagell
+# Date:   Sun May 22 11:59:14 2022 +0200
+
+d44d71712f066518321cefed18e145141ea23818
+# Author: borisflagell
+# Date:   Sun May 22 06:40:32 2022 +0200
+
+bd2d5396a60f31c1bd9837786fb10586cbcc6eda
+# Author: phyzical
+# Date:   Thu Apr 28 19:22:37 2022 +0800
+
+ad4c84be937224297f6745b6df3d433466b047c1
+# Author: borisflagell
+# Date:   Sat Apr 23 15:18:43 2022 +0200
+
+d4f8f2d0354832101f48d60f0b3445cc1f43dd23
+# Author: borisflagell
+# Date:   Sat Apr 23 15:01:24 2022 +0200
+
+a7045a234353de795494c0b3f378808b4a6d32aa
+# Author: borisflagell
+# Date:   Thu Apr 21 19:20:16 2022 +0200
+
+421e7b8c74eb85238ccf45b1a83225a452024058
+# Author: borisflagell
+# Date:   Thu Apr 21 18:51:04 2022 +0200
+
+9850b56711b29c254102ad8694b1610b4d5adc81
+# Author: Snarling
+# Date:   Sun Apr 17 17:23:14 2022 -0400
+
+567fcf8fb63bc469ae61013cca511a76eb6f9086
+# Author: violet
+# Date:   Wed Apr 13 14:42:07 2022 -0500
+
+f6af85a38d8286aec702556f1296565de5a5067f
+# Author: violet
+# Date:   Sun Apr 10 15:57:34 2022 -0500
+
+57f04d3911b5a384c379dcfb2d0bcb18b25c37ea
+# Author: violet
+# Date:   Thu Apr 7 11:45:21 2022 -0500
+
+720e2112c6766b581e43e1f9e712c47300b22dcd
+# Author: violet
+# Date:   Mon Mar 21 14:40:17 2022 -0500
+
+ecffc8655a70e6e3c7bd03ba5723b437d7857dfa
+Merge: 8506dcfed 00d1d294e
+# Author: hydroflame
+# Date:   Sun Mar 20 22:21:00 2022 -0400
+
+901ee92fe97606bd27840900512b0fa760ba428e
+# Author: Olivier Gagnon
+# Date:   Sun Mar 20 22:02:36 2022 -0400
+
+b3f9380ebd3feb3b6ef91873a1c6a3a1ddc56654
+# Author: Billy Vong
+# Date:   Fri Dec 17 12:56:48 2021 -0500
+
+# I *really* didn't want to include this one because it has a few tiny, actual
+# code changes, but it reformats tens of thousands of lines of code.  Argh.
+8f13363466c2e825bbfb7e4b66d853c4805eda61
+# Author: Olivier Gagnon
+# Date:   Mon Oct 11 16:38:50 2021 -0400
+
+66a2adaeb4b12a48fc8fdafe5e5169919f8d46a5
+# Author: Olivier Gagnon
+# Date:   Wed Sep 22 12:56:55 2021 -0400
+
+## Additional changes that should be ignored for blame.
+
+2e7f164b5f251ce457f0d3b9a42cfa0f08ef200e
+# Author: tyasuh.taeragan
+# Date:   Fri Oct 22 16:35:05 2021 -0400
+
+a18bdd6afc77752bded2f0794bf35ad9d6455fa1
+# Author: Olivier Gagnon
+# Date:   Sat Sep 4 19:09:30 2021 -0400
+
+# from a search for "lint"; many more of these had significant code changes than
+# Prettier, so I'm only vetting the largest for inclusion
+
+48f80f25d6fb90edc292481905814c0d5593b5a9
+# Author: Olivier Gagnon
+# Date:   Wed Apr 6 19:30:08 2022 -0400
+
+b0f20c8c8f4859f01cfc79bc3945a8e7272d6592
+# Author: Olivier Gagnon
+# Date:   Sat Sep 25 01:26:03 2021 -0400
+
+d745150c45979ab251b51447a0847e28966346a6
+# Author: Olivier Gagnon
+# Date:   Sat May 1 03:17:31 2021 -0400
+
+3fad5050961a3259b0158763f48016174a2a690e
+# Author: Olivier Gagnon
+# Date:   Thu Apr 29 23:52:56 2021 -0400
+
+#
+# The commits listed below showed up on a search for "[Pp]rettier", but
+# weren't just Prettier/lint changes.
+#
+
+# 6459b1ab483cf66ae1e6e50518424311c6bbbd8b
+# Author: omuretsu
+# Date:   Sat Feb 4 07:42:35 2023 -0500
+
+# 5b4addbb212411aa1de27ba0ee16ebaabedbc6a1
+# Author: borisflagell
+# Date:   Sun May 22 01:08:53 2022 +0200
+
+# 705a56f3bdcb859179144cdafab7eeb8832f7eb9
+# Author: borisflagell
+# Date:   Sat May 7 12:55:56 2022 +0200
+
+# 4fa65322fe770dc3d79cd0301521d230694a1fc7
+# Author: borisflagell
+# Date:   Thu Apr 21 18:37:47 2022 +0200
+
+# 81d1c02fdfe087c3bd0a2a8a2a41c2f82a6fef56
+# Author: hydroflame
+# Date:   Sun Mar 20 22:50:42 2022 -0400
+
+# 4a7fcda86f5d3d05638b4a9f3a61e5937dde52c6
+# Author: hydroflame
+# Date:   Sat Sep 4 19:03:05 2021 -0400
+
+# 7ee2612c17a90a80e5a0a7793a4c81465e212c0c
+# Author: Martin Fournier
+# Date:   Sun Jan 9 11:15:09 2022 -0500
+
+# c59806c87d543c7cc78d1d68af9599d118c0cb2b
+# Author: Martin Fournier
+# Date:   Fri Dec 17 09:54:32 2021 -0500
+
+# 306facc0d10104d543974d5cb01b6ff419c9acb2
+# Author: David Edmondson
+# Date:   Sat Sep 4 22:17:30 2021 -0700
+
+# 1e42f73e2a1b7ac9489a7287c7be99298f412ac0
+# Author: David Edmondson
+# Date:   Sat Sep 4 13:18:08 2021 -0700commit 2e7f164b5f251ce457f0d3b9a42cfa0f08ef200e

.prettierignore

@@ -15,3 +15,5 @@ markdown
 package.json
 package.lock.json
 tsdoc-metadata.json
+
+.git_blame_ignore_revs

FixJSDOMEnvironment.ts

@@ -1,10 +1,13 @@
 import JSDOMEnvironment from "jest-environment-jsdom";
+import { cloneDeep } from "lodash";
 
 // https://github.com/facebook/jest/blob/v29.4.3/website/versioned_docs/version-29.4/Configuration.md#testenvironment-string
 export default class FixJSDOMEnvironment extends JSDOMEnvironment {
   constructor(...args: ConstructorParameters<typeof JSDOMEnvironment>) {
     super(...args);
 
+    // TODO Tests aren't polyfilled.
+    this.global.structuredClone = cloneDeep;
     // FIXME https://github.com/nodejs/node/issues/35889
     // Add missing importActual() function to mirror requireActual(),
     // which lets us work around the ESM bug.

doc/CONTRIBUTING.md

@@ -207,9 +207,17 @@ the following rules:
 - Ensure you have run `npm run lint` to make sure your changes conform to the
   rules enforced across the code base. The command will fail if any of the
   linters find a violation.
+- Ensure you have run `npm run format` to make sure your changes conform to the
+  style guide.
+- Also, ensure you have run `npm run test` to make sure your changes pass
+  the automated tests.
 - Do not check in any bundled files (`dist\*.bundle.js`) or the `index.html`
   in the root of the repository. These will be updated as part of official
   releases.
+- The title of your Pull Request will need to be formatted like
+  `MISC: Reticulated the splines`, where the first word must be capitalised
+  and relate to the kind of change being implemented. Possible examples
+  are UI, BUGFIX, SERVERS, NETSCRIPT... You get the idea.
 
 ## As a Documenter
 

electron/gameWindow.js

@@ -44,6 +44,9 @@ async function createWindow(killall) {
   window.removeMenu();
   noScripts = killall ? { query: { noScripts: killall } } : {};
   window.loadFile("index.html", noScripts);
+  window.once("ready-to-show", () => {
+    utils.setZoomFactor(window, utils.getZoomFactor());
+  });
   window.show();
   if (debug) window.webContents.openDevTools();
 
@@ -60,7 +63,6 @@ async function createWindow(killall) {
 
   achievements.enableAchievementsInterval(window);
   utils.attachUnresponsiveAppHandler(window);
-  utils.setZoomFactor(window);
 
   try {
     await api.initialize(window);

electron/main.js

@@ -1,7 +1,24 @@
 /* eslint-disable no-process-exit */
 /* eslint-disable @typescript-eslint/no-var-requires */
 const { app, dialog, BrowserWindow, ipcMain, protocol } = require("electron");
+
 const log = require("electron-log");
+log.catchErrors();
+
+// This handler must be set ASAP to prevent ghost processes.
+process.on("uncaughtException", function () {
+  // The exception will be logged by electron-log.
+  app.quit();
+  process.exit(1);
+});
+
+// This handler must be set ASAP to prevent ghost processes.
+app.on("window-all-closed", () => {
+  log.info("Quitting the app...");
+  app.quit();
+  process.exit(0);
+});
+
 const greenworks = require("./greenworks");
 const api = require("./api-server");
 const gameWindow = require("./gameWindow");
@@ -17,15 +34,8 @@ const { fileURLToPath } = require("url");
 log.transports.file.level = store.get("file-log-level", "info");
 log.transports.console.level = store.get("console-log-level", "debug");
 
-log.catchErrors();
 log.info(`Started app: ${JSON.stringify(process.argv)}`);
 
-process.on("uncaughtException", function () {
-  // The exception will already have been logged by electron-log
-  app.quit();
-  process.exit(1);
-});
-
 // We want to fail gracefully if we cannot connect to Steam
 try {
   if (greenworks && greenworks.init()) {
@@ -42,13 +52,6 @@ try {
 
 let isRestoreDisabled = false;
 
-// This was moved so that startup errors do not lead to ghost processes
-app.on("window-all-closed", () => {
-  log.info("Quitting the app...");
-  app.quit();
-  process.exit(0);
-});
-
 function setStopProcessHandler(app, window) {
   const closingWindowHandler = async (e) => {
     // We need to prevent the default closing event to add custom logic
@@ -152,7 +155,7 @@ function setStopProcessHandler(app, window) {
       log.debug("Saving to Steam Cloud ...");
       try {
         const playerId = window.gameInfo.player.identifier;
-        await storage.pushGameSaveToSteamCloud(save, playerId);
+        await storage.pushSaveDataToSteamCloud(save, playerId);
         log.silly("Saved Game to Steam Cloud");
       } catch (error) {
         log.error(error);
@@ -203,7 +206,7 @@ app.on("ready", async () => {
     if ((method === "GET" && relativePath.startsWith("dist")) || relativePath.match(/^[a-zA-Z-_]*\.html/)) {
       return callback(filePath);
     }
-    log.error("Tried to access a page outside sandbox.");
+    log.error(`Tried to access a page outside the sandbox. Url: ${url}. Method: ${method}.`);
     callback(path.join(__dirname, "fileError.txt"));
   });
 

electron/menu.js

@@ -103,8 +103,8 @@ function getMenu(window) {
           enabled: storage.isCloudEnabled(),
           click: async () => {
             try {
-              const saveGame = await storage.getSteamCloudSaveString();
-              await storage.pushSaveGameForImport(window, saveGame, false);
+              const saveData = await storage.getSteamCloudSaveData();
+              await storage.pushSaveGameForImport(window, saveData, false);
             } catch (error) {
               log.error(error);
               utils.writeToast(window, "Could not load from Steam Cloud", "error", 5000);
@@ -114,16 +114,6 @@ function getMenu(window) {
         {
           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",
@@ -222,7 +212,7 @@ function getMenu(window) {
           click: () => window.loadFile("index.html"),
         },
         {
-          label: "Reload & Kill All Scripts",
+          label: "Reload && Kill All Scripts",
           click: () => utils.reloadAndKill(window, true),
         },
       ],

electron/package-lock.json

@@ -1,12 +1,12 @@
 {
   "name": "bitburner",
-  "version": "2.5.1",
+  "version": "2.6.1",
   "lockfileVersion": 3,
   "requires": true,
   "packages": {
     "": {
       "name": "bitburner",
-      "version": "2.5.1",
+      "version": "2.6.1",
       "dependencies": {
         "electron-log": "^4.4.8",
         "electron-store": "^8.1.0",

electron/package.json

@@ -1,9 +1,9 @@
 {
   "name": "bitburner",
-  "version": "2.5.1",
+  "version": "2.6.1",
   "description": "A cyberpunk-themed programming incremental game",
   "main": "main.js",
-  "author": "Daniel Xie, Olivier Gagnon, et al.",
+  "author": "Daniel Xie, hydroflame, et al.",
   "mac": {
     "icon": "./public/icons/mac/icon.icns",
     "category": "public.app-category.games"

electron/saveDataBinaryFormat.d.ts

@@ -0,0 +1 @@
+export declare const isBinaryFormat: (saveData: string | Uint8Array) => boolean;

electron/saveDataBinaryFormat.js

@@ -0,0 +1,13 @@
+// The 2 magic bytes of the gzip header plus the mandatory compression type of DEFLATE
+const magicBytes = [0x1f, 0x8b, 0x08];
+
+function isBinaryFormat(rawData) {
+  for (let i = 0; i < magicBytes.length; ++i) {
+    if (magicBytes[i] !== rawData[i]) {
+      return false;
+    }
+  }
+  return true;
+}
+
+module.exports = { isBinaryFormat };

electron/storage.js

@@ -11,6 +11,7 @@ const greenworks = require("./greenworks");
 const log = require("electron-log");
 const flatten = require("lodash/flatten");
 const Store = require("electron-store");
+const { isBinaryFormat } = require("./saveDataBinaryFormat");
 const store = new Store();
 
 // https://stackoverflow.com/a/69418940
@@ -86,14 +87,6 @@ function isAutosaveEnabled() {
   return store.get("autosave-enabled", true);
 }
 
-function setSaveCompressionConfig(value) {
-  store.set("save-compression-enabled", value);
-}
-
-function isSaveCompressionEnabled() {
-  return store.get("save-compression-enabled", true);
-}
-
 function setCloudEnabledConfig(value) {
   store.set("cloud-enabled", value);
 }
@@ -163,17 +156,22 @@ async function backupSteamDataToDisk(currentPlayerId) {
   const file = greenworks.getFileNameAndSize(0);
   const previousPlayerId = file.name.replace(".json.gz", "");
   if (previousPlayerId !== currentPlayerId) {
-    const backupSave = await getSteamCloudSaveString();
+    const backupSaveData = await getSteamCloudSaveData();
     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");
+    await fs.writeFile(backupFile, backupSaveData, "utf8");
     log.debug(`Saved backup game to '${backupFile}`);
   }
 }
 
-async function pushGameSaveToSteamCloud(base64save, currentPlayerId) {
-  if (!isCloudEnabled) return Promise.reject("Steam Cloud is not Enabled");
+/**
+ * The name of save file is `${currentPlayerId}.json.gz`. The content of save file is weird: it's a base64 string of the
+ * binary data of compressed json save string. It's weird because the extension is .json.gz while the content is a
+ * base64 string. Check the comments in the implementation to see why it is like that.
+ */
+async function pushSaveDataToSteamCloud(saveData, currentPlayerId) {
+  if (!isCloudEnabled()) {
+    return Promise.reject("Steam Cloud is not Enabled");
+  }
 
   try {
     backupSteamDataToDisk(currentPlayerId);
@@ -183,12 +181,19 @@ async function pushGameSaveToSteamCloud(base64save, currentPlayerId) {
 
   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`);
+  /**
+   * When we push save file to Steam Cloud, we use greenworks.saveTextToFile. It seems that this method expects a string
+   * as the file content. That is why saveData is encoded in base64 and pushed to Steam Cloud as a text file.
+   *
+   * Encoding saveData in UTF-8 (with buffer.toString("utf8")) is not the proper way to convert binary data to string.
+   * Quote from buffer's documentation: "If encoding is 'utf8' and a byte sequence in the input is not valid UTF-8, then
+   * each invalid byte is replaced with the replacement character U+FFFD.". The proper way to do it is to use
+   * String.fromCharCode or String.fromCodePoint.
+   *
+   * Instead of implementing it, the old code (encoding in base64) is used here for backward compatibility.
+   */
+  const content = saveData.toString("base64");
+  log.debug(`Uncompressed: ${saveData.length} bytes`);
   log.debug(`Compressed: ${content.length} bytes`);
   log.debug(`Saving to Steam Cloud as ${steamSaveName}`);
 
@@ -199,19 +204,22 @@ async function pushGameSaveToSteamCloud(base64save, currentPlayerId) {
   }
 }
 
-async function getSteamCloudSaveString() {
-  if (!isCloudEnabled()) return Promise.reject("Steam Cloud is not Enabled");
+/**
+ * This function processes the save file in Steam Cloud and returns the save data in the binary format.
+ */
+async function getSteamCloudSaveData() {
+  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;
+  // Decode cloudString to get save data back.
+  const saveData = Buffer.from(cloudString, "base64");
+  log.debug(`SaveData: ${saveData.length} bytes`);
+  return saveData;
 }
 
-async function saveGameToDisk(window, saveData) {
+async function saveGameToDisk(window, electronGameData) {
   const currentFolder = await getSaveFolder(window);
   let saveFolderSizeBytes = await getFolderSizeInBytes(currentFolder);
   const maxFolderSizeBytes = store.get("autosave-quota", 1e8); // 100Mb per playerIndentifier
@@ -221,19 +229,12 @@ async function saveGameToDisk(window, saveData) {
   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" : ""));
+  let saveData = electronGameData.save;
+  const file = path.join(currentFolder, electronGameData.fileName);
   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");
+    await fs.writeFile(file, saveData, "utf8");
     log.debug(`Saved Game to '${file}'`);
-    log.debug(`Save Size: ${saveContent.length} bytes`);
+    log.debug(`Save Size: ${saveData.length} bytes`);
   } catch (error) {
     log.error(error);
   }
@@ -276,14 +277,14 @@ async function loadLastFromDisk(window) {
 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)`);
+  if (isBinaryFormat(buffer)) {
+    // Save file is in the binary format.
+    content = buffer;
   } else {
+    // Save file is in the base64 format.
     content = buffer.toString("utf8");
-    log.debug(`Loaded file with ${content.length} bytes`);
   }
+  log.debug(`Loaded file with ${content.length} bytes`);
   return content;
 }
 
@@ -319,7 +320,7 @@ async function restoreIfNewerExists(window) {
   const disk = {};
 
   try {
-    steam.save = await getSteamCloudSaveString();
+    steam.save = await getSteamCloudSaveData();
     steam.data = await getSaveInformation(window, steam.save);
   } catch (error) {
     log.error("Could not retrieve steam file");
@@ -361,12 +362,12 @@ async function restoreIfNewerExists(window) {
       // 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);
+      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);
+      pushSaveGameForImport(window, bestMatch.save, true);
       return true;
     } else {
       log.debug("Current save data is the freshest");
@@ -380,8 +381,8 @@ module.exports = {
   getSaveInformation,
   restoreIfNewerExists,
   pushSaveGameForImport,
-  pushGameSaveToSteamCloud,
-  getSteamCloudSaveString,
+  pushSaveDataToSteamCloud,
+  getSteamCloudSaveData,
   getSteamCloudQuota,
   deleteCloudFile,
   saveGameToDisk,
@@ -394,6 +395,4 @@ module.exports = {
   setCloudEnabledConfig,
   isAutosaveEnabled,
   setAutosaveConfig,
-  isSaveCompressionEnabled,
-  setSaveCompressionConfig,
 };

electron/utils.js

@@ -7,8 +7,12 @@ const store = new Store();
 
 function reloadAndKill(window, killScripts) {
   log.info("Reloading & Killing all scripts...");
+  const zoomFactor = getZoomFactor();
   window.webContents.forcefullyCrashRenderer();
   window.loadFile("index.html", killScripts ? { query: { noScripts: true } } : {});
+  window.once("ready-to-show", () => {
+    setZoomFactor(window, zoomFactor);
+  });
 }
 
 function promptForReload(window) {

jest.config.js

@@ -7,15 +7,17 @@ module.exports = {
   transformIgnorePatterns: ["node_modules/(?!react-markdown)/"],
   testPathIgnorePatterns: [".cypress", "node_modules", "dist"],
   testEnvironment: "./FixJSDOMEnvironment.ts",
+  setupFiles: ["./jest.polyfills.js"],
   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",
+    "\\.(css|less)$": "<rootDir>/test/__mocks__/NullMock.js",
+    "\\!!raw-loader!.*$": "<rootDir>/test/__mocks__/NullMock.js",
     "@player": "<rootDir>/src/Player",
     "@enums": "<rootDir>/src/Enums",
     "@nsdefs": "<rootDir>/src/ScriptEditor/NetscriptDefinitions",
-    "^monaco-editor$": "<rootDir>/test/__mocks__/monacoMock.js",
-    "^monaco-vim$": "<rootDir>/test/__mocks__/monacoMock.js",
+    "^monaco-editor$": "<rootDir>/test/__mocks__/NullMock.js",
+    "^monaco-vim$": "<rootDir>/test/__mocks__/NullMock.js",
+    "/utils/Protections$": "<rootDir>/test/__mocks__/NullMock.js",
   },
 };

jest.polyfills.js

@@ -0,0 +1,6 @@
+const { TextEncoder, TextDecoder } = require("node:util");
+
+Object.defineProperties(globalThis, {
+  TextEncoder: { value: TextEncoder },
+  TextDecoder: { value: TextDecoder },
+});

markdown/bitburner.backdoorrequirement.md

@@ -0,0 +1,21 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [bitburner](./bitburner.md) &gt; [BackdoorRequirement](./bitburner.backdoorrequirement.md)
+
+## BackdoorRequirement interface
+
+Player must have installed a backdoor on this server.
+
+**Signature:**
+
+```typescript
+interface BackdoorRequirement 
+```
+
+## Properties
+
+|  Property | Modifiers | Type | Description |
+|  --- | --- | --- | --- |
+|  [server](./bitburner.backdoorrequirement.server.md) |  | string |  |
+|  [type](./bitburner.backdoorrequirement.type.md) |  | "backdoorInstalled" |  |
+

markdown/bitburner.backdoorrequirement.server.md

@@ -0,0 +1,11 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [bitburner](./bitburner.md) &gt; [BackdoorRequirement](./bitburner.backdoorrequirement.md) &gt; [server](./bitburner.backdoorrequirement.server.md)
+
+## BackdoorRequirement.server property
+
+**Signature:**
+
+```typescript
+server: string;
+```

markdown/bitburner.backdoorrequirement.type.md

@@ -0,0 +1,11 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [bitburner](./bitburner.md) &gt; [BackdoorRequirement](./bitburner.backdoorrequirement.md) &gt; [type](./bitburner.backdoorrequirement.type.md)
+
+## BackdoorRequirement.type property
+
+**Signature:**
+
+```typescript
+type: "backdoorInstalled";
+```

markdown/bitburner.basichgwoptions.md

@@ -18,5 +18,5 @@ interface BasicHGWOptions
 |  --- | --- | --- | --- |
 |  [additionalMsec?](./bitburner.basichgwoptions.additionalmsec.md) |  | number | _(Optional)_ Number of additional milliseconds that will be spent waiting between the start of the function and when it completes. |
 |  [stock?](./bitburner.basichgwoptions.stock.md) |  | boolean | _(Optional)_ Set to true this action will affect the stock market. |
-|  [threads?](./bitburner.basichgwoptions.threads.md) |  | number | _(Optional)_ Number of threads to use for this function. Must be less than or equal to the number of threads the script is running with. |
+|  [threads?](./bitburner.basichgwoptions.threads.md) |  | number | _(Optional)_ Number of threads to use for this function. Must be less than or equal to the number of threads the script is running with. Accepts positive non integer values. |
 

markdown/bitburner.basichgwoptions.threads.md

@@ -4,7 +4,7 @@
 
 ## BasicHGWOptions.threads property
 
-Number of threads to use for this function. Must be less than or equal to the number of threads the script is running with.
+Number of threads to use for this function. Must be less than or equal to the number of threads the script is running with. Accepts positive non integer values.
 
 **Signature:**
 

markdown/bitburner.bitnoderequirement.bitnoden.md

@@ -0,0 +1,11 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [bitburner](./bitburner.md) &gt; [BitNodeRequirement](./bitburner.bitnoderequirement.md) &gt; [bitNodeN](./bitburner.bitnoderequirement.bitnoden.md)
+
+## BitNodeRequirement.bitNodeN property
+
+**Signature:**
+
+```typescript
+bitNodeN: number;
+```

markdown/bitburner.bitnoderequirement.md

@@ -0,0 +1,21 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [bitburner](./bitburner.md) &gt; [BitNodeRequirement](./bitburner.bitnoderequirement.md)
+
+## BitNodeRequirement interface
+
+Player must be located in this BitNode.
+
+**Signature:**
+
+```typescript
+interface BitNodeRequirement 
+```
+
+## Properties
+
+|  Property | Modifiers | Type | Description |
+|  --- | --- | --- | --- |
+|  [bitNodeN](./bitburner.bitnoderequirement.bitnoden.md) |  | number |  |
+|  [type](./bitburner.bitnoderequirement.type.md) |  | "bitNodeN" |  |
+

markdown/bitburner.bitnoderequirement.type.md

@@ -0,0 +1,11 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [bitburner](./bitburner.md) &gt; [BitNodeRequirement](./bitburner.bitnoderequirement.md) &gt; [type](./bitburner.bitnoderequirement.type.md)
+
+## BitNodeRequirement.type property
+
+**Signature:**
+
+```typescript
+type: "bitNodeN";
+```

markdown/bitburner.bladeburner.getcurrentaction.md

@@ -9,17 +9,15 @@ Get current action.
 **Signature:**
 
 ```typescript
-getCurrentAction(): BladeburnerCurAction;
+getCurrentAction(): BladeburnerCurAction | null;
 ```
 **Returns:**
 
-[BladeburnerCurAction](./bitburner.bladeburnercuraction.md)
+[BladeburnerCurAction](./bitburner.bladeburnercuraction.md) \| null
 
-Object that represents the player’s current Bladeburner action.
+Object that represents the player’s current Bladeburner action, or null if no action is being performed.
 
 ## Remarks
 
 RAM cost: 1 GB
 
-Returns an object that represents the player’s current Bladeburner action. If the player is not performing an action, the function will return an object with the ‘type’ property set to “Idle”.
-

markdown/bitburner.bladeburner.getskillupgradecost.md

@@ -31,5 +31,5 @@ RAM cost: 4 GB
 
 This function returns the number of skill points needed to upgrade the specified skill the specified number of times.
 
-The function returns -1 if an invalid skill name is passed in.
+The function returns -1 if an invalid skill name is passed in, and Infinity if the count overflows the maximum level.
 

markdown/bitburner.bladeburnerrankrequirement.bladeburnerrank.md

@@ -0,0 +1,11 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [bitburner](./bitburner.md) &gt; [BladeburnerRankRequirement](./bitburner.bladeburnerrankrequirement.md) &gt; [bladeburnerRank](./bitburner.bladeburnerrankrequirement.bladeburnerrank.md)
+
+## BladeburnerRankRequirement.bladeburnerRank property
+
+**Signature:**
+
+```typescript
+bladeburnerRank: number;
+```

markdown/bitburner.bladeburnerrankrequirement.md

@@ -0,0 +1,21 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [bitburner](./bitburner.md) &gt; [BladeburnerRankRequirement](./bitburner.bladeburnerrankrequirement.md)
+
+## BladeburnerRankRequirement interface
+
+Player must have at least this rank in the Bladeburner Division.
+
+**Signature:**
+
+```typescript
+interface BladeburnerRankRequirement 
+```
+
+## Properties
+
+|  Property | Modifiers | Type | Description |
+|  --- | --- | --- | --- |
+|  [bladeburnerRank](./bitburner.bladeburnerrankrequirement.bladeburnerrank.md) |  | number |  |
+|  [type](./bitburner.bladeburnerrankrequirement.type.md) |  | "bladeburnerRank" |  |
+

markdown/bitburner.bladeburnerrankrequirement.type.md

@@ -0,0 +1,11 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [bitburner](./bitburner.md) &gt; [BladeburnerRankRequirement](./bitburner.bladeburnerrankrequirement.md) &gt; [type](./bitburner.bladeburnerrankrequirement.type.md)
+
+## BladeburnerRankRequirement.type property
+
+**Signature:**
+
+```typescript
+type: "bladeburnerRank";
+```

markdown/bitburner.cityrequirement.city.md

@@ -0,0 +1,11 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [bitburner](./bitburner.md) &gt; [CityRequirement](./bitburner.cityrequirement.md) &gt; [city](./bitburner.cityrequirement.city.md)
+
+## CityRequirement.city property
+
+**Signature:**
+
+```typescript
+city: CityName;
+```

markdown/bitburner.cityrequirement.md

@@ -0,0 +1,21 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [bitburner](./bitburner.md) &gt; [CityRequirement](./bitburner.cityrequirement.md)
+
+## CityRequirement interface
+
+Player must be located in this city.
+
+**Signature:**
+
+```typescript
+interface CityRequirement 
+```
+
+## Properties
+
+|  Property | Modifiers | Type | Description |
+|  --- | --- | --- | --- |
+|  [city](./bitburner.cityrequirement.city.md) |  | [CityName](./bitburner.cityname.md) |  |
+|  [type](./bitburner.cityrequirement.type.md) |  | "city" |  |
+

markdown/bitburner.cityrequirement.type.md

@@ -0,0 +1,11 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [bitburner](./bitburner.md) &gt; [CityRequirement](./bitburner.cityrequirement.md) &gt; [type](./bitburner.cityrequirement.type.md)
+
+## CityRequirement.type property
+
+**Signature:**
+
+```typescript
+type: "city";
+```

markdown/bitburner.codingcontract.createdummycontract.md

@@ -9,7 +9,7 @@ Generate a dummy contract.
 **Signature:**
 
 ```typescript
-createDummyContract(type: string): void;
+createDummyContract(type: string): string;
 ```
 
 ## Parameters
@@ -20,7 +20,9 @@ createDummyContract(type: string): void;
 
 **Returns:**
 
-void
+string
+
+Filename of the contract.
 
 ## Remarks
 

markdown/bitburner.companyreputationrequirement.company.md

@@ -0,0 +1,11 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [bitburner](./bitburner.md) &gt; [CompanyReputationRequirement](./bitburner.companyreputationrequirement.md) &gt; [company](./bitburner.companyreputationrequirement.company.md)
+
+## CompanyReputationRequirement.company property
+
+**Signature:**
+
+```typescript
+company: CompanyName;
+```

markdown/bitburner.companyreputationrequirement.md

@@ -0,0 +1,22 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [bitburner](./bitburner.md) &gt; [CompanyReputationRequirement](./bitburner.companyreputationrequirement.md)
+
+## CompanyReputationRequirement interface
+
+Player must have at least this much reputation with this company.
+
+**Signature:**
+
+```typescript
+interface CompanyReputationRequirement 
+```
+
+## Properties
+
+|  Property | Modifiers | Type | Description |
+|  --- | --- | --- | --- |
+|  [company](./bitburner.companyreputationrequirement.company.md) |  | [CompanyName](./bitburner.companyname.md) |  |
+|  [reputation](./bitburner.companyreputationrequirement.reputation.md) |  | number |  |
+|  [type](./bitburner.companyreputationrequirement.type.md) |  | "companyReputation" |  |
+

markdown/bitburner.companyreputationrequirement.reputation.md

@@ -0,0 +1,11 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [bitburner](./bitburner.md) &gt; [CompanyReputationRequirement](./bitburner.companyreputationrequirement.md) &gt; [reputation](./bitburner.companyreputationrequirement.reputation.md)
+
+## CompanyReputationRequirement.reputation property
+
+**Signature:**
+
+```typescript
+reputation: number;
+```

markdown/bitburner.companyreputationrequirement.type.md

@@ -0,0 +1,11 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [bitburner](./bitburner.md) &gt; [CompanyReputationRequirement](./bitburner.companyreputationrequirement.md) &gt; [type](./bitburner.companyreputationrequirement.type.md)
+
+## CompanyReputationRequirement.type property
+
+**Signature:**
+
+```typescript
+type: "companyReputation";
+```

markdown/bitburner.companyworktask.companyname.md

@@ -0,0 +1,11 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [bitburner](./bitburner.md) &gt; [CompanyWorkTask](./bitburner.companyworktask.md) &gt; [companyName](./bitburner.companyworktask.companyname.md)
+
+## CompanyWorkTask.companyName property
+
+**Signature:**
+
+```typescript
+companyName: CompanyName;
+```

markdown/bitburner.companyworktask.cyclesworked.md

@@ -0,0 +1,11 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [bitburner](./bitburner.md) &gt; [CompanyWorkTask](./bitburner.companyworktask.md) &gt; [cyclesWorked](./bitburner.companyworktask.cyclesworked.md)
+
+## CompanyWorkTask.cyclesWorked property
+
+**Signature:**
+
+```typescript
+cyclesWorked: number;
+```

markdown/bitburner.companyworktask.md

@@ -0,0 +1,26 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [bitburner](./bitburner.md) &gt; [CompanyWorkTask](./bitburner.companyworktask.md)
+
+## CompanyWorkTask interface
+
+Company Work
+
+**Signature:**
+
+```typescript
+export interface CompanyWorkTask 
+```
+
+## Remarks
+
+An object representing the current work for a company
+
+## Properties
+
+|  Property | Modifiers | Type | Description |
+|  --- | --- | --- | --- |
+|  [companyName](./bitburner.companyworktask.companyname.md) |  | [CompanyName](./bitburner.companyname.md) |  |
+|  [cyclesWorked](./bitburner.companyworktask.cyclesworked.md) |  | number |  |
+|  [type](./bitburner.companyworktask.type.md) |  | "COMPANY" |  |
+

markdown/bitburner.companyworktask.type.md

@@ -0,0 +1,11 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [bitburner](./bitburner.md) &gt; [CompanyWorkTask](./bitburner.companyworktask.md) &gt; [type](./bitburner.companyworktask.type.md)
+
+## CompanyWorkTask.type property
+
+**Signature:**
+
+```typescript
+type: "COMPANY";
+```

markdown/bitburner.corporation.md

@@ -41,5 +41,6 @@ export interface Corporation extends WarehouseAPI, OfficeAPI
 |  [levelUpgrade(upgradeName)](./bitburner.corporation.levelupgrade.md) | Level an upgrade. |
 |  [nextUpdate()](./bitburner.corporation.nextupdate.md) | Sleep until the next Corporation update has happened. |
 |  [purchaseUnlock(upgradeName)](./bitburner.corporation.purchaseunlock.md) | Unlock an upgrade |
+|  [sellDivision(divisionName)](./bitburner.corporation.selldivision.md) | Sell a division |
 |  [sellShares(amount)](./bitburner.corporation.sellshares.md) | Sell Shares. Transfer shares from the CEO to public traders to receive money in the player's wallet. |
 

markdown/bitburner.corporation.selldivision.md

@@ -0,0 +1,28 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [bitburner](./bitburner.md) &gt; [Corporation](./bitburner.corporation.md) &gt; [sellDivision](./bitburner.corporation.selldivision.md)
+
+## Corporation.sellDivision() method
+
+Sell a division
+
+**Signature:**
+
+```typescript
+sellDivision(divisionName: string): void;
+```
+
+## Parameters
+
+|  Parameter | Type | Description |
+|  --- | --- | --- |
+|  divisionName | string | Name of the division |
+
+**Returns:**
+
+void
+
+## Remarks
+
+RAM cost: 20 GB
+

markdown/bitburner.createprogramworktask.cyclesworked.md

@@ -0,0 +1,11 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [bitburner](./bitburner.md) &gt; [CreateProgramWorkTask](./bitburner.createprogramworktask.md) &gt; [cyclesWorked](./bitburner.createprogramworktask.cyclesworked.md)
+
+## CreateProgramWorkTask.cyclesWorked property
+
+**Signature:**
+
+```typescript
+cyclesWorked: number;
+```

markdown/bitburner.createprogramworktask.md

@@ -0,0 +1,26 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [bitburner](./bitburner.md) &gt; [CreateProgramWorkTask](./bitburner.createprogramworktask.md)
+
+## CreateProgramWorkTask interface
+
+Create Program
+
+**Signature:**
+
+```typescript
+export interface CreateProgramWorkTask 
+```
+
+## Remarks
+
+An object representing the status of the program being created
+
+## Properties
+
+|  Property | Modifiers | Type | Description |
+|  --- | --- | --- | --- |
+|  [cyclesWorked](./bitburner.createprogramworktask.cyclesworked.md) |  | number |  |
+|  [programName](./bitburner.createprogramworktask.programname.md) |  | string |  |
+|  [type](./bitburner.createprogramworktask.type.md) |  | "CREATE\_PROGRAM" |  |
+

markdown/bitburner.createprogramworktask.programname.md

@@ -0,0 +1,11 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [bitburner](./bitburner.md) &gt; [CreateProgramWorkTask](./bitburner.createprogramworktask.md) &gt; [programName](./bitburner.createprogramworktask.programname.md)
+
+## CreateProgramWorkTask.programName property
+
+**Signature:**
+
+```typescript
+programName: string;
+```

markdown/bitburner.createprogramworktask.type.md

@@ -0,0 +1,11 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [bitburner](./bitburner.md) &gt; [CreateProgramWorkTask](./bitburner.createprogramworktask.md) &gt; [type](./bitburner.createprogramworktask.type.md)
+
+## CreateProgramWorkTask.type property
+
+**Signature:**
+
+```typescript
+type: "CREATE_PROGRAM";
+```

markdown/bitburner.crimetask.crimetype.md

@@ -0,0 +1,11 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [bitburner](./bitburner.md) &gt; [CrimeTask](./bitburner.crimetask.md) &gt; [crimeType](./bitburner.crimetask.crimetype.md)
+
+## CrimeTask.crimeType property
+
+**Signature:**
+
+```typescript
+crimeType: CrimeType;
+```

markdown/bitburner.crimetask.cyclesworked.md

@@ -0,0 +1,11 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [bitburner](./bitburner.md) &gt; [CrimeTask](./bitburner.crimetask.md) &gt; [cyclesWorked](./bitburner.crimetask.cyclesworked.md)
+
+## CrimeTask.cyclesWorked property
+
+**Signature:**
+
+```typescript
+cyclesWorked: number;
+```

markdown/bitburner.crimetask.md

@@ -0,0 +1,26 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [bitburner](./bitburner.md) &gt; [CrimeTask](./bitburner.crimetask.md)
+
+## CrimeTask interface
+
+Crime
+
+**Signature:**
+
+```typescript
+export interface CrimeTask 
+```
+
+## Remarks
+
+An object representing the crime being commited
+
+## Properties
+
+|  Property | Modifiers | Type | Description |
+|  --- | --- | --- | --- |
+|  [crimeType](./bitburner.crimetask.crimetype.md) |  | [CrimeType](./bitburner.crimetype.md) |  |
+|  [cyclesWorked](./bitburner.crimetask.cyclesworked.md) |  | number |  |
+|  [type](./bitburner.crimetask.type.md) |  | "CRIME" |  |
+

markdown/bitburner.crimetask.type.md

@@ -0,0 +1,11 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [bitburner](./bitburner.md) &gt; [CrimeTask](./bitburner.crimetask.md) &gt; [type](./bitburner.crimetask.type.md)
+
+## CrimeTask.type property
+
+**Signature:**
+
+```typescript
+type: "CRIME";
+```

markdown/bitburner.employedbyrequirement.company.md

@@ -0,0 +1,11 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [bitburner](./bitburner.md) &gt; [EmployedByRequirement](./bitburner.employedbyrequirement.md) &gt; [company](./bitburner.employedbyrequirement.company.md)
+
+## EmployedByRequirement.company property
+
+**Signature:**
+
+```typescript
+company: CompanyName;
+```

markdown/bitburner.employedbyrequirement.md

@@ -0,0 +1,21 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [bitburner](./bitburner.md) &gt; [EmployedByRequirement](./bitburner.employedbyrequirement.md)
+
+## EmployedByRequirement interface
+
+Player must be working for this company.
+
+**Signature:**
+
+```typescript
+interface EmployedByRequirement 
+```
+
+## Properties
+
+|  Property | Modifiers | Type | Description |
+|  --- | --- | --- | --- |
+|  [company](./bitburner.employedbyrequirement.company.md) |  | [CompanyName](./bitburner.companyname.md) |  |
+|  [type](./bitburner.employedbyrequirement.type.md) |  | "employedBy" |  |
+

markdown/bitburner.employedbyrequirement.type.md

@@ -0,0 +1,11 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [bitburner](./bitburner.md) &gt; [EmployedByRequirement](./bitburner.employedbyrequirement.md) &gt; [type](./bitburner.employedbyrequirement.type.md)
+
+## EmployedByRequirement.type property
+
+**Signature:**
+
+```typescript
+type: "employedBy";
+```

markdown/bitburner.everyrequirement.conditions.md

@@ -0,0 +1,11 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [bitburner](./bitburner.md) &gt; [EveryRequirement](./bitburner.everyrequirement.md) &gt; [conditions](./bitburner.everyrequirement.conditions.md)
+
+## EveryRequirement.conditions property
+
+**Signature:**
+
+```typescript
+conditions: PlayerRequirement[];
+```

markdown/bitburner.everyrequirement.md

@@ -0,0 +1,21 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [bitburner](./bitburner.md) &gt; [EveryRequirement](./bitburner.everyrequirement.md)
+
+## EveryRequirement interface
+
+All sub-conditions must be satisfied.
+
+**Signature:**
+
+```typescript
+interface EveryRequirement 
+```
+
+## Properties
+
+|  Property | Modifiers | Type | Description |
+|  --- | --- | --- | --- |
+|  [conditions](./bitburner.everyrequirement.conditions.md) |  | [PlayerRequirement](./bitburner.playerrequirement.md)<!-- -->\[\] |  |
+|  [type](./bitburner.everyrequirement.type.md) |  | "everyCondition" |  |
+

markdown/bitburner.everyrequirement.type.md

@@ -0,0 +1,11 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [bitburner](./bitburner.md) &gt; [EveryRequirement](./bitburner.everyrequirement.md) &gt; [type](./bitburner.everyrequirement.type.md)
+
+## EveryRequirement.type property
+
+**Signature:**
+
+```typescript
+type: "everyCondition";
+```

markdown/bitburner.factionworktask.cyclesworked.md

@@ -0,0 +1,11 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [bitburner](./bitburner.md) &gt; [FactionWorkTask](./bitburner.factionworktask.md) &gt; [cyclesWorked](./bitburner.factionworktask.cyclesworked.md)
+
+## FactionWorkTask.cyclesWorked property
+
+**Signature:**
+
+```typescript
+cyclesWorked: number;
+```

markdown/bitburner.factionworktask.factionname.md

@@ -0,0 +1,11 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [bitburner](./bitburner.md) &gt; [FactionWorkTask](./bitburner.factionworktask.md) &gt; [factionName](./bitburner.factionworktask.factionname.md)
+
+## FactionWorkTask.factionName property
+
+**Signature:**
+
+```typescript
+factionName: string;
+```

markdown/bitburner.factionworktask.factionworktype.md

@@ -0,0 +1,11 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [bitburner](./bitburner.md) &gt; [FactionWorkTask](./bitburner.factionworktask.md) &gt; [factionWorkType](./bitburner.factionworktask.factionworktype.md)
+
+## FactionWorkTask.factionWorkType property
+
+**Signature:**
+
+```typescript
+factionWorkType: FactionWorkType;
+```

markdown/bitburner.factionworktask.md

@@ -0,0 +1,27 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [bitburner](./bitburner.md) &gt; [FactionWorkTask](./bitburner.factionworktask.md)
+
+## FactionWorkTask interface
+
+Faction Work
+
+**Signature:**
+
+```typescript
+export interface FactionWorkTask 
+```
+
+## Remarks
+
+An object representing the current work for a faction
+
+## Properties
+
+|  Property | Modifiers | Type | Description |
+|  --- | --- | --- | --- |
+|  [cyclesWorked](./bitburner.factionworktask.cyclesworked.md) |  | number |  |
+|  [factionName](./bitburner.factionworktask.factionname.md) |  | string |  |
+|  [factionWorkType](./bitburner.factionworktask.factionworktype.md) |  | [FactionWorkType](./bitburner.factionworktype.md) |  |
+|  [type](./bitburner.factionworktask.type.md) |  | "FACTION" |  |
+

markdown/bitburner.factionworktask.type.md

@@ -0,0 +1,11 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [bitburner](./bitburner.md) &gt; [FactionWorkTask](./bitburner.factionworktask.md) &gt; [type](./bitburner.factionworktask.type.md)
+
+## FactionWorkTask.type property
+
+**Signature:**
+
+```typescript
+type: "FACTION";
+```

markdown/bitburner.filerequirement.file.md

@@ -0,0 +1,11 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [bitburner](./bitburner.md) &gt; [FileRequirement](./bitburner.filerequirement.md) &gt; [file](./bitburner.filerequirement.file.md)
+
+## FileRequirement.file property
+
+**Signature:**
+
+```typescript
+file: string;
+```

markdown/bitburner.filerequirement.md

@@ -0,0 +1,21 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [bitburner](./bitburner.md) &gt; [FileRequirement](./bitburner.filerequirement.md)
+
+## FileRequirement interface
+
+Player must have a specific Literature or Message file on their home computer.
+
+**Signature:**
+
+```typescript
+interface FileRequirement 
+```
+
+## Properties
+
+|  Property | Modifiers | Type | Description |
+|  --- | --- | --- | --- |
+|  [file](./bitburner.filerequirement.file.md) |  | string |  |
+|  [type](./bitburner.filerequirement.type.md) |  | "file" |  |
+

markdown/bitburner.filerequirement.type.md

@@ -0,0 +1,11 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [bitburner](./bitburner.md) &gt; [FileRequirement](./bitburner.filerequirement.md) &gt; [type](./bitburner.filerequirement.type.md)
+
+## FileRequirement.type property
+
+**Signature:**
+
+```typescript
+type: "file";
+```

markdown/bitburner.gang.getinstallresult.md

@@ -0,0 +1,32 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [bitburner](./bitburner.md) &gt; [Gang](./bitburner.gang.md) &gt; [getInstallResult](./bitburner.gang.getinstallresult.md)
+
+## Gang.getInstallResult() method
+
+Get the effect of an install on ascension multipliers without installing.
+
+**Signature:**
+
+```typescript
+getInstallResult(memberName: string): GangMemberInstall | undefined;
+```
+
+## Parameters
+
+|  Parameter | Type | Description |
+|  --- | --- | --- |
+|  memberName | string | Name of member. |
+
+**Returns:**
+
+[GangMemberInstall](./bitburner.gangmemberinstall.md) \| undefined
+
+Object with info about the install results on ascension multipliers, or undefined if ascension is not possible.
+
+## Remarks
+
+RAM cost: 2 GB
+
+Get [GangMemberInstall](./bitburner.gangmemberinstall.md) effects on ascension multipliers for a gang member after installing without performing the install.
+

markdown/bitburner.gang.md

@@ -31,6 +31,7 @@ If you are not in BitNode-2, then you must have Source-File 2 in order to use th
 |  [getEquipmentStats(equipName)](./bitburner.gang.getequipmentstats.md) | Get stats of an equipment. |
 |  [getEquipmentType(equipName)](./bitburner.gang.getequipmenttype.md) | Get type of an equipment. |
 |  [getGangInformation()](./bitburner.gang.getganginformation.md) | Get information about your gang. |
+|  [getInstallResult(memberName)](./bitburner.gang.getinstallresult.md) | Get the effect of an install on ascension multipliers without installing. |
 |  [getMemberInformation(name)](./bitburner.gang.getmemberinformation.md) | Get information about a specific gang member. |
 |  [getMemberNames()](./bitburner.gang.getmembernames.md) | List all gang members. |
 |  [getOtherGangInformation()](./bitburner.gang.getotherganginformation.md) | Get information about the other gangs. |

markdown/bitburner.gangmemberinstall.agi.md

@@ -0,0 +1,13 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [bitburner](./bitburner.md) &gt; [GangMemberInstall](./bitburner.gangmemberinstall.md) &gt; [agi](./bitburner.gangmemberinstall.agi.md)
+
+## GangMemberInstall.agi property
+
+Factor by which the agility ascension multiplier was decreased (newMult / oldMult)
+
+**Signature:**
+
+```typescript
+agi: number;
+```

markdown/bitburner.gangmemberinstall.cha.md

@@ -0,0 +1,13 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [bitburner](./bitburner.md) &gt; [GangMemberInstall](./bitburner.gangmemberinstall.md) &gt; [cha](./bitburner.gangmemberinstall.cha.md)
+
+## GangMemberInstall.cha property
+
+Factor by which the charisma ascension multiplier was decreased (newMult / oldMult)
+
+**Signature:**
+
+```typescript
+cha: number;
+```

markdown/bitburner.gangmemberinstall.def.md

@@ -0,0 +1,13 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [bitburner](./bitburner.md) &gt; [GangMemberInstall](./bitburner.gangmemberinstall.md) &gt; [def](./bitburner.gangmemberinstall.def.md)
+
+## GangMemberInstall.def property
+
+Factor by which the defense ascension multiplier was decreased (newMult / oldMult)
+
+**Signature:**
+
+```typescript
+def: number;
+```

markdown/bitburner.gangmemberinstall.dex.md

@@ -0,0 +1,13 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [bitburner](./bitburner.md) &gt; [GangMemberInstall](./bitburner.gangmemberinstall.md) &gt; [dex](./bitburner.gangmemberinstall.dex.md)
+
+## GangMemberInstall.dex property
+
+Factor by which the dexterity ascension multiplier was decreased (newMult / oldMult)
+
+**Signature:**
+
+```typescript
+dex: number;
+```

markdown/bitburner.gangmemberinstall.hack.md

@@ -0,0 +1,13 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [bitburner](./bitburner.md) &gt; [GangMemberInstall](./bitburner.gangmemberinstall.md) &gt; [hack](./bitburner.gangmemberinstall.hack.md)
+
+## GangMemberInstall.hack property
+
+Factor by which the hacking ascension multiplier was decreased (newMult / oldMult)
+
+**Signature:**
+
+```typescript
+hack: number;
+```

markdown/bitburner.gangmemberinstall.md

@@ -0,0 +1,24 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [bitburner](./bitburner.md) &gt; [GangMemberInstall](./bitburner.gangmemberinstall.md)
+
+## GangMemberInstall interface
+
+
+**Signature:**
+
+```typescript
+interface GangMemberInstall 
+```
+
+## Properties
+
+|  Property | Modifiers | Type | Description |
+|  --- | --- | --- | --- |
+|  [agi](./bitburner.gangmemberinstall.agi.md) |  | number | Factor by which the agility ascension multiplier was decreased (newMult / oldMult) |
+|  [cha](./bitburner.gangmemberinstall.cha.md) |  | number | Factor by which the charisma ascension multiplier was decreased (newMult / oldMult) |
+|  [def](./bitburner.gangmemberinstall.def.md) |  | number | Factor by which the defense ascension multiplier was decreased (newMult / oldMult) |
+|  [dex](./bitburner.gangmemberinstall.dex.md) |  | number | Factor by which the dexterity ascension multiplier was decreased (newMult / oldMult) |
+|  [hack](./bitburner.gangmemberinstall.hack.md) |  | number | Factor by which the hacking ascension multiplier was decreased (newMult / oldMult) |
+|  [str](./bitburner.gangmemberinstall.str.md) |  | number | Factor by which the strength ascension multiplier was decreased (newMult / oldMult) |
+

markdown/bitburner.gangmemberinstall.str.md

@@ -0,0 +1,13 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [bitburner](./bitburner.md) &gt; [GangMemberInstall](./bitburner.gangmemberinstall.md) &gt; [str](./bitburner.gangmemberinstall.str.md)
+
+## GangMemberInstall.str property
+
+Factor by which the strength ascension multiplier was decreased (newMult / oldMult)
+
+**Signature:**
+
+```typescript
+str: number;
+```

markdown/bitburner.go.analysis.md

@@ -0,0 +1,23 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [bitburner](./bitburner.md) &gt; [Go](./bitburner.go.md) &gt; [analysis](./bitburner.go.analysis.md)
+
+## Go.analysis property
+
+Tools to analyze the IPvGO subnet.
+
+**Signature:**
+
+```typescript
+analysis: {
+    getValidMoves(): boolean[][];
+
+    getChains(): (number | null)[][];
+
+    getLiberties(): number[][];
+
+    getControlledEmptyNodes(): string[];
+
+    getStats(): Partial<Record<GoOpponent, SimpleOpponentStats>>;
+  };
+```

markdown/bitburner.go.cheat.md

@@ -0,0 +1,51 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [bitburner](./bitburner.md) &gt; [Go](./bitburner.go.md) &gt; [cheat](./bitburner.go.cheat.md)
+
+## Go.cheat property
+
+Illicit and dangerous IPvGO tools. Not for the faint of heart. Requires Bitnode 14.2 to use.
+
+**Signature:**
+
+```typescript
+cheat: {
+    getCheatSuccessChance(): number;
+    removeRouter(
+      x: number,
+      y: number,
+    ): Promise<{
+      type: "move" | "pass" | "gameOver";
+      x: number | null;
+      y: number | null;
+    }>;
+    playTwoMoves(
+      x1: number,
+      y1: number,
+      x2: number,
+      y2: number,
+    ): Promise<{
+      type: "move" | "pass" | "gameOver";
+      x: number | null;
+      y: number | null;
+    }>;
+
+    repairOfflineNode(
+      x: number,
+      y: number,
+    ): Promise<{
+      type: "move" | "pass" | "gameOver";
+      x: number | null;
+      y: number | null;
+    }>;
+
+    destroyNode(
+      x: number,
+      y: number,
+    ): Promise<{
+      type: "move" | "pass" | "gameOver";
+      x: number | null;
+      y: number | null;
+    }>;
+  };
+```

markdown/bitburner.go.getboardstate.md

@@ -0,0 +1,31 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [bitburner](./bitburner.md) &gt; [Go](./bitburner.go.md) &gt; [getBoardState](./bitburner.go.getboardstate.md)
+
+## Go.getBoardState() method
+
+Retrieves a simplified version of the board state. "X" represents black pieces, "O" white, and "." empty points. "\#" are dead nodes that are not part of the subnet. (They are not territory nor open nodes.)
+
+For example, a 5x5 board might look like this:
+
+\[<br/> "XX.O.",<br/> "X..OO",<br/> ".XO..",<br/> "XXO.\#",<br/> ".XO.\#",<br/> \]
+
+Each string represents a vertical column on the board, and each character in the string represents a point.
+
+Traditional notation for Go is e.g. "B,1" referring to second ("B") column, first rank. This is the equivalent of index \[1\]\[0\].
+
+Note that the \[0\]\[0\] point is shown on the bottom-left on the visual board (as is traditional), and each string represents a vertical column on the board. In other words, the printed example above can be understood to be rotated 90 degrees clockwise compared to the board UI as shown in the IPvGO subnet tab.
+
+**Signature:**
+
+```typescript
+getBoardState(): string[];
+```
+**Returns:**
+
+string\[\]
+
+## Remarks
+
+RAM cost: 4 GB
+

markdown/bitburner.go.getcurrentplayer.md

@@ -0,0 +1,19 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [bitburner](./bitburner.md) &gt; [Go](./bitburner.go.md) &gt; [getCurrentPlayer](./bitburner.go.getcurrentplayer.md)
+
+## Go.getCurrentPlayer() method
+
+Returns the color of the current player, or 'None' if the game is over.
+
+**Signature:**
+
+```typescript
+getCurrentPlayer(): "White" | "Black" | "None";
+```
+**Returns:**
+
+"White" \| "Black" \| "None"
+
+"White" \| "Black" \| "None"
+

markdown/bitburner.go.getgamestate.md

@@ -0,0 +1,22 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [bitburner](./bitburner.md) &gt; [Go](./bitburner.go.md) &gt; [getGameState](./bitburner.go.getgamestate.md)
+
+## Go.getGameState() method
+
+Gets the status of the current game. Shows the current player, current score, and the previous move coordinates. Previous move coordinates will be \[-1, -1\] for a pass, or if there are no prior moves.
+
+**Signature:**
+
+```typescript
+getGameState(): {
+    currentPlayer: "White" | "Black" | "None";
+    whiteScore: number;
+    blackScore: number;
+    previousMove: [number, number] | null;
+  };
+```
+**Returns:**
+
+{ currentPlayer: "White" \| "Black" \| "None"; whiteScore: number; blackScore: number; previousMove: \[number, number\] \| null; }
+

markdown/bitburner.go.getopponent.md

@@ -0,0 +1,17 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [bitburner](./bitburner.md) &gt; [Go](./bitburner.go.md) &gt; [getOpponent](./bitburner.go.getopponent.md)
+
+## Go.getOpponent() method
+
+Returns the name of the opponent faction in the current subnet.
+
+**Signature:**
+
+```typescript
+getOpponent(): GoOpponent | "No AI";
+```
+**Returns:**
+
+[GoOpponent](./bitburner.goopponent.md) \| "No AI"
+

markdown/bitburner.go.makemove.md

@@ -0,0 +1,38 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [bitburner](./bitburner.md) &gt; [Go](./bitburner.go.md) &gt; [makeMove](./bitburner.go.makemove.md)
+
+## Go.makeMove() method
+
+Make a move on the IPvGO subnet gameboard, and await the opponent's response. x:0 y:0 represents the bottom-left corner of the board in the UI.
+
+**Signature:**
+
+```typescript
+makeMove(
+    x: number,
+    y: number,
+  ): Promise<{
+    type: "move" | "pass" | "gameOver";
+    x: number | null;
+    y: number | null;
+  }>;
+```
+
+## Parameters
+
+|  Parameter | Type | Description |
+|  --- | --- | --- |
+|  x | number |  |
+|  y | number |  |
+
+**Returns:**
+
+Promise&lt;{ type: "move" \| "pass" \| "gameOver"; x: number \| null; y: number \| null; }&gt;
+
+a promise that contains if your move was valid and successful, the opponent move's x and y coordinates (or pass) in response, or an indication if the game has ended
+
+## Remarks
+
+RAM cost: 4 GB
+

markdown/bitburner.go.md

@@ -0,0 +1,34 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [bitburner](./bitburner.md) &gt; [Go](./bitburner.go.md)
+
+## Go interface
+
+IPvGO api
+
+**Signature:**
+
+```typescript
+export interface Go 
+```
+
+## Properties
+
+|  Property | Modifiers | Type | Description |
+|  --- | --- | --- | --- |
+|  [analysis](./bitburner.go.analysis.md) |  | { getValidMoves(): boolean\[\]\[\]; getChains(): (number \| null)\[\]\[\]; getLiberties(): number\[\]\[\]; getControlledEmptyNodes(): string\[\]; getStats(): Partial&lt;Record&lt;[GoOpponent](./bitburner.goopponent.md)<!-- -->, [SimpleOpponentStats](./bitburner.simpleopponentstats.md)<!-- -->&gt;&gt;; } | Tools to analyze the IPvGO subnet. |
+|  [cheat](./bitburner.go.cheat.md) |  | { getCheatSuccessChance(): number; removeRouter( x: number, y: number, ): Promise&lt;{ type: "move" \| "pass" \| "gameOver"; x: number \| null; y: number \| null; }&gt;; playTwoMoves( x1: number, y1: number, x2: number, y2: number, ): Promise&lt;{ type: "move" \| "pass" \| "gameOver"; x: number \| null; y: number \| null; }&gt;; repairOfflineNode( x: number, y: number, ): Promise&lt;{ type: "move" \| "pass" \| "gameOver"; x: number \| null; y: number \| null; }&gt;; destroyNode( x: number, y: number, ): Promise&lt;{ type: "move" \| "pass" \| "gameOver"; x: number \| null; y: number \| null; }&gt;; } | Illicit and dangerous IPvGO tools. Not for the faint of heart. Requires Bitnode 14.2 to use. |
+
+## Methods
+
+|  Method | Description |
+|  --- | --- |
+|  [getBoardState()](./bitburner.go.getboardstate.md) | <p>Retrieves a simplified version of the board state. "X" represents black pieces, "O" white, and "." empty points. "\#" are dead nodes that are not part of the subnet. (They are not territory nor open nodes.)</p><p>For example, a 5x5 board might look like this:</p><p>\[<br/> "XX.O.",<br/> "X..OO",<br/> ".XO..",<br/> "XXO.\#",<br/> ".XO.\#",<br/> \]</p><p>Each string represents a vertical column on the board, and each character in the string represents a point.</p><p>Traditional notation for Go is e.g. "B,1" referring to second ("B") column, first rank. This is the equivalent of index \[1\]\[0\].</p><p>Note that the \[0\]\[0\] point is shown on the bottom-left on the visual board (as is traditional), and each string represents a vertical column on the board. In other words, the printed example above can be understood to be rotated 90 degrees clockwise compared to the board UI as shown in the IPvGO subnet tab.</p> |
+|  [getCurrentPlayer()](./bitburner.go.getcurrentplayer.md) | Returns the color of the current player, or 'None' if the game is over. |
+|  [getGameState()](./bitburner.go.getgamestate.md) | Gets the status of the current game. Shows the current player, current score, and the previous move coordinates. Previous move coordinates will be \[-1, -1\] for a pass, or if there are no prior moves. |
+|  [getOpponent()](./bitburner.go.getopponent.md) | Returns the name of the opponent faction in the current subnet. |
+|  [makeMove(x, y)](./bitburner.go.makemove.md) | Make a move on the IPvGO subnet gameboard, and await the opponent's response. x:0 y:0 represents the bottom-left corner of the board in the UI. |
+|  [opponentNextTurn(logOpponentMove)](./bitburner.go.opponentnextturn.md) | Returns a promise that resolves with the success or failure state of your last move, and the AI's response, if applicable. x:0 y:0 represents the bottom-left corner of the board in the UI. |
+|  [passTurn()](./bitburner.go.passturn.md) | <p>Pass the player's turn rather than making a move, and await the opponent's response. This ends the game if the opponent passed on the previous turn, or if the opponent passes on their following turn.</p><p>This can also be used if you pick up the game in a state where the opponent needs to play next. For example: if BitBurner was closed while waiting for the opponent to make a move, you may need to call passTurn() to get them to play their move on game start.</p> |
+|  [resetBoardState(opponent, boardSize)](./bitburner.go.resetboardstate.md) | <p>Gets new IPvGO subnet with the specified size owned by the listed faction, ready for the player to make a move. This will reset your win streak if the current game is not complete and you have already made moves.</p><p>Note that some factions will have a few routers on the subnet at this state.</p><p>opponent is "Netburners" or "Slum Snakes" or "The Black Hand" or "Tetrads" or "Daedalus" or "Illuminati" or "????????????",</p> |
+

markdown/bitburner.go.opponentnextturn.md

@@ -0,0 +1,34 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [bitburner](./bitburner.md) &gt; [Go](./bitburner.go.md) &gt; [opponentNextTurn](./bitburner.go.opponentnextturn.md)
+
+## Go.opponentNextTurn() method
+
+Returns a promise that resolves with the success or failure state of your last move, and the AI's response, if applicable. x:0 y:0 represents the bottom-left corner of the board in the UI.
+
+**Signature:**
+
+```typescript
+opponentNextTurn(logOpponentMove?: boolean): Promise<{
+    type: "move" | "pass" | "gameOver";
+    x: number | null;
+    y: number | null;
+  }>;
+```
+
+## Parameters
+
+|  Parameter | Type | Description |
+|  --- | --- | --- |
+|  logOpponentMove | boolean | _(Optional)_ optional, defaults to true. if false prevents logging opponent move |
+
+**Returns:**
+
+Promise&lt;{ type: "move" \| "pass" \| "gameOver"; x: number \| null; y: number \| null; }&gt;
+
+a promise that contains if your last move was valid and successful, the opponent move's x and y coordinates (or pass) in response, or an indication if the game has ended
+
+## Remarks
+
+RAM cost: 0 GB
+

markdown/bitburner.go.passturn.md

@@ -0,0 +1,29 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [bitburner](./bitburner.md) &gt; [Go](./bitburner.go.md) &gt; [passTurn](./bitburner.go.passturn.md)
+
+## Go.passTurn() method
+
+Pass the player's turn rather than making a move, and await the opponent's response. This ends the game if the opponent passed on the previous turn, or if the opponent passes on their following turn.
+
+This can also be used if you pick up the game in a state where the opponent needs to play next. For example: if BitBurner was closed while waiting for the opponent to make a move, you may need to call passTurn() to get them to play their move on game start.
+
+**Signature:**
+
+```typescript
+passTurn(): Promise<{
+    type: "move" | "pass" | "gameOver";
+    x: number | null;
+    y: number | null;
+  }>;
+```
+**Returns:**
+
+Promise&lt;{ type: "move" \| "pass" \| "gameOver"; x: number \| null; y: number \| null; }&gt;
+
+a promise that contains if your move was valid and successful, the opponent move's x and y coordinates (or pass) in response, or an indication if the game has ended
+
+## Remarks
+
+RAM cost: 0 GB
+

markdown/bitburner.go.resetboardstate.md

@@ -0,0 +1,35 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [bitburner](./bitburner.md) &gt; [Go](./bitburner.go.md) &gt; [resetBoardState](./bitburner.go.resetboardstate.md)
+
+## Go.resetBoardState() method
+
+Gets new IPvGO subnet with the specified size owned by the listed faction, ready for the player to make a move. This will reset your win streak if the current game is not complete and you have already made moves.
+
+Note that some factions will have a few routers on the subnet at this state.
+
+opponent is "Netburners" or "Slum Snakes" or "The Black Hand" or "Tetrads" or "Daedalus" or "Illuminati" or "????????????",
+
+**Signature:**
+
+```typescript
+resetBoardState(opponent: GoOpponent, boardSize: 5 | 7 | 9 | 13): string[] | undefined;
+```
+
+## Parameters
+
+|  Parameter | Type | Description |
+|  --- | --- | --- |
+|  opponent | [GoOpponent](./bitburner.goopponent.md) |  |
+|  boardSize | 5 \| 7 \| 9 \| 13 |  |
+
+**Returns:**
+
+string\[\] \| undefined
+
+a simplified version of the board state as an array of strings representing the board columns. See ns.Go.getBoardState() for full details
+
+## Remarks
+
+RAM cost: 0 GB
+

markdown/bitburner.goopponent.md

@@ -0,0 +1,19 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [bitburner](./bitburner.md) &gt; [GoOpponent](./bitburner.goopponent.md)
+
+## GoOpponent type
+
+
+**Signature:**
+
+```typescript
+type GoOpponent =
+  | "Netburners"
+  | "Slum Snakes"
+  | "The Black Hand"
+  | "Tetrads"
+  | "Daedalus"
+  | "Illuminati"
+  | "????????????";
+```

markdown/bitburner.graftingtask.augmentation.md

@@ -0,0 +1,11 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [bitburner](./bitburner.md) &gt; [GraftingTask](./bitburner.graftingtask.md) &gt; [augmentation](./bitburner.graftingtask.augmentation.md)
+
+## GraftingTask.augmentation property
+
+**Signature:**
+
+```typescript
+augmentation: string;
+```

markdown/bitburner.graftingtask.cyclesworked.md

@@ -0,0 +1,11 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [bitburner](./bitburner.md) &gt; [GraftingTask](./bitburner.graftingtask.md) &gt; [cyclesWorked](./bitburner.graftingtask.cyclesworked.md)
+
+## GraftingTask.cyclesWorked property
+
+**Signature:**
+
+```typescript
+cyclesWorked: number;
+```

markdown/bitburner.graftingtask.md

@@ -0,0 +1,26 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [bitburner](./bitburner.md) &gt; [GraftingTask](./bitburner.graftingtask.md)
+
+## GraftingTask interface
+
+Faction Work
+
+**Signature:**
+
+```typescript
+export interface GraftingTask 
+```
+
+## Remarks
+
+An object representing the current grafting status
+
+## Properties
+
+|  Property | Modifiers | Type | Description |
+|  --- | --- | --- | --- |
+|  [augmentation](./bitburner.graftingtask.augmentation.md) |  | string |  |
+|  [cyclesWorked](./bitburner.graftingtask.cyclesworked.md) |  | number |  |
+|  [type](./bitburner.graftingtask.type.md) |  | "GRAFTING" |  |
+

markdown/bitburner.graftingtask.type.md

@@ -0,0 +1,11 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [bitburner](./bitburner.md) &gt; [GraftingTask](./bitburner.graftingtask.md) &gt; [type](./bitburner.graftingtask.type.md)
+
+## GraftingTask.type property
+
+**Signature:**
+
+```typescript
+type: "GRAFTING";
+```

markdown/bitburner.hackingformulas.growamount.md

@@ -0,0 +1,33 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [bitburner](./bitburner.md) &gt; [HackingFormulas](./bitburner.hackingformulas.md) &gt; [growAmount](./bitburner.hackingformulas.growamount.md)
+
+## HackingFormulas.growAmount() method
+
+Calculate the amount of money a grow action will leave a server with. Starting money is server.moneyAvailable. Note that when simulating the effect of [grow](./bitburner.ns.grow.md)<!-- -->, what matters is the state of the server and player when the grow \*finishes\*, not when it is started.
+
+The growth amount depends both linearly \*and\* exponentially on threads; see [grow](./bitburner.ns.grow.md) for more details.
+
+The inverse of this function is [formulas.hacking.growThreads](./bitburner.hackingformulas.growthreads.md)<!-- -->, although it rounds up to integer threads.
+
+**Signature:**
+
+```typescript
+growAmount(server: Server, player: Person, threads: number, cores?: number): number;
+```
+
+## Parameters
+
+|  Parameter | Type | Description |
+|  --- | --- | --- |
+|  server | [Server](./bitburner.server.md) | Server info, typically from [getServer](./bitburner.ns.getserver.md) |
+|  player | [Person](./bitburner.person.md) | Player info, typically from [getPlayer](./bitburner.ns.getplayer.md) |
+|  threads | number | Number of threads to grow with. Can be fractional. |
+|  cores | number | _(Optional)_ Number of cores on the computer that will execute grow. |
+
+**Returns:**
+
+number
+
+The amount of money after the calculated grow.
+

markdown/bitburner.hackingformulas.growpercent.md

@@ -4,7 +4,13 @@
 
 ## HackingFormulas.growPercent() method
 
-Calculate the percent a server would grow to. Not exact due to limitations of mathematics. (Ex: 3.0 would grow the server to 300% of its current value.)
+Calculate the growth multiplier constant for a given server and threads.
+
+The actual amount of money grown depends both linearly \*and\* exponentially on threads; this is only giving the exponential part that is used for the multiplier. See [grow](./bitburner.ns.grow.md) for more details.
+
+As a result of the above, this multiplier does \*not\* depend on the amount of money on the server. Changing server.moneyAvailable and server.moneyMax will have no effect.
+
+For the most common use-cases, you probably want either [formulas.hacking.growThreads](./bitburner.hackingformulas.growthreads.md) or [formulas.hacking.growAmount](./bitburner.hackingformulas.growamount.md) instead.
 
 **Signature:**
 
@@ -17,7 +23,7 @@ growPercent(server: Server, threads: number, player: Person, cores?: number): nu
 |  Parameter | Type | Description |
 |  --- | --- | --- |
 |  server | [Server](./bitburner.server.md) | Server info, typically from [getServer](./bitburner.ns.getserver.md) |
-|  threads | number | Amount of thread. |
+|  threads | number | Amount of threads. Can be fractional. |
 |  player | [Person](./bitburner.person.md) | Player info, typically from [getPlayer](./bitburner.ns.getplayer.md) |
 |  cores | number | _(Optional)_ Number of cores on the computer that will execute grow. |
 

markdown/bitburner.hackingformulas.growthreads.md

@@ -4,7 +4,11 @@
 
 ## HackingFormulas.growThreads() method
 
-Calculate how many threads it will take to grow server to targetMoney. Starting money is server.moneyAvailable.
+Calculate how many threads it will take to grow server to targetMoney. Starting money is server.moneyAvailable. Note that when simulating the effect of [grow](./bitburner.ns.grow.md)<!-- -->, what matters is the state of the server and player when the grow \*finishes\*, not when it is started.
+
+The growth amount depends both linearly \*and\* exponentially on threads; see [grow](./bitburner.ns.grow.md) for more details.
+
+The inverse of this function is [formulas.hacking.growAmount](./bitburner.hackingformulas.growamount.md)<!-- -->, although it can work with fractional threads.
 
 **Signature:**
 

markdown/bitburner.hackingformulas.growtime.md

@@ -23,5 +23,5 @@ growTime(server: Server, player: Person): number;
 
 number
 
-The calculated grow time.
+The calculated grow time, in milliseconds.
 

markdown/bitburner.hackingformulas.hacktime.md

@@ -23,5 +23,5 @@ hackTime(server: Server, player: Person): number;
 
 number
 
-The calculated hack time.
+The calculated hack time, in milliseconds.
 

markdown/bitburner.hackingformulas.md

@@ -16,8 +16,9 @@ interface HackingFormulas
 
 |  Method | Description |
 |  --- | --- |
-|  [growPercent(server, threads, player, cores)](./bitburner.hackingformulas.growpercent.md) | Calculate the percent a server would grow to. Not exact due to limitations of mathematics. (Ex: 3.0 would grow the server to 300% of its current value.) |
-|  [growThreads(server, player, targetMoney, cores)](./bitburner.hackingformulas.growthreads.md) | Calculate how many threads it will take to grow server to targetMoney. Starting money is server.moneyAvailable. |
+|  [growAmount(server, player, threads, cores)](./bitburner.hackingformulas.growamount.md) | <p>Calculate the amount of money a grow action will leave a server with. Starting money is server.moneyAvailable. Note that when simulating the effect of [grow](./bitburner.ns.grow.md)<!-- -->, what matters is the state of the server and player when the grow \*finishes\*, not when it is started.</p><p>The growth amount depends both linearly \*and\* exponentially on threads; see [grow](./bitburner.ns.grow.md) for more details.</p><p>The inverse of this function is [formulas.hacking.growThreads](./bitburner.hackingformulas.growthreads.md)<!-- -->, although it rounds up to integer threads.</p> |
+|  [growPercent(server, threads, player, cores)](./bitburner.hackingformulas.growpercent.md) | <p>Calculate the growth multiplier constant for a given server and threads.</p><p>The actual amount of money grown depends both linearly \*and\* exponentially on threads; this is only giving the exponential part that is used for the multiplier. See [grow](./bitburner.ns.grow.md) for more details.</p><p>As a result of the above, this multiplier does \*not\* depend on the amount of money on the server. Changing server.moneyAvailable and server.moneyMax will have no effect.</p><p>For the most common use-cases, you probably want either [formulas.hacking.growThreads](./bitburner.hackingformulas.growthreads.md) or [formulas.hacking.growAmount](./bitburner.hackingformulas.growamount.md) instead.</p> |
+|  [growThreads(server, player, targetMoney, cores)](./bitburner.hackingformulas.growthreads.md) | <p>Calculate how many threads it will take to grow server to targetMoney. Starting money is server.moneyAvailable. Note that when simulating the effect of [grow](./bitburner.ns.grow.md)<!-- -->, what matters is the state of the server and player when the grow \*finishes\*, not when it is started.</p><p>The growth amount depends both linearly \*and\* exponentially on threads; see [grow](./bitburner.ns.grow.md) for more details.</p><p>The inverse of this function is [formulas.hacking.growAmount](./bitburner.hackingformulas.growamount.md)<!-- -->, although it can work with fractional threads.</p> |
 |  [growTime(server, player)](./bitburner.hackingformulas.growtime.md) | Calculate grow time. |
 |  [hackChance(server, player)](./bitburner.hackingformulas.hackchance.md) | Calculate hack chance. (Ex: 0.25 would indicate a 25% chance of success.) |
 |  [hackExp(server, player)](./bitburner.hackingformulas.hackexp.md) | Calculate hack exp for one thread. |

markdown/bitburner.hackingformulas.weakentime.md

@@ -23,5 +23,5 @@ weakenTime(server: Server, player: Person): number;
 
 number
 
-The calculated weaken time.
+The calculated weaken time, in milliseconds.
 

markdown/bitburner.hacknetcoresrequirement.hacknetcores.md

@@ -0,0 +1,11 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [bitburner](./bitburner.md) &gt; [HacknetCoresRequirement](./bitburner.hacknetcoresrequirement.md) &gt; [hacknetCores](./bitburner.hacknetcoresrequirement.hacknetcores.md)
+
+## HacknetCoresRequirement.hacknetCores property
+
+**Signature:**
+
+```typescript
+hacknetCores: number;
+```

markdown/bitburner.hacknetcoresrequirement.md

@@ -0,0 +1,21 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [bitburner](./bitburner.md) &gt; [HacknetCoresRequirement](./bitburner.hacknetcoresrequirement.md)
+
+## HacknetCoresRequirement interface
+
+Player's Hacknet devices must have at least this many total cores.
+
+**Signature:**
+
+```typescript
+interface HacknetCoresRequirement 
+```
+
+## Properties
+
+|  Property | Modifiers | Type | Description |
+|  --- | --- | --- | --- |
+|  [hacknetCores](./bitburner.hacknetcoresrequirement.hacknetcores.md) |  | number |  |
+|  [type](./bitburner.hacknetcoresrequirement.type.md) |  | "hacknetCores" |  |
+

markdown/bitburner.hacknetcoresrequirement.type.md

@@ -0,0 +1,11 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [bitburner](./bitburner.md) &gt; [HacknetCoresRequirement](./bitburner.hacknetcoresrequirement.md) &gt; [type](./bitburner.hacknetcoresrequirement.type.md)
+
+## HacknetCoresRequirement.type property
+
+**Signature:**
+
+```typescript
+type: "hacknetCores";
+```

markdown/bitburner.hacknetlevelsrequirement.hacknetlevels.md

@@ -0,0 +1,11 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [bitburner](./bitburner.md) &gt; [HacknetLevelsRequirement](./bitburner.hacknetlevelsrequirement.md) &gt; [hacknetLevels](./bitburner.hacknetlevelsrequirement.hacknetlevels.md)
+
+## HacknetLevelsRequirement.hacknetLevels property
+
+**Signature:**
+
+```typescript
+hacknetLevels: number;
+```