From ac753dd17fe7e8850af417fecb810f2f3ad0feb1 Mon Sep 17 00:00:00 2001 From: Azoxey Date: Thu, 27 Jul 2023 18:00:59 -0500 Subject: [PATCH] correct more grammatical issues, be more consistent with shortcuts in guide, clean up formatting --- src/Documentation/ui/doc/advanced/bitnodes.md | 2 +- src/Documentation/ui/doc/advanced/sleeves.md | 12 +++---- src/Documentation/ui/doc/advanced/stanek.md | 2 +- .../ui/doc/basic/codingcontracts.md | 13 +++---- src/Documentation/ui/doc/basic/hacking.md | 26 ++++++-------- .../ui/doc/basic/infiltration.md | 14 ++++---- src/Documentation/ui/doc/basic/scripts.md | 2 +- src/Documentation/ui/doc/basic/servers.md | 11 +++--- src/Documentation/ui/doc/basic/stockmarket.md | 8 ++--- src/Documentation/ui/doc/basic/terminal.md | 8 ++--- .../ui/doc/help/getting_started.md | 34 ++++++++----------- .../ui/doc/programming/remote_api.md | 2 +- 12 files changed, 61 insertions(+), 73 deletions(-) diff --git a/src/Documentation/ui/doc/advanced/bitnodes.md b/src/Documentation/ui/doc/advanced/bitnodes.md index b7244fa53..ae72f7483 100644 --- a/src/Documentation/ui/doc/advanced/bitnodes.md +++ b/src/Documentation/ui/doc/advanced/bitnodes.md @@ -20,7 +20,7 @@ Different BitNodes grant different [Source-Files](sourcefiles.md). Each BitNode has unique characteristics that are related to varying backstories. For example, in one BitNode the world is in the middle of a financial catastrophe with a collapsing market. -In another BitNode, most forms of income such as working at a [Company](../basic/companies.md) or [Hacknet Nodes](../basic/hacknet_nodes.md) are significantly less profitable. +In this BitNode, most forms of income such as working at a [Company](../basic/companies.md) or [Hacknet Nodes](../basic/hacknet_nodes.md) are significantly less profitable. [Servers](../basic/servers.md) have less money on them and lowered growth rates, but it is easier to lower their security level using the `weaken` function. Furthermore, some BitNodes introduce new content and mechanics. diff --git a/src/Documentation/ui/doc/advanced/sleeves.md b/src/Documentation/ui/doc/advanced/sleeves.md index be627f810..baba2408f 100644 --- a/src/Documentation/ui/doc/advanced/sleeves.md +++ b/src/Documentation/ui/doc/advanced/sleeves.md @@ -28,12 +28,12 @@ Duplicate Sleeves are **not** reset when installing [Augmentations](../basic/aug There are two methods of obtaining Duplicate Sleeves: -1. Destroy [BitNode-10](bitnodes.md). - Each completion gives you one additional Duplicate Sleeve. -2. Purchase Duplicate Sleeves from The Covenant. - This is only available in [BitNode-10](bitnodes.md). - Sleeves purchased this way are **permanent** (they persist through [BitNodes](bitnodes.md)). - You can purchase up to 5 Duplicate Sleeves from The Covenant. +- Destroy [BitNode-10](bitnodes.md). + Each completion gives you one additional Duplicate Sleeve. +- Purchase Duplicate Sleeves from The Covenant. + This is only available in [BitNode-10](bitnodes.md). + Sleeves purchased this way are **permanent** (they persist through [BitNodes](bitnodes.md)). + You can purchase up to 5 Duplicate Sleeves from The Covenant. ## Synchronization diff --git a/src/Documentation/ui/doc/advanced/stanek.md b/src/Documentation/ui/doc/advanced/stanek.md index d2a11cfa9..92b191a11 100644 --- a/src/Documentation/ui/doc/advanced/stanek.md +++ b/src/Documentation/ui/doc/advanced/stanek.md @@ -1,7 +1,7 @@ # Stanek Allison is a bit crazy. -But her special [Augmentation](../basic/augmentations.md) is very useful despites its ~~bugs~~ features. +But her special [Augmentation](../basic/augmentations.md) is very useful despite its ~~bugs~~ features. The Gift consists of a grid of squares in which tetris-like pieces called fragments can be placed. Each fragment boost a different player multiplier. However, the fragments are not very powerful by themselves. diff --git a/src/Documentation/ui/doc/basic/codingcontracts.md b/src/Documentation/ui/doc/basic/codingcontracts.md index 47928f0d0..e93aec95d 100644 --- a/src/Documentation/ui/doc/basic/codingcontracts.md +++ b/src/Documentation/ui/doc/basic/codingcontracts.md @@ -2,7 +2,7 @@ Coding Contracts are a mechanic that lets players earn rewards in exchange for solving programming problems. -Coding Contracts are files with the `.cct` extensions. +Coding Contracts are files with the `.cct` extension. They can be accessed through the [Terminal](terminal.md) or through [Scripts](scripts.md) using the [Coding Contract API](https://github.com/bitburner-official/bitburner-src/blob/dev/markdown/bitburner.codingcontract.md). Each contract has a limited number of attempts. @@ -45,15 +45,12 @@ Otherwise, follow these rules when submitting solutions: - Array-type solutions should be submitted with each element in the array separated by commas. Brackets are optional. For example, both of the following are valid solution formats: - - `1,2,3` - `[1,2,3]` - -However, if the solution is a multidimensional array, then all arrays that are not the outer-most array DO require the brackets. -For example, an array of arrays can be submitted as one of the following: - -- `[1,2],[3,4]` -- `[[1,2],[3,4]]` +- If the solution is a multidimensional array, then all arrays that are not the outer-most array DO require the brackets. + For example, an array of arrays can be submitted as one of the following: + - `[1,2],[3,4]` + - `[[1,2],[3,4]]` Numeric solutions should be submitted normally, as expected diff --git a/src/Documentation/ui/doc/basic/hacking.md b/src/Documentation/ui/doc/basic/hacking.md index e9678e3bf..7d9233aec 100644 --- a/src/Documentation/ui/doc/basic/hacking.md +++ b/src/Documentation/ui/doc/basic/hacking.md @@ -20,24 +20,20 @@ These programs can be coded once your hacking skill gets high enough, or they ca **There are two ways to execute port-opening programs and the NUKE virus:** -1. Connect to the target [server](servers.md) through the [Terminal](terminal.md) and use the `run` command: - - $ run [programName] - -1. Use a function: - -- `nuke` -- `brutessh` -- `ftpcrack` -- `relaysmtp` -- `httpworm` -- `sqlinject` +- Connect to the target [server](servers.md) through the [Terminal](terminal.md) and use the `run` command: `$ run [programName]` +- Use a function: + - `nuke` + - `brutessh` + - `ftpcrack` + - `relaysmtp` + - `httpworm` + - `sqlinject` **There are two ways to determine how many ports need to be opened on a [server](servers.md) in order to successfully NUKE it:** -1. Connect to that [server](servers.md) through the [Terminal](terminal.md) and use the `analyze` command. -1. Use the `getServerNumPortsRequired` function. +- Connect to that [server](servers.md) through the [Terminal](terminal.md) and use the `analyze` command. +- Use the `getServerNumPortsRequired` function. Once you have enough ports opened on a [server](servers.md) and have ran the NUKE virus to gain root access, you will be able to hack it. @@ -79,7 +75,7 @@ This means that a [server](servers.md)'s security level will not fall below this ## Backdoors -[server](servers.md) that can be hacked can also have backdoors installed. +[Servers](servers.md) 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](servers.md) directly. diff --git a/src/Documentation/ui/doc/basic/infiltration.md b/src/Documentation/ui/doc/basic/infiltration.md index bc7ef04c3..ae83dfced 100644 --- a/src/Documentation/ui/doc/basic/infiltration.md +++ b/src/Documentation/ui/doc/basic/infiltration.md @@ -28,10 +28,12 @@ If you are reduced to `0` hp or below, the infiltration will immediately end. ### Slash when his guard is down! Press space when the guard is preparing to attack you. -There are 3 phases -The first is guarding, where attacking back will result in failure. -The 2nd is preparing, where attacking will result in a victory. -The 3rd is attack, where the guard will attack you resulting in failure. + +There are 3 phases: + +1. guarding - attacking back will result in failure. +2. preparing - attacking will result in a victory. +3. attacking - the guard will attack you resulting in failure. ### Close the brackets @@ -55,8 +57,8 @@ Move the cursor to the matching symbol and press space to confirm. ### Remember all the mines! -At first, the cursor cannot be moved - remember the positions of the mines. -Then move the cursor and press space to mark the mines on the board. +At first, the cursor cannot be moved - remember the positions of the mines. +Next, move the cursor and press space to mark the mines on the board. ### Cut the wires diff --git a/src/Documentation/ui/doc/basic/scripts.md b/src/Documentation/ui/doc/basic/scripts.md index c3dede3db..a838f6e7d 100644 --- a/src/Documentation/ui/doc/basic/scripts.md +++ b/src/Documentation/ui/doc/basic/scripts.md @@ -41,7 +41,7 @@ For example, if a normal single-threaded script is able to hack $10,000, then ru Scripts will not actually become multithreaded in the real-world sense.) When multithreading a script, the total [RAM](ram.md) cost can be calculated by simply multiplying the base [RAM](ram.md) cost of the script with the number of threads, where the base cost refers to the amount of [RAM](ram.md) required to run the script single-threaded. -In the [terminal](terminal.md), you can run the `mem` [Terminal](terminal.md) command to see how much [RAM](ram.md) a script requires with `n` threads:: +In the [terminal](terminal.md), you can run the `mem` [Terminal](terminal.md) command to see how much [RAM](ram.md) a script requires with `n` threads: $ mem [scriptname] -t n diff --git a/src/Documentation/ui/doc/basic/servers.md b/src/Documentation/ui/doc/basic/servers.md index c7df01ef8..2f0454e05 100644 --- a/src/Documentation/ui/doc/basic/servers.md +++ b/src/Documentation/ui/doc/basic/servers.md @@ -34,12 +34,11 @@ The player starts with a single server: his/her home computer. This server will have the hostname `home`. The player's home computer is special for a variety of reasons: -1. The home computer's [RAM](ram.md) can be upgraded. - This can be done by visiting certain locations in the [World](world.md). - -2. The home computer persists through [Augmentation](augmentations.md) installations. - This means that you will not lose any [RAM](ram.md) upgrades or [Scripts](scripts.md) on your home computer when you install [Augmentations](augmentations.md) - (you will, however, lose programs and messages on your home computer). +- The home computer's [RAM](ram.md) can be upgraded. + This can be done by visiting certain locations in the [World](world.md). +- The home computer persists through [Augmentation](augmentations.md) installations. + This means that you will not lose any [RAM](ram.md) upgrades or [Scripts](scripts.md) on your home computer when you install [Augmentations](augmentations.md) + (you will, however, lose programs and messages on your home computer). The player can also purchase additional servers. This can be done by visiting certain locations in the [World](world.md), or it can be done automatically through a script using the `purchaseServer` function. diff --git a/src/Documentation/ui/doc/basic/stockmarket.md b/src/Documentation/ui/doc/basic/stockmarket.md index 648cb7567..ed5900a8e 100644 --- a/src/Documentation/ui/doc/basic/stockmarket.md +++ b/src/Documentation/ui/doc/basic/stockmarket.md @@ -114,7 +114,7 @@ A Stop Order to sell will execute if the stock's price >= order's price. It is possible for your actions elsewhere in the game to influence the stock market. -Hacking +### Hacking If a server has a corresponding stock (e.g. _foodnstuff_ server -> FoodNStuff stock), then hacking that server can decrease the stock's second-order forecast. This causes the corresponding stock's forecast to trend downwards in value over time. @@ -124,7 +124,7 @@ The chance that hacking a server will cause this effect is based on what percent A single hack will have a minor effect, but continuously hacking a server for lots of money over time will have a noticeable effect in making the stock's forecast trend downwards. -## Growing +### Growing If a server has a corresponding stock (e.g. `foodnstuff` server -> FoodNStuff stock), then growing that server's money can increase the stock's second-order forecast. This causes the corresponding stock's forecast to trend upwards in value over time. @@ -134,12 +134,12 @@ The chance that growing a server will cause this effect is based on what percent A single grow operation will have a minor effect, but continuously growing a server for lots of money over time will have a noticeable effect in making the stock's forecast trend upwards. -## Working for a Company +### Working for a Company If a [Company](companies.md) has a corresponding stock, then working for that [Company](companies.md) will increase the corresponding stock's second-order forecast. This will cause the stock's forecast to (slowly) trend upwards in value over time. -The potency of this effect is based on how effective you are when you work (i.e. its based on your stats and multipliers). +The potency of this effect is based on how effective you are when you work (i.e. it's based on your stats and multipliers). ## Automating the Stock Market diff --git a/src/Documentation/ui/doc/basic/terminal.md b/src/Documentation/ui/doc/basic/terminal.md index 998a9dcc1..13da9bfab 100644 --- a/src/Documentation/ui/doc/basic/terminal.md +++ b/src/Documentation/ui/doc/basic/terminal.md @@ -84,11 +84,9 @@ For most terminal commands, this is all you need to know. When running scripts, however, it is important to know in more detail how arguments are parsed. There are two main points: -1. Quotation marks can be used to wrap a single argument and force it to be parsed as - a string. Any whitespace inside the quotation marks will not cause a new argument - to be parsed. -2. Anything that can represent a number is automatically cast to a number, unless it's - surrounded by quotation marks. +- Quotation marks can be used to wrap a single argument and force it to be parsed as a string. + Any whitespace inside the quotation marks will not cause a new argument to be parsed. +- Anything that can represent a number is automatically cast to a number, unless it's surrounded by quotation marks. Here's an example to show how these rules work. Consider the following script `argType.js`: diff --git a/src/Documentation/ui/doc/help/getting_started.md b/src/Documentation/ui/doc/help/getting_started.md index c76b59db9..e4e32cec7 100644 --- a/src/Documentation/ui/doc/help/getting_started.md +++ b/src/Documentation/ui/doc/help/getting_started.md @@ -1,6 +1,6 @@ # Getting Started Guide for Beginner Programmers -note: Note that the [Scripts](../basic/scripts.md) and strategies given in this guide aren't necessarily optimal. +_Note_: The [Scripts](../basic/scripts.md) and strategies given in this guide aren't necessarily optimal. They're just meant to introduce you to the game and help you get started. This is an introductory guide to getting started with Bitburner. @@ -26,11 +26,8 @@ I'm going to assume you followed the introductory tutorial when you first began In this introductory tutorial, you created a [Script](../basic/scripts.md) called `n00dles.js` and ran it on the `n00dles` server. Right now, we'll kill this [Script](../basic/scripts.md). There are two ways to do this: -1. You can go to the Terminal and enter: - - $ kill n00dles.js - -2. You can go to the `Active Scripts` page (Alt + s) and press the `Kill Script` button for `n00dles.js`. +- You can go to the Terminal and enter: `$ kill n00dles.js` +- You can go to the `Active Scripts` page (Alt + s) and press the `Kill Script` button for `n00dles.js`. If you skipped the introductory tutorial, then ignore the part above. Instead, go to the `Hacknet Nodes` page (Alt + h) and purchase a [Hacknet Node](../basic/hacknet_nodes.md) to start generating some passive income. @@ -306,7 +303,7 @@ Therefore, we should raise our hacking level. Not only will this let us hack more [Servers](../basic/servers.md), but it will also increase the effectiveness of our [hacking](../basic/hacking.md) against `n00dles`. The easiest way to train your hacking level is to visit Rothman University. -You can do this from the `City` tab on the left-hand navigation menu (click on it or press Alt + w). +You can do this from the `City` tab (Alt + w) on the left-hand navigation menu. Rothman University should be the "U" near the bottom-right. Click the "U" to go to the location. @@ -315,11 +312,11 @@ These options describe different courses you can take. You should click the first button, which says: `Study Computer Science (free)`. After you click the button, you will start studying and earning hacking experience. -While you are doing this, you cannot interact with any other part of the game until you click either "Stop taking course" or "Do something else simultaneously". +While you are doing this, you cannot interact with any other part of the game until you click either `Stop taking course` or `Do something else simultaneously`. Right now, we want a hacking level of 10. You need approximately 174 hacking experience to reach level 10. -You can check how much hacking experience you have by either hovering over the progress bar in the overview window or going to the `Stats` tab on the left-hand navigation menu (click on it or press Alt + c). +You can check how much hacking experience you have by going to the `Stats` tab (Alt + c) on the left-hand navigation menu. Since studying at Rothman University earns you 1 experience per second, this will take 174 seconds, or approximately 3 minutes. Feel free to do something in the meantime! @@ -339,7 +336,7 @@ At the top of the [Script](../basic/scripts.md), change the `target` variable to const target = "joesguns"; Note that this will **NOT** affect any instances of the [Script](../basic/scripts.md) that are already running. -This will only affect instances of the [Script](../basic/scripts.md) that are ran from this point forward. +This will only affect instances of the [Script](../basic/scripts.md) that are run from this point forward. ## Creating a New Script to Purchase New Servers @@ -435,7 +432,7 @@ I wouldn't bother with [RAM](../basic/ram.md) and Core upgrades until later on. The best source of income right now is from [crimes](../basic/crimes.md). This is because it not only gives you a large amount of money, but it also raises your hacking level. -To commit [crimes](../basic/crimes.md), click on the `City` tab on the left-hand navigation menu or press Alt + w. +To commit [crimes](../basic/crimes.md), go to the `City` tab (Alt + w). Then, click on the link that says `The Slums`. In the Slums, you can attempt to commit a variety of [crimes](../basic/crimes.md), each of which gives certain types of experience and money if successful. @@ -454,8 +451,8 @@ This [crime](../basic/crimes.md) is slightly easier and more profitable than `Ro ## Work for a Company -If you don't want to commit [crimes](../basic/crimes.md), there's another option - working for a [company](../basic/companies.md) -This will not be nearly as profitable as [crimes](../basic/crimes.md), but will provide [company](../basic/companies.md) [reputation](../basic/reputation.md) +If you don't want to commit [crimes](../basic/crimes.md), there's another option - working for a [company](../basic/companies.md). +This will not be nearly as profitable as [crimes](../basic/crimes.md), but will provide [company](../basic/companies.md) [reputation](../basic/reputation.md). Go to the `City` tab on the left-hand navigation menu and then go to `Joe's Guns`. At `Joe's Guns`, there will be an option that says `Apply to be an Employee`. @@ -492,10 +489,9 @@ Once you reach a hacking level of 50, two new important parts of the game open u ## Creating your first program: BruteSSH.exe -On the left-hand navigation menu you will notice a `Create Programs` tab with a red notification icon. +On the left-hand navigation menu you will notice a `Create Program` tab (Alt + p) with a red notification icon. This indicates that there are programs available to be created. -Click on that tab (or use Alt + p) and you'll see a -list of all the programs you can currently create. +Go to that tab, and you'll see a list of all the programs you can currently create. Hovering over a program will give a brief description of its function. Simply click on a program to start creating it. @@ -647,7 +643,7 @@ After another 15 minutes, the production rate had increased to $25k per second a Your results will vary based on how fast you earned money from [crime](../basic/crimes.md)/[working](../basic/companies.md)/[hacknet nodes](../basic/hacknet_nodes.md), but this will hopefully give you a good indication of how much the [Scripts](../basic/scripts.md) can earn. In the meantime, we are going to be gaining reputation with the `CyberSec` [faction](../basic/factions.md). -Go to the `Factions` tab on the left-hand navigation menu (Alt + F), and from there select `CyberSec`. +Go to the `Factions` tab (Alt + f) on the left-hand navigation menu, and from there select `CyberSec`. In the middle of the page there should be a button for `Hacking Contracts`. Click it to start earning [reputation](../basic/reputation.md) for the `CyberSec` [faction](../basic/factions.md) (as well as some hacking experience). The higher your hacking level, the more [reputation](../basic/reputation.md) you will gain. @@ -710,7 +706,7 @@ The following are a few things you may want to consider doing in the near future If you've purchased any [Augmentations](../basic/augmentations.md), you'll need to install them before you actually gain their effects. Installing [Augmentations](../basic/augmentations.md) is the game's "soft-reset" or "prestige" mechanic. -To install your [Augmentations](../basic/augmentations.md), click the `Augmentations` tab on the left-hand navigation menu (Alt + a). +To install your [Augmentations](../basic/augmentations.md), go to the `Augmentations` tab (Alt + a) on the left-hand navigation menu. You will see a list of all of the [Augmentations](../basic/augmentations.md) you have purchased. Below that, you will see a button that says `Install Augmentations`. Be warned, after clicking this there is no way to undo it (unless you load an earlier save). @@ -771,7 +767,7 @@ Feel free to adjust it to your liking. ## Random Tips - Early on in the game, it's better to spend your money on upgrading [RAM](../basic/ram.md) and purchasing new [Servers](../basic/servers.md) rather than spending it on [Augmentations](../basic/augmentations.md) -- The more money available on a [Server](../basic/servers.md), the more effective the `hack()` and `grow()` functions will be. +- The more money available on a [Server](../basic/servers.md), the more effective the `hack()` and `grow()` functions will be. This is because both of these functions use percentages rather than flat values. `hack()` steals a percentage of a [Server](../basic/servers.md)'s total available money, and `grow()` increases a [Server](../basic/servers.md)'s money by X%. - There is a limit to how much money can exist on a [Server](../basic/servers.md). diff --git a/src/Documentation/ui/doc/programming/remote_api.md b/src/Documentation/ui/doc/programming/remote_api.md index bf68d2a19..d775fd277 100644 --- a/src/Documentation/ui/doc/programming/remote_api.md +++ b/src/Documentation/ui/doc/programming/remote_api.md @@ -52,7 +52,7 @@ Create or update a file. ## `getFile` -Read a file and it's content. +Read a file and its content. { "jsonrpc": "2.0",