a2fd6736f4
The overloaded methods `NS.kill()`, `NS.getScriptExpGain()`, `NS.getScriptIncome()`, and `NS.scp()` have broken documentation because the overloaded function is not documented correctly. I've added `@inheritDoc` tags to the declarations in order to associate the documentation to the overloaded method. As shown in these files with broken documentation: https://github.com/danielyxie/bitburner/blob/dev/markdown/bitburner.ns.kill_1.md https://github.com/danielyxie/bitburner/blob/dev/markdown/bitburner.ns.scp_1.md https://github.com/danielyxie/bitburner/blob/dev/markdown/bitburner.ns.getscriptexpgain_1.md https://github.com/danielyxie/bitburner/blob/dev/markdown/bitburner.ns.getscriptincome_1.md |
||
|---|---|---|
| .github | ||
| assets | ||
| css | ||
| dist | ||
| doc | ||
| electron | ||
| markdown | ||
| src | ||
| test | ||
| tools | ||
| .browserslistrc | ||
| .dockerignore | ||
| .editorconfig | ||
| .eslintignore | ||
| .eslintrc.js | ||
| .gitattributes | ||
| .gitignore | ||
| .nojekyll | ||
| .prettierignore | ||
| .prettierrc | ||
| api-extractor.json | ||
| babel.config.js | ||
| cypress.json | ||
| editor.main.js | ||
| favicon.ico | ||
| index.html | ||
| jest.config.js | ||
| jest.setup.js | ||
| license.txt | ||
| main.css | ||
| main.css.map | ||
| package-lock.json | ||
| package.json | ||
| package.sh | ||
| README.md | ||
| requirements.txt | ||
| stylelint.config.js | ||
| tsconfig.json | ||
| tsdoc-metadata.json | ||
| webpack.config-test.js | ||
| 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://danielyxie.github.io/bitburner or installed through Steam.
See the frequently asked questions for more information . To discuss the game or get help, join the official discord server
Documentation
The game's official documentation can be found on Read The Docs. Please note that this is still a work-in-progress.
The in-game documentation is generated from the TypeScript definitions.
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 Documentor" 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 to @danielyxie to help coordinate the effort.