| .github | ||
| assets | ||
| dist | ||
| doc | ||
| electron | ||
| lore | ||
| markdown | ||
| src | ||
| test | ||
| tools | ||
| .browserslistrc | ||
| .dockerignore | ||
| .editorconfig | ||
| .eslintignore | ||
| .eslintrc.js | ||
| .git_blame_ignore_revs | ||
| .gitattributes | ||
| .gitignore | ||
| .nojekyll | ||
| .npmrc | ||
| .prettierignore | ||
| .prettierrc | ||
| .readthedocs.yaml | ||
| api-extractor.json | ||
| babel.config.js | ||
| changelog.md | ||
| CODE_OF_CONDUCT.md | ||
| favicon.ico | ||
| FixJSDOMEnvironment.ts | ||
| jest.config.js | ||
| jest.polyfills.js | ||
| license.txt | ||
| package-lock.json | ||
| package.json | ||
| README.md | ||
| requirements.txt | ||
| tsconfig.json | ||
| webpack.config.js | ||
Bitburner
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 https://github.com/bitburner-official/bitburner-src/blob/stable/src/Documentation/doc/index.md.
- NS API documentation: It's generated from the TypeScript definitions. You can read it at https://github.com/bitburner-official/bitburner-src/blob/stable/markdown/bitburner.md.
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.