2018-03-27 02:46:21 +02:00
# Bitburner
2021-09-05 01:09:30 +02:00
2022-01-04 17:00:04 +01:00
[](https://github.com/danielyxie/bitburner/actions/workflows/ci.yml)
2019-04-20 07:27:33 +02:00
Bitburner is a programming-based [incremental game ](https://en.wikipedia.org/wiki/Incremental_game )
that revolves around hacking and cyberpunk themes.
2022-01-04 17:00:04 +01:00
The game can be played at https://danielyxie.github.io/bitburner or installed through [Steam ](https://store.steampowered.com/app/1812820/Bitburner/ ).
2022-01-26 11:13:38 +01:00
See the [frequently asked questions ](./doc/FAQ.md ) for more information . To discuss the game or get help, join the [official discord server ](https://discord.gg/TFc3hKD )
2018-03-27 02:46:21 +02:00
# Documentation
2021-09-05 01:09:30 +02:00
2018-06-21 16:04:02 +02:00
The game's official documentation can be found on [Read The
2022-01-04 17:00:04 +01:00
Docs](http://bitburner.readthedocs.io/). Please note that this is still a work-in-progress.
2018-03-27 02:46:21 +02:00
2022-01-04 17:00:04 +01:00
The [in-game documentation ](./markdown/bitburner.md ) is generated from the [TypeScript definitions ](./src/ScriptEditor/NetscriptDefinitions.d.ts ).
2018-03-27 02:46:21 +02:00
2018-06-21 16:04:02 +02:00
Anyone is welcome to contribute to the documentation by editing the [source
files](/doc/source) and then making a pull request with your contributions.
For further guidance, please refer to the "As A Documentor" section of
2022-01-26 11:13:38 +01:00
[CONTRIBUTING ](./doc/CONTRIBUTING.md ).
2018-03-27 02:46:21 +02:00
2018-06-21 16:04:02 +02:00
# Contribution
2021-09-05 01:09:30 +02:00
2018-06-21 16:04:02 +02:00
There are many ways to contribute to the game. It can be as simple as fixing
2018-06-21 16:18:08 +02:00
a typo, correcting a bug, or improving the UI. For guidance on doing so,
2022-01-26 11:13:38 +01:00
please refer to the [CONTRIBUTING ](./doc/CONTRIBUTING.md ) document.
2018-03-27 02:46:21 +02:00
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
2018-06-21 16:04:02 +02:00
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.
2018-03-27 02:46:21 +02:00
If you would like to make significant contributions to the project as a
2019-03-15 10:37:06 +01:00
collaborator, please reach out to @danielyxie to help coordinate the effort.
