3faed7caf2
This may seem unnecessary (and odd to import CSS files into JS...), but this sets up the project for being able to keep the distributed (release) resources all together, as well as setting the stage for introducing something like SCSS. |
||
|---|---|---|
| css | ||
| dist | ||
| doc | ||
| netscript_tests | ||
| src | ||
| tests | ||
| utils | ||
| .eslintignore | ||
| .eslintrc.js | ||
| .gitattributes | ||
| .gitignore | ||
| CONTRIBUTING.md | ||
| favicon.ico | ||
| index.html | ||
| license.txt | ||
| netscript.js | ||
| package-lock.json | ||
| package.json | ||
| README.md | ||
| stylelint.config.js | ||
| tsconfig.json | ||
| tslint.json | ||
| webpack.config.js | ||
Bitburner
Bitburner is a cyberpunk hacking-themed incremental game. The game can be played at https://danielyxie.github.io/bitburner.
Documentation
The game's official documentation can be found on Read The Docs. Please note that this is still a work-in-progress and is in its early stages.
The documentation is created using Sphinx.
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.
Wiki
The game's wiki can be found on Wikia. Please note that the wiki is in the process of being deprecated. Eventually all of the wiki content will be moved into the Read The Docs documentation.
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.