bitburner.readthedocs.io Open in urlscan Pro
2606:4700::6811:2152  Public Scan

Form analysis
2 forms found in the DOM

GET search.html

<form id="rtd-search-form" class="wy-form" action="search.html" method="get">
  <input type="text" name="q" placeholder="Search docs">
  <input type="hidden" name="check_keywords" value="yes">
  <input type="hidden" name="area" value="default">
</form>

GET //readthedocs.org/projects/bitburner/search/

<form id="flyout-search-form" class="wy-form" target="_blank" action="//readthedocs.org/projects/bitburner/search/" method="get">
  <input type="text" name="q" aria-label="Search docs" placeholder="Search docs">
</form>

Text Content

Bitburner
latest


Contents:

 * Full documentation
 * Basic documentation
 * Basic Gameplay
 * Advanced Gameplay
 * Remote API
 * Keyboard Shortcuts
 * Game Frozen or Stuck?
 * Guides & Tips
 * Tools & Resources
 * Changelog
 * v1.0.0 script migration guide
 * v2.0.0 script migration guide
 * 404
 * Donate

Comprehensive guide to SQL query optimization. Start optimizing your database
workloads.
Ad by EthicalAds   ·   ℹ️
Bitburner
 * Docs »
 * Welcome to Bitburner’s documentation!
 * Edit on GitHub

--------------------------------------------------------------------------------


WELCOME TO BITBURNER’S DOCUMENTATION!¶

Bitburner is a programming-based 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.


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.

Contents:

 * Full documentation
 * Basic documentation
   * Full documentation
   * Learn to Program
     * For Beginner Programmers
     * For Experienced Programmers
     * Netscript 1.0 vs Netscript 2.0
   * Netscript 1.0
     * Which ES6+ features are supported?
   * NetscriptJS (Netscript 2.0)
     * Browser compatibility
     * How to use ns2
     * Example
     * What’s with the weird comment
   * Script Arguments
   * Basic Functions
     * hack()
     * grow()
     * weaken()
     * sleep()
     * print()
     * tprint()
     * disableLog()
     * enableLog()
     * isLogEnabled()
     * scan()
     * nuke()
     * brutessh()
     * ftpcrack()
     * relaysmtp()
     * httpworm()
     * sqlinject()
     * run()
     * exec()
     * spawn()
     * kill()
     * killall()
     * scp()
     * ls()
     * ps()
     * hasRootAccess()
     * getHackingLevel()
     * getHackingMultipliers()
     * getHacknetMultipliers()
     * getServerMoneyAvailable()
     * getServerMaxMoney()
     * getServerSecurityLevel()
     * getServerMinSecurityLevel()
     * getServerRequiredHackingLevel()
     * getServerNumPortsRequired()
     * getServerMaxRam()
     * getServerUsedRam()
     * serverExists()
     * fileExists()
     * isRunning()
     * getPurchasedServerCost()
     * purchaseServer()
     * deleteServer()
     * getPurchasedServers()
     * getPurchasedServerLimit()
     * getPurchasedServerMaxRam()
     * scriptRunning()
     * scriptKill()
     * getScriptRam()
   * Advanced Functions
     * autocomplete()
     * Injecting HTML
   * Hacknet Node API
     * numNodes()
     * purchaseNode()
     * getPurchaseNodeCost()
     * getNodeStats()
     * upgradeLevel()
     * upgradeRam()
     * upgradeCore()
     * getLevelUpgradeCost()
     * getRamUpgradeCost()
     * getCoreUpgradeCost()
     * Referencing a Hacknet Node
     * RAM Cost
     * Utilities
     * Example(s)
   * Miscellaneous
     * Netscript Ports
     * Comments
     * Importing Functions
     * Standard, Built-In JavaScript Objects
 * Basic Gameplay
   * Stats
     * Hacking
     * Strength
     * Defense
     * Dexterity
     * Agility
     * Charisma
   * Terminal
     * Filesystem (Directories)
       * Directories
       * Absolute vs Relative Paths
       * Netscript
       * Missing Features
     * Commands
       * alias
       * analyze
       * backdoor
       * buy
       * cat
       * cd
       * check
       * clear/cls
       * connect
       * download
       * expr
       * free
       * hack
       * help
       * home
       * hostname
       * ifconfig
       * kill
       * killall
       * ls
       * lscpu
       * mem
       * mv
       * nano
       * ps
       * rm
       * run
       * scan
       * scan-analyze
       * scp
       * sudov
       * tail
       * top
       * unalias
       * wget
     * Argument Parsing
     * Chaining Commands
   * Servers
     * Server RAM
     * Identifying Servers
     * Player-owned Servers
     * Hackable Servers
   * Hacking
     * Gaining Root Access
     * General Hacking Mechanics
     * Server Security
     * Backdoors
   * Scripts
     * Script Arguments
     * Identifying a Script
     * Multithreading scripts
     * Working with Scripts in Terminal
     * Working with Scripts in Netscript
     * Notes about how Scripts Work Offline
   * World
   * Factions
     * List of Factions and their Requirements
   * Augmentations
     * How to acquire Augmentations
     * Installing Augmentations
     * Purchasing Multiple Augmentations
   * Companies
   * Crimes
     * Basic Mechanics
     * Crime details
   * Infiltration
     * Overview
   * Stock Market
     * Fundamentals
       * Positions: Long vs Short
       * Forecast & Second-Order Forecast
       * Spread (Bid Price & Ask Price)
       * Transactions Influencing Stock Forecast
       * Order Types
       * Player Actions Influencing Stocks
     * Automating the Stock Market
     * Under the Hood
     * Offline Progression
   * Coding Contracts
     * Running in Terminal
     * Interacting through Scripts
     * Submitting Solutions
     * Rewards
     * Notes
     * List of all Problem Types
 * Advanced Gameplay
   * BitNodes
     * What is a BitNode
     * How to destroy a BitNode
   * Source-Files
     * List of all Source-Files
   * Intelligence
   * Sleeves
     * Duplicate Sleeves
       * Obtaining Duplicate Sleeves
       * Synchronization
       * Sleeve Shock
       * Augmentations
       * Memory
   * Grafting
   * Hacking algorithms
     * Self-contained algorithms
     * Loop algorithms
     * Hacking managers (proto-batchers)
     * Batch algorithms (HGW, HWGW, or Cycles)
 * Remote API
   * Methods
     * pushFile
     * getFile
     * deleteFile
     * getFileNames
     * getAllFiles
     * calculateRam
     * getDefinitionFile
 * Keyboard Shortcuts
   * Game Navigation
   * Terminal Shortcuts
   * Terminal Bash Shortcuts
   * Popup/Dialog Box Shortcuts
 * Game Frozen or Stuck?
   * Infinite Loop in NetscriptJS
   * Blackscreen
   * Bug
 * Guides & Tips
   * Getting Started Guide for Beginner Programmers
     * Introduction
     * First Steps
     * Creating our First Script
     * Running our Scripts
     * Increasing Hacking Level
     * Editing our Hacking Script
     * Creating a New Script to Purchase New Servers
     * Additional Sources of Income
       * Hacknet Nodes
       * Crime
       * Work for a Company
     * After you Purchase your New Servers
     * Reaching a Hacking Level of 50
       * Creating your first program: BruteSSH.exe
       * Optional: Create AutoLink.exe
       * Joining your first faction: CyberSec
     * Using Additional Servers to Hack Joesguns
       * Copying our Scripts
     * Profiting from Scripts & Gaining Reputation with CyberSec
     * Purchasing Upgrades and Augmentations
       * Upgrading RAM on Home computer
       * Purchasing your First Augmentations
     * Next Steps
       * Installing Augmentations (and Resetting)
       * Automating the Script Startup Process
     * Random Tips
   * What BitNode should I do?
     * Overview of each BitNode
       * BitNode-1: Source Genesis
       * BitNode-2: Rise of the Underworld
       * BitNode-3: Corporatocracy
       * BitNode-4: The Singularity
       * BitNode-5: Artificial Intelligence
       * BitNode-6: Bladeburners
       * BitNode-7: Bladeburners 2079
       * BitNode-8: Ghost of Wall Street
       * BitNode-9: Hacktocracy
       * BitNode-10: Digital Carbon
       * BitNode-11: The Big Crash
       * BitNode-12: The Recursion
       * BitNode-13: They’re lunatics
     * Recommended BitNodes
       * For fast progression
       * For the strongest Source-Files
       * For more scripting/hacking
       * For new mechanics
       * For a Challenge
 * Tools & Resources
   * Official Script Repository
   * Visual Studio Code Extension
 * Changelog
   * v2.1.0 - 2022-09-23 Remote File API
   * v2.0.0 - 2022-07-19 Work rework
   * v1.6.3 - 2022-04-01 Few stanek fixes
   * v1.6.0 - 2022-03-29 Grafting
   * v1.5.0 - Steam Cloud integration
   * v1.4.0 - 2022-01-18 Sharing is caring
   * v1.3.0 - 2022-01-04 Cleaning up
   * v1.1.0 - 2021-12-18 You guys are awesome (community because they’re god
     damn awesome)
   * v1.1.0 - 2021-12-03 BN13: They’re Lunatics (hydroflame & community)
   * v1.0.2 - 2021-11-17 It’s the little things (hydroflame)
   * v1.0.1 - 2021-11-17 New documentation (hydroflame)
   * v1.0.0 - 2021-11-10 Breaking the API :( (blame hydroflame)
   * v0.58.0 - 2021-10-27 Road to Steam (hydroflame & community)
   * v0.57.0 - 2021-10-16 It was too cheap! (hydroflame & community)
   * v0.56.0 - 2021-10-11 Trimming the backlog (hydroflame & community)
   * v0.55.0 - 2021-09-20 Material UI (hydroflame & community)
   * v0.54.0 - 2021-09-20 One big react node (hydroflame & community)
   * v0.53.0 - 2021-09-09 Way too many things. (hydroflame & community)
   * v0.52.9 - 2021-08-27 Less lag! (hydroflame & community)
   * v0.52.8 - 2021-08-23 Fixing the previous patch tbh ROUND 2 (hydroflame)
   * v0.52.7 - 2021-08-21 Fixing the previous patch tbh (hydroflame)
   * v0.52.6 - 2021-08-21 Logboxes and VS-code (hydroflame)
   * v0.52.5 - 2021-08-19 CPU cores are useful!? (hydroflame)
   * v0.52.4 - 2021-08-19 Bladeburner in React (hydroflame)
   * v0.52.3 - 2021-08-15 Gangs were OP (hydroflame)
   * v0.52.2 - 2021-08-15 Oh yeah, BN11 is a thing (drunk hydroflame tbh)
   * v0.52.1 - 2021-08-10 bugfixing (hydroflame & community)
   * v0.52.0 - 2021-06-13 Infiltration 2.0 (hydroflame & community)
   * v0.51.10 - 2021-05-31 Focus Mark, Focus! (hydroflame)
   * v0.51.9 - 2021-05-17 offline progress and exports! (hydroflame & community)
   * v0.51.8 - 2021-05-07 It was there all along (hydroflame & community)
   * v0.51.7 - 2021-04-28 n00dles (hydroflame & community)
   * v0.51.6 - 2021-04-28 Backdoor! (hydroflame & community)
   * v0.51.5 - 2021-04-20 Flags! (hydroflame)
   * v0.51.4 - 2021-04-19 Manual hacking is fun (hydroflame)
   * v0.51.3 - 2021-04-16 Y’all broke it on the first day (hydroflame)
   * v0.51.2 - 2021-04-09 Vegas, Baby! (hydroflame)
   * v0.51.1 - 2021-04-06 Bugfixes because the author of the last patch sucks
     (it’s hydroflame)
   * v0.51.0 - 2021-03-31 Formulas (hydroflame)
   * v0.50.2 - 2021-03-25 Everyone asked for this one. (hydroflame)
   * v0.50.1 - 2021-03-22 (hydroflame)
   * v0.50.0 - 2021-03-20 Intelligence (hydroflame)
   * v0.49.2 - 2021-03-13 (hydroflame)
   * v0.49.0 - 2021-03-11 Source-File -1 (hydroflame)
   * v0.48.0 - ASCII - 2021-03-07 (hydroflame)
   * v0.47.2 - 7/15/2019
   * v0.47.1 - 6/27/2019
   * v0.47.0 - 5/17/2019
   * v0.46.3 - 4/20/2019
   * v0.46.2 - 4/14/2019
   * v0.46.1 - 4/12/2019
   * v0.46.0 - 4/3/2019
   * v0.45.1 - 3/23/2019
   * v0.45.0 - 3/22/2019
   * v0.44.1 - 3/4/2019
   * v0.44.0 - 2/26/2019
   * v0.43.1 - 2/11/2019
   * v0.43.0 - 2/4/2019
   * v0.42.0 - 1/8/2019
   * v0.41.2 - 11/23/2018
   * v0.41.1 - 11/5/2018
   * v0.41.0 - 10/29/2018
   * v0.40.5 - 10/09/2018
   * v0.40.4 - 9/29/2018
   * v0.40.3 - 9/15/2018
   * v0.40.2 - 8/27/2018
   * v0.40.1 - 8/5/2018 - Community Update
   * v0.40.0 - 7/28/2018
   * v0.39.1 - 7/4/2018
   * v0.39.0 - 6/25/2018
   * v0.38.1 - 6/15/2018
   * v0.38.0 - 6/12/2018
   * v0.37.2 - 6/2/2018
   * v0.37.1 - 5/22/2018
   * v0.37.0 - 5/20/2018
   * v0.36.1 - 5/11/2018
   * v0.36.0 - 5/2/2018
   * v0.35.2 - 3/26/2018
   * v0.35.1 - 3/12/2018
   * v0.35.0 - 3/3/2018
   * v0.34.5 - 2/24/2018
   * v0.34.4 - 2/14/2018
   * v0.34.3 - 1/31/2018
   * v0.34.2 - 1/27/2018
   * v0.34.1 - 1/19/2018
   * v0.34.0 - 12/6/2017
   * v0.33.0 - 12/1/2017
   * v0.32.1 - 11/2/2017
   * v0.32.0 - 10/25/2017
   * v0.31.0 - 10/15/2017
   * v0.30.0 - 10/9/2017
   * v0.29.3 - 10/3/2017
   * v0.29.2 - 10/1/2017
   * v0.29.1 - 9/27/2017
   * v0.29.0 - 9/19/2017
   * v0.28.6 - 9/15/2017
   * v0.28.5 - 9/13/2017
   * v0.28.4 - 9/11/2017
   * v0.28.3 - 9/7/2017
   * v0.28.2 - 9/4/2017
   * v0.28.1 - 9/1/2017
   * v0.28.0 - 8/30/2017
   * v0.27.3 - 8/19/2017
   * v0.27.2 - 8/18/2017
   * v0.27.1 - 8/15/2017
   * v0.27.0 - 8/13/2017
   * v0.26.4 - 8/1/2017
   * v0.26.3
   * v0.26.2
   * v0.26.1
   * v0.26.0
   * v0.25.0
   * v0.24.1
   * v0.24.0
   * v0.23.1
   * v0.23.0
   * v0.22.1
   * v0.22.0 - Major rebalancing, optimization, and favor system
   * v0.21.1
   * v0.21.0
   * v0.20.2
   * v0.20.1
   * v0.20.0
   * v0.19.7
   * v0.19.6
   * v0.19.0
   * v0.18.0
   * v0.17.1
   * v0.17.0
   * v0.16.0
   * v0.15.0
 * v1.0.0 script migration guide
 * v2.0.0 script migration guide
   * Working
   * commitCrime
   * getPlayer
   * workForCompany
   * getScriptIncome & getScriptExpGain
   * scp
   * Singularity
   * stock.buy, stock.sell, stock.short
   * corporation.bribe
 * 404
 * Donate


INDICES AND TABLES¶

 * Index
 * Module Index
 * Search Page

Next

--------------------------------------------------------------------------------

© Copyright 2016, Bitburner Revision e230d558.

Built with Sphinx using a theme provided by Read the Docs.
Read the Docs v: latest
Versions latest stable Downloads PDF HTML Epub On Read the Docs Project Home
Builds Downloads On GitHub View Edit Search


--------------------------------------------------------------------------------

Hosted by Read the Docs · Privacy Policy