mirror of
https://github.com/bitburner-official/bitburner-src.git
synced 2024-11-23 08:03:48 +01:00
43 lines
1.8 KiB
ReStructuredText
43 lines
1.8 KiB
ReStructuredText
.. Bitburner documentation master file, created by
|
|
sphinx-quickstart on Wed Oct 4 15:03:07 2017.
|
|
You can adapt this file completely to your liking, but it should at least
|
|
contain the root `toctree` directive.
|
|
|
|
Welcome to Bitburner's documentation!
|
|
=====================================
|
|
Bitburner is a programming-based `incremental game <https://en.wikipedia.org/wiki/Incremental_game>`_
|
|
that revolves around hacking and cyberpunk themes. The game is currently in the
|
|
early beta stage of development. It `can be played here <https://bitburner-official.github.io/bitburner/>`_.
|
|
|
|
What is Bitburner?
|
|
------------------
|
|
Bitburner is a cyberpunk-themed incremental RPG where you, the player, take the role of an unknown hacker in a dark, dystopian world.
|
|
When a mysterious hacker called jump3R messages you, he/she confirms your suspicions that there is something wrong with the world around you.
|
|
Now, aided by jump3R, you embark on a quest to gain money and power by any means necessary, in the hopes that this will lead to to uncover the
|
|
secrets that you've been searching for.
|
|
|
|
.. toctree::
|
|
:maxdepth: 5
|
|
:caption: Contents:
|
|
|
|
Full documentation <https://github.com/bitburner-official/bitburner-src/blob/dev/markdown/bitburner.ns.md>
|
|
Basic documentation <netscript>
|
|
Basic Gameplay <basicgameplay>
|
|
Advanced Gameplay <advancedgameplay>
|
|
Remote API <remoteapi.rst>
|
|
Keyboard Shortcuts <shortcuts>
|
|
Game Frozen or Stuck? <gamefrozen>
|
|
Guides & Tips <guidesandtips>
|
|
Tools & Resources <toolsandresources>
|
|
Changelog <changelog>
|
|
v1.0.0 script migration guide <v1.0.0_migration.rst>
|
|
v2.0.0 script migration guide <v2.0.0_migration.rst>
|
|
404 <404.rst>
|
|
|
|
Indices and tables
|
|
==================
|
|
|
|
* :ref:`genindex`
|
|
* :ref:`modindex`
|
|
* :ref:`search`
|