From d8a5f038e986a0f2c3d1343a3700e3c783da0173 Mon Sep 17 00:00:00 2001 From: Azoxey Date: Thu, 27 Jul 2023 05:05:46 -0500 Subject: [PATCH] fix typos, grammatical errors, remove outdated info --- src/Documentation/ui/doc/advanced/bitnodes.md | 2 +- src/Documentation/ui/doc/advanced/grafting.md | 2 +- .../ui/doc/advanced/hacknetservers.md | 4 +- src/Documentation/ui/doc/advanced/stanek.md | 4 +- .../ui/doc/basic/augmentations.md | 7 +- src/Documentation/ui/doc/basic/hacking.md | 2 +- .../ui/doc/basic/hacknet_nodes.md | 4 +- .../ui/doc/basic/infiltration.md | 8 +- src/Documentation/ui/doc/basic/ram.md | 4 +- src/Documentation/ui/doc/basic/reputation.md | 6 +- src/Documentation/ui/doc/basic/scripts.md | 9 +- src/Documentation/ui/doc/basic/servers.md | 24 +-- src/Documentation/ui/doc/basic/stats.md | 2 +- src/Documentation/ui/doc/basic/stockmarket.md | 2 +- src/Documentation/ui/doc/basic/terminal.md | 9 +- src/Documentation/ui/doc/basic/world.md | 6 +- .../ui/doc/help/bitnode_order.md | 14 +- .../ui/doc/help/getting_started.md | 177 +++++++++--------- .../ui/doc/programming/hackingalgorithms.md | 2 +- src/Documentation/ui/doc/programming/learn.md | 4 +- 20 files changed, 141 insertions(+), 151 deletions(-) diff --git a/src/Documentation/ui/doc/advanced/bitnodes.md b/src/Documentation/ui/doc/advanced/bitnodes.md index 5d8712591..c72aab1db 100644 --- a/src/Documentation/ui/doc/advanced/bitnodes.md +++ b/src/Documentation/ui/doc/advanced/bitnodes.md @@ -11,7 +11,7 @@ the Enders, using virtual simulations that trapped the minds of humans. However, the Enders didn't just create a single virtual reality to enslave humans, but many different simulations. In other words, there are many different BitNodes that exist. -These BitNode are very different from each other. +These BitNodes are very different from each other. jump3r tells you that the only hope for humanity is to destroy all of these BitNodes. Therefore, the end goal for the player is to enter and then destroy each BitNode. diff --git a/src/Documentation/ui/doc/advanced/grafting.md b/src/Documentation/ui/doc/advanced/grafting.md index 1987c5c31..e25ac8413 100644 --- a/src/Documentation/ui/doc/advanced/grafting.md +++ b/src/Documentation/ui/doc/advanced/grafting.md @@ -12,5 +12,5 @@ Be warned, some who have tested grafting have reported an unidentified malware. `Entropy`, this virus seems to grow in potency as more [Augmentations](../basic/augmentations.md) are grafted, causing unpredictable affects to the victim. -Note that when crafting an [Augmentation](../basic/augmentations.md), cancelling will **not** save your progress, +Note that when grafting an [Augmentation](../basic/augmentations.md), cancelling will **not** save your progress, and the money spent will **not** be returned. diff --git a/src/Documentation/ui/doc/advanced/hacknetservers.md b/src/Documentation/ui/doc/advanced/hacknetservers.md index 454187013..e34fe2c29 100644 --- a/src/Documentation/ui/doc/advanced/hacknetservers.md +++ b/src/Documentation/ui/doc/advanced/hacknetservers.md @@ -1,5 +1,5 @@ # Hacknet Servers -These are a very powerful upgrade to [Hacknet Nodes](../basic/hacknet_nodes.md). Instead of producing money the Hacknet Servers produce `hashes`. This currency can be exchanged for a variety of upgrade that boost most other mechanics of the game. +These are a very powerful upgrade to [Hacknet Nodes](../basic/hacknet_nodes.md). Instead of producing money, the Hacknet Servers produce `hashes`. This currency can be exchanged for a variety of upgrades that boost most other mechanics of the game. -They can also be used to run scripts on. However this reduces the amount of `hash` produced. +They can also be used to run scripts on. However, this reduces the amount of `hash` produced. diff --git a/src/Documentation/ui/doc/advanced/stanek.md b/src/Documentation/ui/doc/advanced/stanek.md index c23e88841..9348f438a 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 it's ~~bugs~~ features. The Gift is 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. +Allison is a bit crazy. But her special [Augmentation](../basic/augmentations.md) is very useful despites 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. -To increase the power of a fragment the `ns.stanek.charge()` function needs to be called. More thread means more power. +To increase the power of a fragment, the `ns.stanek.charge()` function needs to be called. More threads means more power. There are also special fragments called booster fragments which increase the power of the fragment it touches. diff --git a/src/Documentation/ui/doc/basic/augmentations.md b/src/Documentation/ui/doc/basic/augmentations.md index a22180d0c..36e742d7d 100644 --- a/src/Documentation/ui/doc/basic/augmentations.md +++ b/src/Documentation/ui/doc/basic/augmentations.md @@ -20,7 +20,7 @@ create them. Therefore, the only way for the player to obtain Augmentations is through [Factions](factions.md). After joining a [Faction](factions.md) and earning enough [Reputation](reputation.md) in it, you will be able to purchase its Augmentations. Different [Factions](factions.md) offer different Augmentations. Augmentations must be -purchased in order to be installed, and they are fairly expensive. They also require [Reputation](reputation.md) from a [Factions](factions.md) before they will let you purchase their Augmentations. +purchased in order to be installed, and they are fairly expensive. They also require [Reputation](reputation.md) with a [Faction](factions.md) before they will let you purchase their Augmentations. ## Installing Augmentations @@ -41,7 +41,7 @@ an Augmentation: - [Scripts](scripts.md) on all [servers](servers.md) EXCEPT your home computer - Purchased [servers](servers.md) - [Hacknet Nodes](hacknet_nodes.md) -- [Company](companies.md) / [Faction](factions.md) [Reputation](reputation.md), but you gain [Reputation](reputation.md). +- [Company](companies.md) / [Faction](factions.md) [Reputation](reputation.md), but you gain [Favor](reputation.md). - Jobs and [Faction](factions.md) memberships - Programs - [Stocks](stockmarket.md) @@ -49,11 +49,10 @@ an Augmentation: Here is everything you will KEEP when you install an Augmentation: -- Every Augmentation you have installed +- Every Augmentation you have previously installed - [Scripts](scripts.md) on your home computer - [RAM](ram.md) / Core Upgrades on your home computer - [World Stock Exchange account](stockmarket.md) and [TIX API](https://github.com/bitburner-official/bitburner-src/blob/dev/markdown/bitburner.tix.md) Access -- Previously installed Augmentations ## Purchasing Multiple Augmentations diff --git a/src/Documentation/ui/doc/basic/hacking.md b/src/Documentation/ui/doc/basic/hacking.md index 2e11bb56a..bc7d94fc4 100644 --- a/src/Documentation/ui/doc/basic/hacking.md +++ b/src/Documentation/ui/doc/basic/hacking.md @@ -93,7 +93,7 @@ value if you are trying to `weaken` it. ## Backdoors [server](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 +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/hacknet_nodes.md b/src/Documentation/ui/doc/basic/hacknet_nodes.md index 3a4f98cc8..6bebe07d5 100644 --- a/src/Documentation/ui/doc/basic/hacknet_nodes.md +++ b/src/Documentation/ui/doc/basic/hacknet_nodes.md @@ -1,7 +1,7 @@ # Hacknet nodes -This distributed network of computer allows you to gain money passively. By upgrading a nodes stats you can increase the amount of money it earns. If the cost gets too high it is also possile to purchase brand new nodes. +This distributed network of computers allows you to gain money passively. By upgrading a node's stats you can increase the amount of money it earns. If the cost gets too high, it is also possile to purchase brand new nodes. -Hacknet nodes won't make as much money as scripts but they can be useful at the start. +Hacknet nodes won't make as much money as scripts, but they can be useful at the start. There is a very powerful upgrade to them called [Hacknet Servers](../advanced/hacknetservers.md) diff --git a/src/Documentation/ui/doc/basic/infiltration.md b/src/Documentation/ui/doc/basic/infiltration.md index 42fcda853..5973b6930 100644 --- a/src/Documentation/ui/doc/basic/infiltration.md +++ b/src/Documentation/ui/doc/basic/infiltration.md @@ -12,7 +12,7 @@ these for money or for [Faction](factions.md) [Reputation](reputation.md). To tr visit a [Company](companies.md) through the [World](world.md) menu. There will be an option that says 'Infiltrate [Company](companies.md)'. -When infiltrating a [Company](companies.md) you will be presented with short active challenges. +When infiltrating a [Company](companies.md), you will be presented with short active challenges. None of the challenges use the mouse. The difficulty at the top lowers with better combat stats and charisma. It is not recommended @@ -32,7 +32,7 @@ infiltration will immediately end. ### Slash when his guard is down! Press space when the guard is preparing to attack you. -There's 3 phases +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. @@ -51,7 +51,7 @@ Use the arrows to find a compliment for the guard. ### Enter the Code! -Match the arrows as they appears. +Match the arrows as they appear. ### Match the symbols! @@ -59,7 +59,7 @@ 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 X. +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. ### Cut the wires diff --git a/src/Documentation/ui/doc/basic/ram.md b/src/Documentation/ui/doc/basic/ram.md index fcb53c4ed..f18443026 100644 --- a/src/Documentation/ui/doc/basic/ram.md +++ b/src/Documentation/ui/doc/basic/ram.md @@ -1,7 +1,7 @@ # RAM -In bitburner RAM determines how many [Scripts](scripts.md) can run on a [Server](servers.md). +In Bitburner, RAM determines how many [Scripts](scripts.md) can run on a [Server](servers.md). -Multiplying the number of threads a [Script](scripts.md) uses multiplies it RAM cost but also multiplies the effectiveness of several functions, like `ns.hack()`, `ns.grow()`, and `ns.weaken()`. +Multiplying the number of threads a [Script](scripts.md) uses multiplies its RAM cost, but also multiplies the effectiveness of several functions such as `ns.hack()`, `ns.grow()`, and `ns.weaken()`. You can purchase more RAM for your home computer from tech vendors. You can also use other computers as source of additional RAM. diff --git a/src/Documentation/ui/doc/basic/reputation.md b/src/Documentation/ui/doc/basic/reputation.md index 4fc6148eb..7e1158c35 100644 --- a/src/Documentation/ui/doc/basic/reputation.md +++ b/src/Documentation/ui/doc/basic/reputation.md @@ -1,9 +1,9 @@ # Reputation -In order to acquire [Augmentations](augmentations.md) from [Factions](factions.md) you need to acquire their trust. +In order to acquire [Augmentations](augmentations.md) from [Factions](factions.md), you need to earn their trust. -This can be done in a variety of ways but the most common is offering your services to a [Faction](faction.md). But also from [Infiltrations](infiltration.md). +This can be done in a variety of ways, but the most common is offering your services to a [Faction](faction.md). Another option is to give them intel from [Infiltrations](infiltration.md). -When installing [Augmentations](augmentations.md) all your reputation gets converted to favor. Favor increases the rate at which reputation is gained with that faction. +When installing [Augmentations](augmentations.md), all your reputation gets converted to favor. Favor increases the rate at which reputation is gained with that faction. With enough favor, donations are unlocked. Donations allow you to spend money to acquire reputation directly. Without working for the faction. This feature is particularily useful when a very large amount of reputation is needed for an augmentation. diff --git a/src/Documentation/ui/doc/basic/scripts.md b/src/Documentation/ui/doc/basic/scripts.md index 6303cd5e9..59a1bb593 100644 --- a/src/Documentation/ui/doc/basic/scripts.md +++ b/src/Documentation/ui/doc/basic/scripts.md @@ -2,7 +2,7 @@ Scripts are programs that can be used to automate the hacking process and almost every other part of the game. Scripts must be written -in javascript. +in JavaScript. It is highly recommended that you have a basic background in programming to start writing scripts. You by no means need to be an expert. All you @@ -17,9 +17,6 @@ When running a script, you can choose to pass arguments to that script. The script's logic can access and act on these arguments. This allows for flexibility in your scripts. -For information on how to run scripts with arguments, see -[Scripts](scripts.md) - ## Identifying a Script Many commands and functions act on an executing script @@ -154,7 +151,7 @@ Displays all active scripts and their [RAM](ram.md) usage ## Notes about how Scripts work offline -The scripts that you write and execute are in Javascript. +The scripts that you write and execute are in JavaScript. For this reason, it is not possible for these scripts to run while offline (when the game is closed). It is important to note that for this reason, conditionals such as `if`/`else` statements and certain @@ -173,7 +170,7 @@ when the game is online. These calculated rates are used to determine how many times these function calls would be made while the game is offline. -Also, note that because of the way the javascript engine works, whenever you reload or re-open the game all of the +Also, note that because of the way the JavaScript engine works, whenever you reload or re-open the game all of the scripts that you are running will start running from the BEGINNING of the code. The game does not keep track of where exactly the execution of a script is when it saves/loads. diff --git a/src/Documentation/ui/doc/basic/servers.md b/src/Documentation/ui/doc/basic/servers.md index 21ed860c3..7bbfcf74f 100644 --- a/src/Documentation/ui/doc/basic/servers.md +++ b/src/Documentation/ui/doc/basic/servers.md @@ -8,19 +8,19 @@ servers, see the [terminal](terminal.md) page. ## Server Statistics -Each server has it's own statistics, such as [RAM](ram.md), required hacking level and number of +Each server has its own statistics, such as [RAM](ram.md), required hacking level, and number of ports required to successfully `NUKE` it. Perhaps the most important property of a server to make note of is its [RAM](ram.md), which refers to how much memory is available on that machine. [RAM](ram.md) is important because it is required to run [Scripts](scripts.md). More [RAM](ram.md) allows -the user to run more powerful and complicated [scripts](scripts.md) as well as executing -a script with more threads. +the user to run more powerful and complicated [scripts](scripts.md), as well as executing +scripts with more threads. The `free`, `scan-analyze`, and `analyze` [Terminal](terminal.md) commands can be used to check how much [RAM](ram.md) a server has. -Some servers have some randomized statistics, such as [RAM](ram.md), max Money or +Some servers have some randomized statistics, such as [RAM](ram.md), max Money, or required hacking level. These statistics are randomly generated from a range of values. ## Identifying Servers @@ -46,15 +46,15 @@ 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. + certain locations in the [World](world.md). -2. The home computer persists through [Augmentation](augmentations.md) Installations. This means +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 + 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, or it 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. The advantage of purchased servers is that, in terms of [RAM](ram.md), they are cheaper than upgrading your home @@ -63,8 +63,8 @@ are lost when you install [Augmentations](augmentations.md). ## Hackable Servers -Most servers that are not owned by the player can be hacked for money -and exp. See the hacking page for more details. +Most servers that are not owned by the player can be [hacked](hacking.md) for money +and exp. Different servers have different levels of security, but also offer different rewards when being hacked. @@ -73,5 +73,5 @@ different rewards when being hacked. The servers are in a randomly organized tree-structure. The distance from the home computer to each server is fixed, but the exact route to them is -randomized when you install [augmentations](augmentations.md). In general the -further away from home computer a server is the higher it's statistics are. +randomized when you install [augmentations](augmentations.md). In general, the +further away from home computer a server is the higher its statistics are. diff --git a/src/Documentation/ui/doc/basic/stats.md b/src/Documentation/ui/doc/basic/stats.md index b03240da0..ae15e1688 100644 --- a/src/Documentation/ui/doc/basic/stats.md +++ b/src/Documentation/ui/doc/basic/stats.md @@ -12,7 +12,7 @@ Affects: - Time it takes to hack a server - Time it takes to execute the `grow()` and `weaken()` function - Chance to successfully hack a server -- Percent money stolen when hacking a server +- Percent of money stolen when hacking a server - Success rate of certain [crimes](crimes.md) - Time it takes to create a program - [Faction](factions.md) [Reputation](reputation.md) gain when carrying out Hacking Contracts or Field Work diff --git a/src/Documentation/ui/doc/basic/stockmarket.md b/src/Documentation/ui/doc/basic/stockmarket.md index f78cc0c04..dfbe343a0 100644 --- a/src/Documentation/ui/doc/basic/stockmarket.md +++ b/src/Documentation/ui/doc/basic/stockmarket.md @@ -19,7 +19,7 @@ world. So these concepts below should seem similar, but won't be exactly the sam When making a transaction on the stock market, there are two types of positions: Long and Short. A Long position is the typical scenario where you buy a stock and earn a profit if the price of that stock increases. Meanwhile, a Short position -is the exact opposite. In a Short position you purchase shares of a stock and +is the exact opposite. In a Short position, you purchase shares of a stock and earn a profit if the price of that stock decreases. This is also called 'shorting' a stock. diff --git a/src/Documentation/ui/doc/basic/terminal.md b/src/Documentation/ui/doc/basic/terminal.md index 2d6713a0a..b01bcbdfd 100644 --- a/src/Documentation/ui/doc/basic/terminal.md +++ b/src/Documentation/ui/doc/basic/terminal.md @@ -1,7 +1,7 @@ # Terminal The Terminal is a console emulator program that lets you interface with all of the -Servers in the game. The Terminal can be accessed by clicking the `Terminal` tab +[Servers](servers.md) in the game. The Terminal can be accessed by clicking the `Terminal` tab on the navigation menu on the left-hand side of the game (you may need to expand the 'Hacking' header in order to see the `Terminal` tab). Alternatively, the shortcut Alt + t can be used to open the Terminal. @@ -91,7 +91,7 @@ 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 its +2. 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`: @@ -109,8 +109,7 @@ Then if we run the following terminal command: We'll see the following in the Terminal: - Running script with 1 thread(s) and args: [123, 1000, "5", "this is a single argument"]. - May take a few seconds to start up the process... + Running script with 1 thread(s), pid 1 and args: [123, 1000, "5", "this is a single argument"]. argType.js: Number of args: 4 argType.js: number argType.js: number @@ -126,5 +125,5 @@ Example: $ run foo.js; tail foo.js -This does `not` wait for commands with a delay to finish executing, so it +This does **not** wait for commands with a delay to finish executing, so it generally doesn't work with things like `hack`, `wget`, etc. diff --git a/src/Documentation/ui/doc/basic/world.md b/src/Documentation/ui/doc/basic/world.md index 628695b92..11db7dfaf 100644 --- a/src/Documentation/ui/doc/basic/world.md +++ b/src/Documentation/ui/doc/basic/world.md @@ -9,6 +9,6 @@ In Bitburner, the world consists of six different cities: - Chongqing - Volhaven -Each city has it's own map and [Factions](factions.md). Each city also -offers different services, such as gyms, universities, hardware -stores and places of work. +Each city has its own map and [Factions](factions.md). Each city also +offers different services such as gyms, universities, hardware +stores, and places of work. diff --git a/src/Documentation/ui/doc/help/bitnode_order.md b/src/Documentation/ui/doc/help/bitnode_order.md index 7a7d756af..6e0c49d64 100644 --- a/src/Documentation/ui/doc/help/bitnode_order.md +++ b/src/Documentation/ui/doc/help/bitnode_order.md @@ -17,15 +17,15 @@ These paths do not recommend the absolute fastest path, since speed of progressi highly dependant on playing style. 1. Repeat BN-1 until you max out its [Source-File](../advanced/sourcefiles.md). Its [Source-File](../advanced/sourcefiles.md) - is extremely powerful, as it raises all multipliers by a significant amount. This also a let's you + is extremely powerful, as it raises all multipliers by a significant amount. This also allows you to get used to augments and other features resetting. 2. Do BN-3 at least once to unlock the [Corporation](../advanced/corporations.md) mechanic, finishing all - 3 levels unlocks the full API for free allowing fully scripted corp. This mechanic has highest + 3 levels unlocks the full API for free, allowing fully scripted corp. This mechanic has the highest profit potential in the game. 3. Do BN-10 once to unlock [Sleeves](../advanced/sleeves.md) and [Grafting](../advanced/grafting.md). [Sleeves](../advanced/sleeves.md) are useful in all nodes - and grafting can be useful in future [BitNodes](../advanced/bitnodes.md) (especially 8). It's recommended to buy all purchasable [Sleeves](../advanced/sleeves.md) and + and grafting can be useful in future [BitNodes](../advanced/bitnodes.md), especially BN-8. It's recommended to buy all purchasable [Sleeves](../advanced/sleeves.md) and their memory during the first run. The ordering of the next three is dependant on playing style and wants/needs. @@ -36,8 +36,8 @@ highly dependant on playing style. strong because [hacking](../basic/hacking.md) is typically one of the best ways of earning money. 5. Do BN-4. Its [Source-File](../advanced/sourcefiles.md) does not directly make you - more powerful in any way, but it does unlock the [Singularity API](https://github.com/bitburner-official/bitburner-src/blob/dev/markdown/bitburner.singularity.md) which - let you automate significantly more aspects of the game. Consider repeating until Level 3, + more powerful in any way, but unlocks the [Singularity API](https://github.com/bitburner-official/bitburner-src/blob/dev/markdown/bitburner.singularity.md). + This API allows you to automate significantly more aspects of the game. Consider repeating until Level 3, since each level decreases the [RAM](../basic/ram.md) cost of the functions. 6. Do BN-2 once to unlock the [Gang](../advanced/gang.md) mechanic. This mechanic @@ -105,12 +105,12 @@ simple money-generator to a more interesting mechanic. BN-10 unlocks two new mechanics: [Sleeves](../advanced/sleeves.md) and [Grafting](../advanced/grafting.md) BN-13 unlocks [Stanek's Gift](../advanced/stanek.md). This gift can improve skills, -[hacknet](../basic/hacknet_nodes.md) production and costs, working and [crime](../basic/crimes.md) gains as well [hacking](../basic/hacking.md) power and speed. +[hacknet](../basic/hacknet_nodes.md) production and costs, working and [crime](../basic/crimes.md) gains, and [hacking](../basic/hacking.md) power and speed. ## For a Challenge In general, the higher [BitNodes](../advanced/bitnodes.md) are more difficult than the lower ones. BN-12 is an obvious exception as it gets progressively harder. -BN-8 provides a unique challenge as the only method +BN-8 provides a unique challenge, as the only method of earning money in that [BitNode](../advanced/bitnodes.md) is through trading at the stock market. diff --git a/src/Documentation/ui/doc/help/getting_started.md b/src/Documentation/ui/doc/help/getting_started.md index 9a407b4fe..f5593083e 100644 --- a/src/Documentation/ui/doc/help/getting_started.md +++ b/src/Documentation/ui/doc/help/getting_started.md @@ -17,8 +17,8 @@ Bitburner is a cyberpunk-themed incremental RPG. The player progresses by raisin their [Stats](../basic/stats.md), earning money, and climbing the corporate ladder. Eventually, after reaching certain criteria, the player will begin receiving invitations from [Factions](../basic/factions.md). Joining these [Factions](../basic/factions.md) and working for them will unlock -[Augmentations](../basic/augmentations.md). Purchasing and installing [Augmentations](../basic/augmentations.md) provide persistent -upgrades and are necessary for progressing in the game. +[Augmentations](../basic/augmentations.md). Purchasing and installing [Augmentations](../basic/augmentations.md) provides persistent +upgrades and is necessary for progressing in the game. The game has a minimal story/quest-line that can be followed to reach the end of the game. Since this guide is only about getting started with Bitburner, it will not cover the @@ -27,7 +27,7 @@ entire "quest-line". ## First Steps I'm going to assume you followed the introductory tutorial when you first began the game. -In this introductory tutorial you created a [Script](../basic/scripts.md) called `n00dles.js` and ran it +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: @@ -57,7 +57,7 @@ Before we write the [Script](../basic/scripts.md), here are some things you'll w - `brutessh` - `nuke` -To briefly summarize the information from the links above: Each [Server](../basic/servers.md) has a +To briefly summarize: Each [Server](../basic/servers.md) has a security level that affects how difficult it is to hack. Each [Server](../basic/servers.md) also has a certain amount of money, as well as a maximum amount of money it can hold. [Hacking](../basic/hacking.md) a [Server](../basic/servers.md) steals a percentage of that [Server](../basic/servers.md)'s money. The `hack()` function @@ -117,7 +117,7 @@ Enter the following code in the [Script](../basic/scripts.md) editor: } The [Script](../basic/scripts.md) above contains comments that document what it does, but let's go through it -step-by-step anyways. +step-by-step anyway. const target = "n00dles"; @@ -138,7 +138,7 @@ The `getServerMaxMoney()` function is used to find this value const securityThresh = ns.getServerMinSecurityLevel(target); -This third command defines a numerical value representing the maximum security level +This third command defines a numerical value representing the minimum security level the target [Server](../basic/servers.md) can have. If the target [Server](../basic/servers.md)'s security level is higher than this value, then our [Script](../basic/scripts.md) will `weaken()` the [Script](../basic/scripts.md) before doing anything else. @@ -177,8 +177,8 @@ important is that await can only be used in functions marked `async` (note that ## Running our Scripts Now we want to start running our [hacking](../basic/hacking.md) [Script](../basic/scripts.md) so that it can start earning us -money and experience. Our home computer only has 8GB of [RAM](../basic/ram.md) and we'll be using it for -something else later. So instead, we'll take advantage of the [RAM](../basic/ram.md) on other machines. +money and experience. Our home computer only has 8GB of [RAM](../basic/ram.md), and we'll be using it for +something else later. Instead, we'll take advantage of the [RAM](../basic/ram.md) on other machines. Go to `Terminal` and enter the following command: @@ -234,7 +234,7 @@ Here's what mine showed at the time I made this: ┃ Number of open ports required to NUKE: 1 ┃ RAM: 32.00GB ┕ CSEC - Root Access: NO, Required hacking skill: 55 + Root Access: NO, Required hacking skill: 55 Number of open ports required to NUKE: 1 RAM: 8.00GB @@ -251,7 +251,8 @@ any open ports in order to NUKE. In other words, we can gain root access to all servers and then run [Scripts](../basic/scripts.md) on them. First, let's determine how many threads of our [hacking](../basic/hacking.md) [Script](../basic/scripts.md) we can run. -`Read more about multithreading scripts here` +(See the page on [scripts](../basic/scripts.md) for more information on multithreading.) + The [Script](../basic/scripts.md) we wrote uses 2.6GB of [RAM](../basic/ram.md). You can check this using the following `Terminal` command: @@ -328,21 +329,21 @@ higher required hacking levels. Therefore, we should raise our hacking level. No 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 by -clicking the `City` tab on the left-hand navigation menu, or you can use Alt + w. Rothman University should be one of the buttons -near the top. Click the button to go to the location. +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). Rothman University should be the "U" +near the bottom-right. Click the "U" to go to the location. Once you go to Rothman University, you should see a screen with several options. 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 the button -that says "Stop taking course". +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 clicking the `Stats` tab -on the left-hand navigation menu, or by using Alt + c. +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). 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! @@ -452,47 +453,43 @@ There are other ways to gain money in this game besides [Scripts](../basic/scrip ## Hacknet Nodes -If you completed the introductory tutorial, you were already introduced to this method: Hacknet Nodes. -Once you have enough money, you can start upgrading your Hacknet Nodes in order to increase -your passive income stream. This is completely optional. Since each Hacknet Node upgrade +If you completed the introductory tutorial, you were already introduced to this method: [Hacknet Nodes](../basic/hacknet_nodes.md). +Once you have enough money, you can start upgrading your [Hacknet Nodes](../basic/hacknet_nodes.md) in order to increase +your passive income stream. This is completely optional. Since each [Hacknet Node](../basic/hacknet_nodes.md) upgrade takes a certain amount of time to "pay itself off", it may not necessarily be in your best interest to use these. -Nonetheless, Hacknet Nodes are a good source of income early in the game, although -their effectiveness tapers off later on. If you do wind up purchasing and upgrading Hacknet Nodes, +Nonetheless, [Hacknet Nodes](../basic/hacknet_nodes.md) are a good source of income early in the game, although +their effectiveness tapers off later on. If you do wind up purchasing and upgrading [Hacknet Nodes](../basic/hacknet_nodes.md), I would suggest only upgrading their levels for now. I wouldn't bother with [RAM](../basic/ram.md) and Core upgrades until later on. ## Crime -The best source of income right now is from crimes. +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, click on the `City` tab on the left-hand -navigation menu or use the Alt + w. +hacking level. To commit [crimes](../basic/crimes.md), click on the `City` tab on the left-hand +navigation menu or press Alt + w. Then, click on the link that says `The Slums`. -In the Slums, you can attempt to commit a variety of crimes, each of which gives certain -types of experience and money if successful. See crimes for more details. +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. See [crimes](../basic/crimes.md) for more details. You are not always successful when you attempt to commit a crime. Nothing bad happens -if you fail a crime, but you won't earn any money and the experience gained will be -reduced. Raising your stats improves your chance of successfully committing a crime. +if you fail a [crime](../basic/crimes.md), but you won't earn any money and the experience gained will be +reduced. Raising your stats improves your chance of successfully committing a [crime](../basic/crimes.md). -Right now, the best option is the `Rob Store` crime. This takes 60 seconds to attempt -and gives $400k if successful. I suggest this crime because you don't have to click or check -in too often since it takes a whole minute to attempt. Furthermore, it gives hacking experience, -which is very important right now. +Right now, the best option is the `Rob Store` [crime](../basic/crimes.md). This takes 60 seconds to attempt, +gives $400k if successful, and gives hacking experience (which is very important right now). -Alternatively, you can also use the `Shoplift` crime. This takes 2 seconds to attempt -and gives $15k if successful. This crime is slightly easier and is more profitable -than `Rob Store`, but it requires constant clicking and it doesn't give -hacking experience. +Alternatively, you can also use the `Shoplift` [crime](../basic/crimes.md). This takes 2 seconds to attempt +and gives $15k if successful. This [crime](../basic/crimes.md) is slightly easier and more profitable +than `Rob Store`, but doesn't give hacking experience. ## Work for a Company -If you don't want to constantly check in on the game to commit crimes, there's another option -that's much more passive: working for a company. -This will not be nearly as profitable as crimes, but it's completely passive. +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 @@ -501,12 +498,10 @@ will appear that simply says `Work`. Click this to start working. Working at `Joe's Guns` earns $110 per second and also grants some experience for every stat except hacking. -Working for a company is completely passive. You can choose to focus on your work, do +Working for a [company](../basic/companies.md), like [crime](../basic/crimes.md), is completely passive. You can choose to focus on your work, do something else simultaneously, or switch between those two. While you focus on work, -you will not be able to do anything else in the game. If you do something else meanwhile, -you will not gain reputation at the same speed. You can cancel working at any time. -You'll notice that cancelling your work early causes you to lose out on some reputation -gains, but you shouldn't worry about this. Company reputation isn't important right now. +you will not be able to do anything else in the game. If you do something else simultaneously, +you will not gain [reputation](../basic/reputation.md) at the same speed. You can cancel working at any time. Once your hacking hits level 75, you can visit `Carmichael Security` in the city and get a software job there. This job offers higher pay and also earns you @@ -541,7 +536,6 @@ to open up SSH ports on [Servers](../basic/servers.md). This will allow you to h as many [Servers](../basic/servers.md) in the game require a certain number of opened ports in order for `NUKE.exe` to gain root access. -When you are creating a program, you cannot interact with any other part of the game. Feel free to cancel your work on creating a program at any time, as your progress will be saved and can be picked back up later. `BruteSSH.exe` takes about 10 minutes to complete. @@ -551,7 +545,7 @@ be saved and can be picked back up later. `BruteSSH.exe` takes about On the `Create Programs` page, you will notice another program you can create called `AutoLink.exe`. If you don't mind waiting another 10-15 minutes, you should go ahead and create this program. It makes it much less tedious to connect to other [Servers](../basic/servers.md), -but it's not necessary for progressing. +but it's not necessary for progression. ## Joining your first faction: CyberSec @@ -560,10 +554,11 @@ said this: Message received from unknown sender: - We've been watching you. Your skills are very impressive. But you're wasting - your talents. If you join us, you can put your skills to good use and change - the world for the better. If you join us, we can unlock your full potential. - But first, you must pass our test. Find and hack our server using the Terminal. + We've been watching you. Your skills are very impressive. But you're wasting your talents. + If you join us, you can put your skills to good use and change the world for the better. + If you join us, we can unlock your full potential. + + But first, you must pass our test. Find and install the backdoor on our server. -CyberSec @@ -576,9 +571,9 @@ your home computer. Enter the following `Terminal` commands to view the message: $ cat csec-test.msg This message is part of the game's main "quest-line". It is a message from the -|CyberSec faction| that is asking you to pass their test. -Passing their test is simple, you just have to find their [Server](../basic/servers.md) and hack it through -the `Terminal`. Their [Server](../basic/servers.md) is called `CSEC`. +`CyberSec` [faction](../basic/factions.md) that is asking you to pass their test. +Passing their test is simple, you just have to find their [Server](../basic/servers.md), hack it, and +install a backdoor through the `Terminal`. Their [Server](../basic/servers.md) is called `CSEC`. To do this, we'll use the `scan-analyze` Terminal command, just like we did before: @@ -630,14 +625,14 @@ using the `BruteSSH.exe` program we created earlier. In `Terminal`: $ run NUKE.exe $ backdoor -After you successfully install the backdoor, you should receive a faction +After you successfully install the backdoor, you should receive a [faction](../basic/factions.md) invitation from `CyberSec` shortly afterwards. Accept it. If you accidentally reject the invitation, that's okay. Just go to the `Factions` tab (Alt + f) and you should see an option that lets you accept the invitation. -Congrats! You just joined your first faction. Don't worry about doing anything -with this faction yet, we can come back to it later. +Congrats! You just joined your first [faction](../basic/factions.md). Don't worry about doing anything +with this [faction](../basic/factions.md) yet, we can come back to it later. ## Using Additional Servers to Hack Joesguns @@ -648,7 +643,7 @@ run [Scripts](../basic/scripts.md). We'll use the [RAM](../basic/ram.md) on thes ## Copying our Scripts -The [Server](../basic/servers.md)'s we'll be using to run our [Scripts](../basic/scripts.md) are: +The [Servers](../basic/servers.md) we'll be using to run our [Scripts](../basic/scripts.md) are: - `neo-net` - `zer0` @@ -690,19 +685,19 @@ production rate of $20k per second and had earned a total of $70 million. After another 15 minutes, the production rate had increased to $25k per second and the [Scripts](../basic/scripts.md) had made an additional $55 million. -Your results will vary based on how fast you earned money from crime/working/hacknet nodes, +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. +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, and from there select `CyberSec`. In the middle of +navigation menu (Alt + F), 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 for the `CyberSec` faction (as well -as some hacking experience). The higher your hacking level, the more reputation you -will gain. Note that while you are working for a faction, you can choose to not interact -with the rest of the game in any way to gain reputation at full speed. You can also select to -do something else simultaneously, gaining reputation a bit more slowly, until you focus again. -You can cancel your faction work at any time with no penalty to your reputation gained so far. +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. Note that while you are working for a [faction](../basic/factions.md), you can choose to not interact +with the rest of the game in any way to gain [reputation](../basic/reputation.md) at full speed. You can also select to +do something else simultaneously, gaining [reputation](../basic/reputation.md) a bit more slowly, until you focus again. +You can cancel your [faction](../basic/factions.md) work at any time with no penalty to your [reputation](../basic/reputation.md) gained so far. ## Purchasing Upgrades and Augmentations @@ -715,40 +710,40 @@ The most important thing to upgrade right now is the [RAM](../basic/ram.md) on y will allow you to run more [Scripts](../basic/scripts.md). To upgrade your [RAM](../basic/ram.md), go to the `City` tab and visit the company `Alpha Enterprises`. -There will be an option that says `Purchase additional RAM for Home Computer`. -Click it and follow the dialog box to upgrade your [RAM](../basic/ram.md). +There will be a button that says `Upgrade 'home' RAM (8.00GB -> 16.00GB) - $1.010m`. +Click it to upgrade your [RAM](../basic/ram.md). I recommend getting your home computer's [RAM](../basic/ram.md) to **at least** 128GB. Getting it even higher would be better. ## Purchasing your First Augmentations -Once you get ~1000 reputation with the `CyberSec` faction, you can purchase -your first `Augmentation` from them. +Once you get ~1000 [reputation](../basic/reputation.md) with the `CyberSec` [faction](../basic/factions.md), you can purchase +your first [Augmentation](../basic/augmentations.md) from them. To do this, go to the `Factions` tab on the left-hand navigation menu (Alt + f) and select `CyberSec`. There is an button near the bottom that says `Purchase Augmentations`. This will bring up a -page that displays all of the Augmentations available from `CyberSec`. Some of them +page that displays all of the [Augmentations](../basic/augmentations.md) available from `CyberSec`. Some of them may be locked right now. To unlock these, you will need to earn more -reputation with `CyberSec`. +[reputation](../basic/reputation.md) with `CyberSec`. -Augmentations give persistent upgrades in the form of multipliers. These aren't very +[Augmentations](../basic/augmentations.md) give persistent upgrades in the form of multipliers. These aren't very powerful early in the game because the multipliers are small. However, the effects -of Augmentations stack multiplicatively **with each other**, so as you continue to install -many Augmentations their effects will increase significantly. +of [Augmentations](../basic/augmentations.md) stack multiplicatively **with each other**, so as you continue to install +many [Augmentations](../basic/augmentations.md), their effects will increase significantly. Because of this, I would recommend investing more in [RAM](../basic/ram.md) upgrades for your home computer rather -than Augmentations early on. Having enough [RAM](../basic/ram.md) to run many [Scripts](../basic/scripts.md) will allow you to make -much more money, and then you can come back later on and get all these Augmentations. +than [Augmentations](../basic/augmentations.md) early on. Having enough [RAM](../basic/ram.md) to run many [Scripts](../basic/scripts.md) will allow you to make +much more money, and then you can come back later on and get all these [Augmentations](../basic/augmentations.md). -Right now, I suggest purchasing at the very least the `Neurotrainer I` Augmentation from +Right now, I suggest purchasing at the very least the `Neurotrainer I` [Augmentation](../basic/augmentations.md) from `CyberSec`. If you have the money to spare, I would also suggest getting `BitWire` and -several levels of the `NeuroFlux Governor` (`NFG`) Augmentations. Note that each time -you purchase an Augmentation, +several levels of the `NeuroFlux Governor` (`NFG`) [Augmentations](../basic/augmentations.md). Note that each time +you purchase an [Augmentation](../basic/augmentations.md), **the price of purchasing another increases by 90%**, -so make sure you buy the most expensive Augmentation first. Don't worry, once you choose to -install Augmentations, their prices will reset back to their original values. +so make sure you buy the most expensive [Augmentation](../basic/augmentations.md) first. Don't worry, once you choose to +install [Augmentations](../basic/augmentations.md), their prices will reset back to their original values. ## Next Steps @@ -764,19 +759,19 @@ The following are a few things you may want to consider doing in the near future ## Installing Augmentations (and Resetting) -If you've purchased any Augmentations, you'll need to install them before you -actually gain their effects. Installing Augmentations is the game's "soft-reset" or "prestige" -mechanic. You can [read more details about it here](). +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, click the `Augmentations` tab on the left-hand navigation -menu (Alt + a). You will see a list of all of the Augmentations +To install your [Augmentations](../basic/augmentations.md), click the `Augmentations` tab on the left-hand navigation +menu (Alt + a). 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). ## Automating the Script Startup Process -Whenever you install Augmentations, all of your [Scripts](../basic/scripts.md) are killed and you'll have to -re-run them. Doing this every time you install Augmentations would be very tedious and annoying, +Whenever you install [Augmentations](../basic/augmentations.md), all of your [Scripts](../basic/scripts.md) are killed and you'll have to +re-run them. Doing this every time you install [Augmentations](../basic/augmentations.md) would be very tedious and annoying, so you should write a [Script](../basic/scripts.md) to automate the process. Here's a simple example for a startup [Script](../basic/scripts.md). Feel free to adjust it to your liking. @@ -829,7 +824,7 @@ startup [Script](../basic/scripts.md). 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 + 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. This is because both of these functions use percentages rather than flat values. `hack()` steals a percentage of a [Server](../basic/servers.md)'s diff --git a/src/Documentation/ui/doc/programming/hackingalgorithms.md b/src/Documentation/ui/doc/programming/hackingalgorithms.md index 6c760a1d7..ee130c609 100644 --- a/src/Documentation/ui/doc/programming/hackingalgorithms.md +++ b/src/Documentation/ui/doc/programming/hackingalgorithms.md @@ -113,4 +113,4 @@ It is also important that these 4 scripts finish in the order specified above, a Batches only function predictably when the target server is at minimum security and maximum money, so your script must also handle preparing a server for your batches. You can utilize batches to prepare a server by using no hack threads during preparation. -Depending on your computer's performance as well as a few other factors, the necessary delay between script execution times may range between 20ms and 200ms, you want to fine-tune this value to be as low as possible while also avoiding your scripts finishing out of order. Anything lower than 20ms will not work due to javascript limitations. +Depending on your computer's performance as well as a few other factors, the necessary delay between script execution times may range between 20ms and 200ms, you want to fine-tune this value to be as low as possible while also avoiding your scripts finishing out of order. Anything lower than 20ms will not work due to JavaScript limitations. diff --git a/src/Documentation/ui/doc/programming/learn.md b/src/Documentation/ui/doc/programming/learn.md index c45b4ff02..dd45c4a78 100644 --- a/src/Documentation/ui/doc/programming/learn.md +++ b/src/Documentation/ui/doc/programming/learn.md @@ -1,4 +1,4 @@ -# Learn to Program in Javascript +# Learn to Program in JavaScript ## For Beginner Programmers @@ -32,5 +32,5 @@ is important further down. - [MDN Introduction to JS](https://developer.mozilla.org/en-US/docs/Web/JavaScript/A_re-introduction_to_JavaScript) - [Eloquent JavaScript (ES6+)](http://eloquentjavascript.net/) Recommended Chapters: Introduction, 1-6 -- [Modern Javascript Tutorial (ES6+)](https://javascript.info/) +- [Modern JavaScript Tutorial (ES6+)](https://javascript.info/) Recommended Chapters: 2, 4-6