repository·dev·Indexed 23 days ago
https://github.com/bitburner-official/bitburner-srcDocumentation for Bitburner, a cyberpunk-themed incremental game centered around hacking and programming. This resource includes technical references for the Netscript (NS) API, guides for contributing new themes and achievements, and details on internal game mechanics such as ActiveFragments and Duplicate Sleeves. It also provides instructions for using developer tools like pretty-save.js, fetch-changelog, and Docker Compose for deployment.
Corporation is a highly profitable but complex feature in Bitburner. It involves multiple intertwined mechanisms that require careful management to avoid crippling your corporation's progress. For new players, it is recommended to focus on the core foundational sections before moving into advanced optimization.
Recommended learning path for beginners:
The Bitburner world is composed of six distinct cities. Each city features its own unique map, available Factions, and specific services including gyms, universities, hardware stores, and various places of work.
The six cities are:
Bonus Time is a mechanic that accumulates while the game is closed or the browser tab is inactive. For specific game mechanics that support it, Bonus Time significantly increases the rate of associated activities or tasks.
For example, in IPvGO, a move that normally takes 1 second might only take 200ms if a 5x Bonus Time effect is active. The specific impact of Bonus Time depends on the individual mechanic being used.
The product industry is a high-profit sector in the late game, allowing for significantly higher prices than the material industry.
CreationJobFactors and RP, resulting in better products and higher profits, which in turn funds more upgrades.A NetscriptPort is an object representing a serialized queue. It is used for inter-script communication.
Crucially, all methods in the NetscriptPort interface can be used even when the ns instance is "busy" (avoiding concurrency checks) or even when the ns instance is dead.
Infiltration allows you to enter a Company's facility to steal classified secrets, which can be sold for money or Faction Reputation.
Failing a challenge deals damage based on the location's starting security level. If your HP reaches 0, you are hospitalized and the infiltration ends immediately.
To target specific scripts with commands or functions, you can use two identification methods:
ns.run(), ns.exec(), etc., and visible in the output of ns.ps(). This is the most reliable way to target a specific running instance.Referencing Files:
When using functions to reference files (e.g., ns.run() or ns.rm()), you must use the full absolute file path. A full path must begin with a forward slash (/) if the file is not in the root directory.
ns.run("/scripts/hacking/helpers.myHelperScripts.js");
ns.rm("/logs/myHackingLogs.txt");
ns.rm("thisIsAFileInTheRootDirectory.txt");Dividends are payments to shareholders, while Retained Earnings are added back to the corporation's funds. Increasing the DividendRate increases player money but decreases corporation valuation.
Dividends are negatively affected by the TributeModifier (which depends on CorporationSoftcap).
$$TotalDividends = DividendRate \times (Revenue - Expenses) \times 10$$ $$Dividend = \left(OwnedShares \times \frac{TotalDividends}{TotalShares}\right)^{1 - TributeModifier}$$
ShadyAccounting reduces the modifier by 0.05.GovernmentPartnership reduces the modifier by 0.1.$$RetainedEarning = (1 - DividendRate) \times (Revenue - Expenses) \times 10$$
When running a script, you can pass flags and arguments. This allows a single script to behave differently (e.g., targeting different servers) without needing multiple script files. Arguments are accessed within the script's logic.
$ run hack.js "harakiri-sushi"
$ run hack.js "silver-helix"Sleeves have two primary status metrics that affect experience gain:
A value between 1 and 100 that scales experience earned.
Synchronize task.A value between 0 and 100 representing trauma from a new body. High shock reduces experience gain.
Shock Recovery task.Let X be the recovery ratio (100 - shock) / 100 and Y be the synchronization ratio synchronization / 100.
A experience, the sleeve gains A * X.A * X * Y.Z earns A * X * Y * Z.Warehouse congestion often occurs when input material purchases do not account for free space or existing stock, leading to a full warehouse that cannot accept new output units, thus halting production.
You can detect congestion by monitoring the productionAmount of output materials or products:
WarehouseCongestionData with keys formatted as ${divisionName}|${city}. The value is a counter of suspected congestion events.material.productionAmount and product.productionAmount for the output:productionAmount == 0: Increment the counter for that ${divisionName}|${city} entry.productionAmount > 0: Reset the counter for that entry to 0.Note: A threshold of 5 is used to reduce false positives caused by the initial startup of a Smart Supply script where production might naturally be 0.