mirror of
https://github.com/bitburner-official/bitburner-src.git
synced 2026-04-23 09:42:53 +02:00
DOCUMENTATION: Use relative links instead of absolute links (#2521)
This commit is contained in:
catloversg
GitHub
@@ -32,12 +32,12 @@ Because of all the benefits this [BitNode](bitnodes.md) provides, it's definitel
|
||||
|
||||
## Depends on your priorities
|
||||
|
||||
BN4 gives access to the [Singularity API](https://github.com/bitburner-official/bitburner-src/blob/stable/markdown/bitburner.singularity.md).
|
||||
BN4 gives access to the [Singularity API](../../../../../markdown/bitburner.singularity.md).
|
||||
This mechanic allows the automation of many actions directly affecting the player.
|
||||
If this appeals to you then you should prioritize this BitNode.
|
||||
Due to the [RAM](../basic/ram.md) cost, it's strongly recommended to complete BN4.3 before using the [Singularity API](https://github.com/bitburner-official/bitburner-src/blob/stable/markdown/bitburner.singularity.md) in other [BitNodes](bitnodes.md).
|
||||
Due to the [RAM](../basic/ram.md) cost, it's strongly recommended to complete BN4.3 before using the Singularity API in other [BitNodes](bitnodes.md).
|
||||
|
||||
BN6 introduces the [Bladeburner](bladeburners.md) mechanic and its corresponding [Bladeburner API](https://github.com/bitburner-official/bitburner-src/blob/stable/markdown/bitburner.bladeburner.md).
|
||||
BN6 introduces the [Bladeburner](bladeburners.md) mechanic and its corresponding [Bladeburner API](../../../../../markdown/bitburner.bladeburner.md).
|
||||
Bladeburner is an alternative method to beat BitNodes which doesn't rely on money or hacking skill.
|
||||
[Sleeves](sleeves.md) help complete BN6 more quickly since they can share some Bladeburner tasks with the player but aren't a requirement.
|
||||
|
||||
@@ -70,7 +70,7 @@ It provides a variety of useful bonuses.
|
||||
|
||||
## Save these for later
|
||||
|
||||
BN7 used to give access to the [Bladeburner API](https://github.com/bitburner-official/bitburner-src/blob/stable/markdown/bitburner.bladeburner.md), but now it doesn't.
|
||||
BN7 used to give access to the [Bladeburner API](../../../../../markdown/bitburner.bladeburner.md), but now it doesn't.
|
||||
Because of that change this [BitNode](bitnodes.md) is relatively low priority and should definitely happen after BN6.
|
||||
The benefit for completing BN7.3 is an aug that lets the player perform [Bladeburner](bladeburners.md) and non-Bladeburner actions at the same time.
|
||||
|
||||
|
||||
@@ -24,7 +24,7 @@ In this BitNode, most forms of income such as working at a [Company](../basic/co
|
||||
[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.
|
||||
For example, there is one BitNode that grants access to the [Singularity API](https://github.com/bitburner-official/bitburner-src/blob/stable/markdown/bitburner.singularity.md).
|
||||
For example, there is one BitNode that grants access to the [Singularity API](../../../../../markdown/bitburner.singularity.md).
|
||||
There is another BitNode in which you can manage a [Gang](gang.md) to earn money and [Reputation](../basic/reputation.md).
|
||||
|
||||
## How to destroy a BitNode
|
||||
|
||||
@@ -46,7 +46,7 @@ Here is everything you will **KEEP** when you install an Augmentation:
|
||||
- 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/stable/markdown/bitburner.tix.md) Access
|
||||
- [World Stock Exchange account](stockmarket.md) and [TIX API](../../../../../markdown/bitburner.stock.md) Access
|
||||
|
||||
## Purchasing Multiple Augmentations
|
||||
|
||||
|
||||
@@ -29,7 +29,7 @@ Running this script from the terminal like `run script.js` or `./script.js` and
|
||||
|
||||
## AutocompleteData
|
||||
|
||||
To make this feature more useful, an [AutocompleteData](https://github.com/bitburner-official/bitburner-src/blob/stable/markdown/bitburner.autocompletedata.md) object is provided to the autocomplete function that holds information commonly passed as arguments to scripts, such as server names and filenames.
|
||||
To make this feature more useful, an [AutocompleteData](../../../../../markdown/bitburner.autocompletedata.md) object is provided to the autocomplete function that holds information commonly passed as arguments to scripts, such as server names and filenames.
|
||||
|
||||
AutocompleteData is an object with the following properties;
|
||||
|
||||
|
||||
@@ -3,7 +3,7 @@
|
||||
Coding Contracts are a mechanic that lets players earn rewards in exchange for solving programming problems.
|
||||
|
||||
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/stable/markdown/bitburner.codingcontract.md).
|
||||
They can be accessed through the [Terminal](terminal.md) or through [Scripts](scripts.md) using the [Coding Contract API](../../../../../markdown/bitburner.codingcontract.md).
|
||||
|
||||
Each contract has a limited number of attempts.
|
||||
If you provide the wrong answer too many times and exceed the number of attempts, the contract will self destruct (delete itself).
|
||||
@@ -22,21 +22,21 @@ The popup will display the contract's problem, the number of attempts remaining,
|
||||
|
||||
## Interacting through Scripts
|
||||
|
||||
See the [Coding Contract API](https://github.com/bitburner-official/bitburner-src/blob/stable/markdown/bitburner.codingcontract.md).
|
||||
See the [Coding Contract API](../../../../../markdown/bitburner.codingcontract.md).
|
||||
Interacting with Coding Contracts via the [Terminal](terminal.md) can be tedious the more contracts you solve.
|
||||
Consider using the [API](https://github.com/bitburner-official/bitburner-src/blob/stable/markdown/bitburner.codingcontract.md) to automate various aspects of your solution.
|
||||
Consider using the APIs to automate various aspects of your solution.
|
||||
For example, some contracts have long solutions while others have even longer solutions.
|
||||
You might want to use the [API](https://github.com/bitburner-official/bitburner-src/blob/stable/markdown/bitburner.codingcontract.md) to automate the process of submitting your solution rather than copy and paste a long solution into an answer box.
|
||||
The [Coding Contract API](https://github.com/bitburner-official/bitburner-src/blob/stable/markdown/bitburner.codingcontract.md) can also be used to find out useful information about a contract including the number of attempts you have left, the type of contract and its difficulty.
|
||||
It can also be used to test your algorithm for a specific contract type by [spawning dummy contracts](https://github.com/bitburner-official/bitburner-src/blob/stable/markdown/bitburner.codingcontract.createdummycontract.md).
|
||||
You might want to use the APIs to automate the process of submitting your solution rather than copy and paste a long solution into an answer box.
|
||||
The APIs can also be used to find out useful information about a contract including the number of attempts you have left, the type of contract and its difficulty.
|
||||
It can also be used to test your algorithm for a specific contract type by [spawning dummy contracts](../../../../../markdown/bitburner.codingcontract.createdummycontract.md).
|
||||
|
||||
However, using the [API](https://github.com/bitburner-official/bitburner-src/blob/stable/markdown/bitburner.codingcontract.md) comes at a cost.
|
||||
Like most functions in other APIs, almost all of the functions in the [Coding Contract API](https://github.com/bitburner-official/bitburner-src/blob/stable/markdown/bitburner.codingcontract.md) have a RAM cost.
|
||||
However, using the APIs comes at a cost.
|
||||
Like most functions in other APIs, almost all of the functions in the APIs have a RAM cost.
|
||||
|
||||
Depending on which function you use, the initial [RAM](ram.md) on your home server might not be enough to allow you to use various [API](https://github.com/bitburner-official/bitburner-src/blob/stable/markdown/bitburner.codingcontract.md) functions.
|
||||
Plan on upgrading the [RAM](ram.md) on your home server if you want to use the [Coding Contract API](https://github.com/bitburner-official/bitburner-src/blob/stable/markdown/bitburner.codingcontract.md).
|
||||
Depending on which function you use, the initial [RAM](ram.md) on your home server might not be enough to allow you to use various API functions.
|
||||
Plan on upgrading the [RAM](ram.md) on your home server if you want to use the APIs.
|
||||
|
||||
The [`getContractTypes`](https://github.com/bitburner-official/bitburner-src/blob/stable/markdown/bitburner.codingcontract.getcontracttypes.md) function is free, and returns a list of all of the contract types currently in the game.
|
||||
The [`getContractTypes`](../../../../../markdown/bitburner.codingcontract.getcontracttypes.md) function is free, and returns a list of all of the contract types currently in the game.
|
||||
|
||||
## Submitting Solutions
|
||||
|
||||
|
||||
@@ -47,7 +47,7 @@ For details on references in terminal commands, see [Terminal](terminal.md).
|
||||
|
||||
## Script Arguments
|
||||
|
||||
When running a script, you can use [flags](https://github.com/bitburner-official/bitburner-src/blob/stable/markdown/bitburner.ns.flags.md) and [arguments](https://github.com/bitburner-official/bitburner-src/blob/stable/markdown/bitburner.ns.args.md), which the script's logic can access and act on, allowing flexibility in your script designs. For example allowing you to get different results or attack different targets without re-writing your code:
|
||||
When running a script, you can use [flags](../../../../../markdown/bitburner.ns.flags.md) and [arguments](../../../../../markdown/bitburner.ns.args.md), which the script's logic can access and act on, allowing flexibility in your script designs. For example allowing you to get different results or attack different targets without re-writing your code:
|
||||
|
||||
$ run hack.js "harakiri-sushi"
|
||||
$ run hack.js "silver-helix"
|
||||
@@ -60,7 +60,7 @@ For example, if a script run with 1 thread is able to hack \$10,000, then runnin
|
||||
|
||||
[Note -- Scripts will not actually become multithreaded in the real-world sense - Javascript is a "single-threaded" coding language.]
|
||||
|
||||
When "multithreading" a script, the total [RAM](ram.md) cost can be calculated by simply multiplying the [RAM](ram.md) cost of a single instance of your script by the number of threads you will use. [See [`ns.getScriptRam()`](https://github.com/bitburner-official/bitburner-src/blob/stable/markdown/bitburner.ns.getscriptram.md) or the `mem` terminal command detailed below]
|
||||
When "multithreading" a script, the total [RAM](ram.md) cost can be calculated by simply multiplying the [RAM](ram.md) cost of a single instance of your script by the number of threads you will use. [See [`ns.getScriptRam()`](../../../../../markdown/bitburner.ns.getscriptram.md) or the `mem` terminal command detailed below]
|
||||
|
||||
## Never-ending scripts
|
||||
|
||||
|
||||
@@ -41,7 +41,7 @@ The player's home computer is special for a variety of reasons:
|
||||
(you will, however, lose programs and messages on your home computer).
|
||||
|
||||
The player can also purchase access to additional cloud servers for their use. These are virtual machines hosted remotely that the player has access to.
|
||||
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 in the [Cloud API](<(https://github.com/bitburner-official/bitburner-src/blob/stable/markdown/bitburner.cloud.md)>).
|
||||
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 in the [Cloud API](../../../../../markdown/bitburner.cloud.md).
|
||||
The advantage of cloud servers is that, in terms of [RAM](ram.md), they are cheaper than upgrading your home computer.
|
||||
The disadvantage is that access to your cloud servers is lost when you install [Augmentations](augmentations.md), and you will need to purchase access again.
|
||||
|
||||
|
||||
@@ -157,7 +157,7 @@ The potency of this effect is based on how effective you are when you work (i.e.
|
||||
## Automating the Stock Market
|
||||
|
||||
You can write scripts to perform automatic and algorithmic trading on the Stock Market.
|
||||
See [TIX API](https://github.com/bitburner-official/bitburner-src/blob/stable/markdown/bitburner.tix.md) for more details.
|
||||
See [Stock API](../../../../../markdown/bitburner.stock.md) for more details.
|
||||
|
||||
## Under the Hood
|
||||
|
||||
|
||||
@@ -553,10 +553,7 @@ Stanek Gift
|
||||
|
||||
** Documentation **
|
||||
|
||||
- The new documentation for the netscript API is available at
|
||||
https://github.com/bitburner-official/bitburner-src/blob/stable/markdown/bitburner.ns.md
|
||||
This documentation is used in-game to validate the code, in-editor to autocomplete, and
|
||||
for users to reference. This is a huge quality of life improvements for me.
|
||||
- The new documentation for the netscript API is available [here](../../../../markdown/bitburner.ns.md). This documentation is used in-game to validate the code, in-editor to autocomplete, and for users to reference. This is a huge quality of life improvements for me.
|
||||
|
||||
** Reputation **
|
||||
|
||||
|
||||
@@ -526,7 +526,7 @@
|
||||
- (Corporation) Add a missing check on exportMaterial (@catloversg)
|
||||
- (Corporation) Add ns.corporation.sellDivision (@catloversg)
|
||||
- (Formulas) Add ns.formulas.hacking.growAmount (@d0sboots)
|
||||
- (Go) Some changes to the Go API, including some minor breaking changes. Please refer to the API documentation in the script editor or at https://github.com/bitburner-official/bitburner-src/blob/stable/markdown/bitburner.go.md (@ficocelliguy)
|
||||
- (Go) Some changes to the Go API, including some minor breaking changes. Please refer to the [IPvGO API documentation](../../../../markdown/bitburner.go.md) (@ficocelliguy)
|
||||
- (Go) Added ns.go.analysis.getStats (@ficocelliguy)
|
||||
- (Go) Fix a bug that allowed facing secret opponent early or with wrong board size (@ficoccelliguy)
|
||||
- (Infiltration) More information is provided on ns.infiltration.getInfiltration (@catloversg)
|
||||
@@ -1176,8 +1176,8 @@ GRAFTING:
|
||||
DOCUMENTATION
|
||||
|
||||
- Many documentation updates (@Mughur, @d0sboots, @Snarling, @teauxfu).
|
||||
- Official non-markdown docs are at https://github.com/bitburner-official/bitburner-src/tree/dev/src/Documentation/doc
|
||||
- Official dev version markdown docs are at https://github.com/bitburner-official/bitburner-src/blob/stable/markdown/bitburner.ns.md
|
||||
- Official dev version non-markdown docs are at https://github.com/bitburner-official/bitburner-src/tree/dev/src/Documentation/doc/en
|
||||
- Official dev version markdown docs are at https://github.com/bitburner-official/bitburner-src/blob/dev/markdown/bitburner.ns.md
|
||||
- Official stable version markdown docs are at https://github.com/bitburner-official/bitburner-src/blob/stable/markdown/bitburner.ns.md
|
||||
- Dev version documentation is now kept up to date as changes are made. (@Snarling)
|
||||
|
||||
@@ -1202,7 +1202,7 @@ Hotfix / bugfix:
|
||||
- Fixed an issue with sleeve HP calculation
|
||||
- Possible fix for MathJax "Typesetting Failed" errors
|
||||
- There was an issue with Corporations decaying their employees to 0 stats, even though the minimum was supposed to be 5. Moved the variable storing the min decay value to corporation constants, and raised it to 10.
|
||||
- Regenerated documentation at https://github.com/bitburner-official/bitburner-src/blob/stable/markdown/bitburner.ns.md due to corporation changes related to min decay stats.
|
||||
- Regenerated [documentation](../../../../markdown/bitburner.ns.md) due to corporation changes related to min decay stats.
|
||||
- Faction XP was unintentionally providing 20x the experience gain as it did prior to v2.0. This caused faction work to exceed gym/university as the optimal way to gain experience. Values have been reduced to only about 2x what they were prior to v2.0, and they are no longer better than gym/university.
|
||||
- Fixed an issue where the overview skill bars could be displayed inaccurately based on player multipliers.
|
||||
|
||||
|
||||
@@ -348,7 +348,7 @@ Next, we're going to create a [Script](../basic/scripts.md) that automatically p
|
||||
These cloud [Servers](../basic/servers.md) will be used to run many [Scripts](../basic/scripts.md).
|
||||
Running this [Script](../basic/scripts.md) will initially be very expensive since purchasing a cloud [Server](../basic/servers.md) costs money, but it will pay off in the long run.
|
||||
|
||||
In order to create this [Script](../basic/scripts.md), you should familiarize yourself with the following functions, some of which are in the [Cloud API](<(https://github.com/bitburner-official/bitburner-src/blob/stable/markdown/bitburner.cloud.md)>):
|
||||
In order to create this [Script](../basic/scripts.md), you should familiarize yourself with the following functions, some of which are in the [Cloud API](../../../../../markdown/bitburner.cloud.md):
|
||||
|
||||
- `cloud.purchaseServer()`
|
||||
- `cloud.getServerCost()`
|
||||
|
||||
@@ -47,7 +47,7 @@
|
||||
|
||||
## Resources
|
||||
|
||||
- [NS API documentation](https://github.com/bitburner-official/bitburner-src/blob/stable/markdown/bitburner.ns.md)
|
||||
- [NS API documentation](../../../../markdown/bitburner.ns.md)
|
||||
- [Learn to program](programming/learn.md)
|
||||
- [Remote API](programming/remote_api.md)
|
||||
- [Game frozen or stuck?](programming/game_frozen.md)
|
||||
|
||||
@@ -58,4 +58,4 @@ To prevent this from happening make sure to multithread the scripts as much as p
|
||||
## Bug
|
||||
|
||||
Otherwise, the game is probably frozen/stuck due to a bug.
|
||||
To report a bug, follow the guidelines [here](https://github.com/bitburner-official/bitburner-src/blob/stable/CONTRIBUTING.md#reporting-bugs).
|
||||
To report a bug, follow the guidelines [here](../../../../../CONTRIBUTING.md#reporting-bugs).
|
||||
|
||||
@@ -4,7 +4,7 @@ IPvGO is a strategic territory control minigame accessible from DefComm in New T
|
||||
|
||||
For basic instructions, go to DefComm or CIA to access the current subnet, and look through the "How to Play" section. This document is specifically focused on building scripts to automate subnet takeover, which will be more applicable you have played a few subnets.
|
||||
|
||||
For a full list of all IpvGO methods and their descriptions and documentation, you can use the game's [API documentation page](https://github.com/bitburner-official/bitburner-src/blob/stable/markdown/bitburner.go.md).
|
||||
For a full list of all IPvGO methods and their descriptions and documentation, you can use the game's [IPvGO API documentation page](../../../../../markdown/bitburner.go.md).
|
||||
|
||||
|
||||
|
||||
|
||||
@@ -111,7 +111,7 @@ This means we must implement a delay into the scripts.
|
||||
|
||||
In older versions of the game, this required using `sleep` or `asleep` functions, which have a RAM cost of zero.
|
||||
However, due to JavaScript limitations, the delay duration is not millisecond-precise and can cause the functions to finish out of order.
|
||||
Instead, the hack, grow and weaken functions have a special [option](https://github.com/bitburner-official/bitburner-src/blob/stable/markdown/bitburner.basichgwoptions.md) called `additionalMsec` that allows more precise delays.
|
||||
Instead, the hack, grow and weaken functions have a special [option](../../../../../markdown/bitburner.basichgwoptions.md) called `additionalMsec` that allows more precise delays.
|
||||
|
||||
As well as the run time for each function, we also need information on the impact of a hack, grow or weaken thread on the target's security and/or money to optimise the thread ratios between the functions.
|
||||
This information can come from `formulas.exe` and use of the `getPlayer` and `getServer` functions, but cheaper functions such as `hackAnalyze`, `hackAnalyzeSecurity`, `getHackTime`, `growthAnalyze` and `growthAnalyzeSecurity` can still be used.
|
||||
|
||||
Reference in New Issue
Block a user