MCPcopy Index your code
hub / github.com/bitburner-official/bitburner-src

github.com/bitburner-official/bitburner-src @v3.0.1

Chat with this repo
repository ↗ · DeepWiki ↗ · release v3.0.1 ↗ · + Follow
5,130 symbols 14,194 edges 993 files 928 documented · 18%
What it actually does AI analysis from the code graph — generated when you open this
loading…
README

Bitburner

Join Discord

Build Status

Bitburner is a programming-based incremental game that revolves around hacking and cyberpunk themes. The game can be played at https://bitburner-official.github.io/ (release build), https://bitburner-official.github.io/bitburner-src/ (development build), or installed through Steam. The location of the release build may change in the near future.

See the frequently asked questions for more information. To discuss the game or get help, join the official Discord server.

Documentation

There are 2 types of documentation:

  • In-game documentation: It can be found in the Documentation tab. This is the best place to get up-to-date information. You can also read the web version at Documentation.
  • NS API documentation: It's generated from the TypeScript definitions. You can read it at API Documentation.

Anyone is welcome to contribute to the documentation by editing the source files and then making a pull request with your contributions. For further guidance, please refer to the "As A Documenter" section of CONTRIBUTING.

Contribution

There are many ways to contribute to the game. It can be as simple as fixing a typo, correcting a bug, or improving the UI. For guidance on doing so, please refer to the CONTRIBUTING document.

You will retain all ownership of the Copyright of any contributions you make, and will have the same rights to use or license your contributions. By submitting a pull request you agree to grant me perpetual, worldwide, non-exclusive, transferable, royalty-free, and irrevocable rights to use, publish, and distribute your contributions to the project. A formal Contributor's License Agreement will be drawn up in the future.

If you would like to make significant contributions to the project as a collaborator, please reach out in #suggestions or #development on Discord to help coordinate the effort.

Extension points exported contracts — how you extend this code

InfiltrationStage (Interface)
(no doc) [11 implementers]
src/Infiltration/InfiltrationStage.ts
RNG (Interface)
(no doc) [5 implementers]
src/Casino/RNG.ts
TeamActionWithCasualties (Interface)
(no doc) [4 implementers]
src/Bladeburner/Actions/TeamCasualties.ts
SleevePerson (Interface)
@public [1 implementers]
src/ScriptEditor/NetscriptDefinitions.d.ts
IProgressBarConfiguration (Interface)
Represents the possible configuration values that can be provided when creating the progress bar text.
src/utils/helpers/createProgressBarText.ts
IHacknetNode (Interface)
(no doc) [2 implementers]
src/Hacknet/IHacknetNode.ts
IServerMetadata (Interface)
* The metadata describing the base state of servers on the network. * These values will be adjusted based on Bitnode mu
src/Server/data/servers.ts
RemovedFunctionInfo (Interface)
Specify when a function was removed from the game, and its replacement function.
src/Netscript/APIWrapper.ts

Core symbols most depended-on inside this repo

push
called by 448
src/ui/React/Documentation.tsx
error
called by 417
src/Terminal/Terminal.ts
random
called by 297
src/Casino/RNG.ts
log
called by 187
src/Netscript/WorkerScript.ts
number
called by 180
src/ScriptEditor/NetscriptDefinitions.d.ts
log
called by 172
src/Script/RunningScript.ts
getNS
called by 161
test/jest/Utilities.ts
emit
called by 159
src/utils/EventEmitter.ts

Shape

Function 2,812
Method 1,404
Interface 570
Class 276
Enum 68

Languages

TypeScript100%

Modules by API surface

src/ScriptEditor/NetscriptDefinitions.d.ts675 symbols
src/Bladeburner/Bladeburner.ts52 symbols
src/Netscript/NetscriptHelpers.tsx46 symbols
src/Terminal/Terminal.ts44 symbols
tools/engines-check/semver.js43 symbols
src/Go/boardAnalysis/boardAnalysis.ts41 symbols
src/DarkNet/controllers/ServerGenerator.ts41 symbols
src/Corporation/Division.ts39 symbols
src/Faction/FactionJoinCondition.ts38 symbols
src/DevMenu/ui/BladeburnerDev.tsx38 symbols
src/PersonObjects/Player/PlayerObjectGeneralMethods.ts37 symbols
src/Corporation/Actions.ts36 symbols

For agents

$ claude mcp add bitburner-src \
  -- python -m otcore.mcp_server <graph>

⬇ download graph artifact