From 6e028a0744ec2b756cd3c34ae939aeb14d9e6f84 Mon Sep 17 00:00:00 2001 From: Ryan McEntire <107779145+RyanMcEntire@users.noreply.github.com> Date: Tue, 2 May 2023 09:49:42 -0600 Subject: [PATCH] DOC: Grammar and spelling fixes (#499) --- doc/FAQ.md | 22 +++++++++++----------- doc/source/404.rst | 4 +--- doc/source/gamefrozen.rst | 10 +++++----- doc/source/index.rst | 4 ++-- 4 files changed, 19 insertions(+), 21 deletions(-) diff --git a/doc/FAQ.md b/doc/FAQ.md index bacb67b69..4e3b4da9d 100644 --- a/doc/FAQ.md +++ b/doc/FAQ.md @@ -2,7 +2,7 @@ ## Can I donate to the project? -No, the project does not take donation. +No, the project does not take donations. If you still want to donate, go donate blood to your local blood bank or donate to the [Electronic Frontier Foundation](https://www.eff.org/) or [Médecins Sans Frontières](https://www.msf.org/) @@ -27,25 +27,25 @@ You may have created an infinite loop with no sleep. You'll have to restart the - 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. + - If this does not work, when launching the game, use the kill all scripts option. --- ## Steam: Where is the save game located? -To maintain compatibility with the web browser version, the save game is not stored as a file on your filesystem. It lives inside the localStorage of the WebKit instance. You may export the save (and should backup it!) in the option menu. +To maintain compatibility with the web browser version, the save game is not stored as a file on your filesystem. It lives inside the localStorage of the WebKit instance. Export the save (and back it up!) in the option menu. --- ## Steam: Game won't stop / Game is shown as "Running" -Due to a limitation with the way Steam tracks the game, if you launch an external link (such as documentation), Steam may keep tracking the game as "Running" even after it is closed. You should simply have to close your web browser to fix this. +Due to a limitation with the way Steam tracks the game, if you launch an external link (such as documentation), Steam may keep tracking the game as "Running" even after it is closed. Simply close the web browser to fix this. --- ## Steam: How do I get to the game files? -You can navigate to the game files by right-clicking the game in your library and then go into "Manage" -> "Browse Local Files". The game can be launched directly from that location, if you're having issues with Steam. +Right-click the game in your Steam library, then go into "Manage" -> "Browse Local Files". The game can be launched directly from that location if you're having issues with Steam. --- @@ -55,13 +55,13 @@ You can navigate to the game files by right-clicking the game in your library an 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. +If you cannot move the game to another drive, you'll have to add `--no-sandbox` to the launch options. In your Steam Library, right click the game and hit "Properties". You'll see the "launch options" section in the "General" window. ### **On Linux** -The game is built natively, do not use Proton unless native does not work. +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). +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 options. 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). --- @@ -69,7 +69,7 @@ When launching the game, you will be prompted with three options. If the standar ### Logs (using [electron-log](https://github.com/megahertz/electron-log#readme)) -You may want access the logs to get information about crashes or such. +You may want to access the logs to get information about crashes and such. - on Linux: `~/.config/bitburner/logs/main.log` - on macOS: `~/Library/Logs/bitburner/main.log` @@ -77,7 +77,7 @@ You may want access the logs to get information about crashes or such. ### Config (using [electron-store](https://github.com/sindresorhus/electron-store#readme)) -Configuration file will be written to disk in the application data directory. +Configuration files can be found in the application's data directory. - on Linux: `~/.config/bitburner/config.json` - on macOS: `~/Library/Application\ Support/bitburner/config.json` @@ -87,4 +87,4 @@ Configuration file will be written to disk in the application data directory. ## Steam: What is the API Server? -The API Server allows the official [Visual Studio Code Extension](https://github.com/bitburner-official/bitburner-vscode) to push script file from VSCode to your in-game home. +The API Server allows the official [Visual Studio Code Extension](https://github.com/bitburner-official/bitburner-vscode) to push script files from VSCode to your in-game home. diff --git a/doc/source/404.rst b/doc/source/404.rst index 40276b042..3ad775052 100644 --- a/doc/source/404.rst +++ b/doc/source/404.rst @@ -3,6 +3,4 @@ Hi there, hello It looks like you found a page that doesn't exist! -If you're looking for documentation of the netscript API. It moved `here `_. - -That documentation is autogenerated and therefore is much easier to maintain. \ No newline at end of file +If you're looking for documentation of the Netscript API, it moved `here `_. \ No newline at end of file diff --git a/doc/source/gamefrozen.rst b/doc/source/gamefrozen.rst index cd7a6220e..a302524e7 100644 --- a/doc/source/gamefrozen.rst +++ b/doc/source/gamefrozen.rst @@ -19,7 +19,7 @@ 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 +Also make sure that each while loop gets to the `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) { @@ -33,11 +33,11 @@ function, but it nor any possible conditional breaks are never reached and there } } -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. +If `n00dles` current money is, for example, 75% of the maximum money, the script will reach neither `grow` nor `break` and the game will crash. +Adding a sleep like in the first example, or changing the code so that the `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:: +while loop, where the condition's change is conditional:: var ram = 8; var i = 0; @@ -51,7 +51,7 @@ while loop, that's condition's change is conditional:: } } -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. +If the 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. diff --git a/doc/source/index.rst b/doc/source/index.rst index 173989a2f..f26ce46c0 100644 --- a/doc/source/index.rst +++ b/doc/source/index.rst @@ -12,8 +12,8 @@ early beta stage of development. It `can be played here