2018-01-09 21:48:06 +01:00
< !DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
< html xmlns = "http://www.w3.org/1999/xhtml" lang = "English" >
< head >
< meta http-equiv = "Content-Type" content = "text/html; charset=utf-8" / >
< title > Welcome to Bitburner' s documentation! — Bitburner 1.0 documentation< / title >
< link rel = "stylesheet" href = "_static/agogo.css" type = "text/css" / >
< link rel = "stylesheet" href = "_static/pygments.css" type = "text/css" / >
< script type = "text/javascript" >
var DOCUMENTATION_OPTIONS = {
URL_ROOT: './',
VERSION: '1.0',
COLLAPSE_INDEX: false,
FILE_SUFFIX: '.html',
HAS_SOURCE: true,
SOURCELINK_SUFFIX: '.txt'
};
< / script >
< script type = "text/javascript" src = "_static/jquery.js" > < / script >
< script type = "text/javascript" src = "_static/underscore.js" > < / script >
< script type = "text/javascript" src = "_static/doctools.js" > < / script >
< script type = "text/javascript" src = "https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.1/MathJax.js?config=TeX-AMS-MML_HTMLorMML" > < / script >
< link rel = "index" title = "Index" href = "genindex.html" / >
< link rel = "search" title = "Search" href = "search.html" / >
< link rel = "next" title = "Netscript Documentation" href = "netscript.html" / >
< / head >
< body >
< div class = "header-wrapper" role = "banner" >
< div class = "header" >
< div class = "headertitle" > < a
href="#">Bitburner 1.0 documentation< / a > < / div >
< div class = "rel" role = "navigation" aria-label = "related navigation" >
< a href = "netscript.html" title = "Netscript Documentation"
accesskey="N">next< / a > |
< a href = "genindex.html" title = "General Index"
accesskey="I">index< / a >
< / div >
< / div >
< / div >
< div class = "content-wrapper" >
< div class = "content" >
< div class = "document" >
< div class = "documentwrapper" >
< div class = "bodywrapper" >
< div class = "body" role = "main" >
< div class = "section" id = "welcome-to-bitburner-s-documentation" >
< h1 > Welcome to Bitburner's documentation!< a class = "headerlink" href = "#welcome-to-bitburner-s-documentation" title = "Permalink to this headline" > ¶< / a > < / h1 >
< p > Bitburner is a cyberpunk-themed < a class = "reference external" href = "https://en.wikipedia.org/wiki/Incremental_game" > incremental game< / a > that is currently in the
early beta stage of development. The game < a class = "reference external" href = "https://danielyxie.github.io/bitburner/" > can be played here< / a > .< / p >
< div class = "section" id = "what-is-bitburner" >
< h2 > What is Bitburner?< a class = "headerlink" href = "#what-is-bitburner" title = "Permalink to this headline" > ¶< / a > < / h2 >
< p > 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.< / p >
< div class = "toctree-wrapper compound" >
< p class = "caption" > < span class = "caption-text" > Contents:< / span > < / p >
< ul >
< li class = "toctree-l1" > < a class = "reference internal" href = "netscript.html" > Netscript< / a > < ul >
< li class = "toctree-l2" > < a class = "reference internal" href = "netscriptdatatypes.html" > Data Types and Variables< / a > < ul >
< li class = "toctree-l3" > < a class = "reference internal" href = "netscriptdatatypes.html#data-types" > Data Types< / a > < / li >
< li class = "toctree-l3" > < a class = "reference internal" href = "netscriptdatatypes.html#variables" > Variables< / a > < / li >
< / ul >
< / li >
< li class = "toctree-l2" > < a class = "reference internal" href = "netscriptoperators.html" > Operators< / a > < ul >
< li class = "toctree-l3" > < a class = "reference internal" href = "netscriptoperators.html#operators" > Operators< / a > < ul >
< li class = "toctree-l4" > < a class = "reference internal" href = "netscriptoperators.html#binary-operators" > Binary Operators< / a > < / li >
< li class = "toctree-l4" > < a class = "reference internal" href = "netscriptoperators.html#unary-operators" > Unary Operators< / a > < / li >
< / ul >
< / li >
< / ul >
< / li >
2018-02-24 23:55:06 +01:00
< li class = "toctree-l2" > < a class = "reference internal" href = "netscriptloopsandconditionals.html" > Loops and Conditionals< / a > < / li >
2018-01-09 21:48:06 +01:00
< li class = "toctree-l2" > < a class = "reference internal" href = "netscriptscriptarguments.html" > Script Arguments< / a > < / li >
< li class = "toctree-l2" > < a class = "reference internal" href = "netscriptfunctions.html" > Basic Functions< / a > < ul >
< li class = "toctree-l3" > < a class = "reference internal" href = "netscriptfunctions.html#hack" > hack< / a > < / li >
< li class = "toctree-l3" > < a class = "reference internal" href = "netscriptfunctions.html#grow" > grow< / a > < / li >
< li class = "toctree-l3" > < a class = "reference internal" href = "netscriptfunctions.html#weaken" > weaken< / a > < / li >
< li class = "toctree-l3" > < a class = "reference internal" href = "netscriptfunctions.html#sleep" > sleep< / a > < / li >
< li class = "toctree-l3" > < a class = "reference internal" href = "netscriptfunctions.html#print" > print< / a > < / li >
< li class = "toctree-l3" > < a class = "reference internal" href = "netscriptfunctions.html#tprint" > tprint< / a > < / li >
2018-02-24 23:55:06 +01:00
< li class = "toctree-l3" > < a class = "reference internal" href = "netscriptfunctions.html#clearlog" > clearLog< / a > < / li >
< li class = "toctree-l3" > < a class = "reference internal" href = "netscriptfunctions.html#disablelog" > disableLog< / a > < / li >
< li class = "toctree-l3" > < a class = "reference internal" href = "netscriptfunctions.html#enablelog" > enableLog< / a > < / li >
2018-01-09 21:48:06 +01:00
< li class = "toctree-l3" > < a class = "reference internal" href = "netscriptfunctions.html#scan" > scan< / a > < / li >
< li class = "toctree-l3" > < a class = "reference internal" href = "netscriptfunctions.html#nuke" > nuke< / a > < / li >
< li class = "toctree-l3" > < a class = "reference internal" href = "netscriptfunctions.html#brutessh" > brutessh< / a > < / li >
< li class = "toctree-l3" > < a class = "reference internal" href = "netscriptfunctions.html#ftpcrack" > ftpcrack< / a > < / li >
< li class = "toctree-l3" > < a class = "reference internal" href = "netscriptfunctions.html#relaysmtp" > relaysmtp< / a > < / li >
< li class = "toctree-l3" > < a class = "reference internal" href = "netscriptfunctions.html#httpworm" > httpworm< / a > < / li >
< li class = "toctree-l3" > < a class = "reference internal" href = "netscriptfunctions.html#sqlinject" > sqlinject< / a > < / li >
< li class = "toctree-l3" > < a class = "reference internal" href = "netscriptfunctions.html#run" > run< / a > < / li >
< li class = "toctree-l3" > < a class = "reference internal" href = "netscriptfunctions.html#exec" > exec< / a > < / li >
2018-02-15 05:34:57 +01:00
< li class = "toctree-l3" > < a class = "reference internal" href = "netscriptfunctions.html#spawn" > spawn< / a > < / li >
2018-01-09 21:48:06 +01:00
< li class = "toctree-l3" > < a class = "reference internal" href = "netscriptfunctions.html#kill" > kill< / a > < / li >
< li class = "toctree-l3" > < a class = "reference internal" href = "netscriptfunctions.html#killall" > killall< / a > < / li >
< li class = "toctree-l3" > < a class = "reference internal" href = "netscriptfunctions.html#exit" > exit< / a > < / li >
< li class = "toctree-l3" > < a class = "reference internal" href = "netscriptfunctions.html#scp" > scp< / a > < / li >
< li class = "toctree-l3" > < a class = "reference internal" href = "netscriptfunctions.html#ls" > ls< / a > < / li >
< li class = "toctree-l3" > < a class = "reference internal" href = "netscriptfunctions.html#hasrootaccess" > hasRootAccess< / a > < / li >
< li class = "toctree-l3" > < a class = "reference internal" href = "netscriptfunctions.html#gethostname" > getHostname< / a > < / li >
< li class = "toctree-l3" > < a class = "reference internal" href = "netscriptfunctions.html#gethackinglevel" > getHackingLevel< / a > < / li >
< li class = "toctree-l3" > < a class = "reference internal" href = "netscriptfunctions.html#gethackingmultipliers" > getHackingMultipliers< / a > < / li >
< li class = "toctree-l3" > < a class = "reference internal" href = "netscriptfunctions.html#getservermoneyavailable" > getServerMoneyAvailable< / a > < / li >
< li class = "toctree-l3" > < a class = "reference internal" href = "netscriptfunctions.html#getservermaxmoney" > getServerMaxMoney< / a > < / li >
< li class = "toctree-l3" > < a class = "reference internal" href = "netscriptfunctions.html#getservergrowth" > getServerGrowth< / a > < / li >
< li class = "toctree-l3" > < a class = "reference internal" href = "netscriptfunctions.html#getserversecuritylevel" > getServerSecurityLevel< / a > < / li >
< li class = "toctree-l3" > < a class = "reference internal" href = "netscriptfunctions.html#getserverbasesecuritylevel" > getServerBaseSecurityLevel< / a > < / li >
< li class = "toctree-l3" > < a class = "reference internal" href = "netscriptfunctions.html#getserverminsecuritylevel" > getServerMinSecurityLevel< / a > < / li >
< li class = "toctree-l3" > < a class = "reference internal" href = "netscriptfunctions.html#getserverrequiredhackinglevel" > getServerRequiredHackingLevel< / a > < / li >
< li class = "toctree-l3" > < a class = "reference internal" href = "netscriptfunctions.html#getservernumportsrequired" > getServerNumPortsRequired< / a > < / li >
< li class = "toctree-l3" > < a class = "reference internal" href = "netscriptfunctions.html#getserverram" > getServerRam< / a > < / li >
< li class = "toctree-l3" > < a class = "reference internal" href = "netscriptfunctions.html#serverexists" > serverExists< / a > < / li >
< li class = "toctree-l3" > < a class = "reference internal" href = "netscriptfunctions.html#fileexists" > fileExists< / a > < / li >
< li class = "toctree-l3" > < a class = "reference internal" href = "netscriptfunctions.html#isrunning" > isRunning< / a > < / li >
< li class = "toctree-l3" > < a class = "reference internal" href = "netscriptfunctions.html#getnexthacknetnodecost" > getNextHacknetNodeCost< / a > < / li >
< li class = "toctree-l3" > < a class = "reference internal" href = "netscriptfunctions.html#purchasehacknetnode" > purchaseHacknetNode< / a > < / li >
< li class = "toctree-l3" > < a class = "reference internal" href = "netscriptfunctions.html#purchaseserver" > purchaseServer< / a > < / li >
< li class = "toctree-l3" > < a class = "reference internal" href = "netscriptfunctions.html#deleteserver" > deleteServer< / a > < / li >
< li class = "toctree-l3" > < a class = "reference internal" href = "netscriptfunctions.html#getpurchasedservers" > getPurchasedServers< / a > < / li >
< li class = "toctree-l3" > < a class = "reference internal" href = "netscriptfunctions.html#write" > write< / a > < / li >
< li class = "toctree-l3" > < a class = "reference internal" href = "netscriptfunctions.html#read" > read< / a > < / li >
2018-02-24 23:55:06 +01:00
< li class = "toctree-l3" > < a class = "reference internal" href = "netscriptfunctions.html#peek" > peek< / a > < / li >
2018-01-09 21:48:06 +01:00
< li class = "toctree-l3" > < a class = "reference internal" href = "netscriptfunctions.html#clear" > clear< / a > < / li >
2018-02-24 23:55:06 +01:00
< li class = "toctree-l3" > < a class = "reference internal" href = "netscriptfunctions.html#rm" > rm< / a > < / li >
2018-01-09 21:48:06 +01:00
< li class = "toctree-l3" > < a class = "reference internal" href = "netscriptfunctions.html#scriptrunning" > scriptRunning< / a > < / li >
< li class = "toctree-l3" > < a class = "reference internal" href = "netscriptfunctions.html#scriptkill" > scriptKill< / a > < / li >
< li class = "toctree-l3" > < a class = "reference internal" href = "netscriptfunctions.html#getscriptram" > getScriptRam< / a > < / li >
< li class = "toctree-l3" > < a class = "reference internal" href = "netscriptfunctions.html#gethacktime" > getHackTime< / a > < / li >
< li class = "toctree-l3" > < a class = "reference internal" href = "netscriptfunctions.html#getgrowtime" > getGrowTime< / a > < / li >
< li class = "toctree-l3" > < a class = "reference internal" href = "netscriptfunctions.html#getweakentime" > getWeakenTime< / a > < / li >
< li class = "toctree-l3" > < a class = "reference internal" href = "netscriptfunctions.html#getscriptincome" > getScriptIncome< / a > < / li >
< li class = "toctree-l3" > < a class = "reference internal" href = "netscriptfunctions.html#getscriptexpgain" > getScriptExpGain< / a > < / li >
< li class = "toctree-l3" > < a class = "reference internal" href = "netscriptfunctions.html#gettimesincelastaug" > getTimeSinceLastAug< / a > < / li >
< li class = "toctree-l3" > < a class = "reference internal" href = "netscriptfunctions.html#sprintf" > sprintf< / a > < / li >
< li class = "toctree-l3" > < a class = "reference internal" href = "netscriptfunctions.html#vsprintf" > vsprintf< / a > < / li >
< li class = "toctree-l3" > < a class = "reference internal" href = "netscriptfunctions.html#prompt" > prompt< / a > < ul >
< li class = "toctree-l4" > < a class = "reference internal" href = "netscriptfunctions.html#defining-your-own-functions" > Defining your own Functions< / a > < / li >
< / ul >
< / li >
< / ul >
< / li >
< li class = "toctree-l2" > < a class = "reference internal" href = "netscriptadvancedfunctions.html" > Advanced Functions< / a > < ul >
< li class = "toctree-l3" > < a class = "reference internal" href = "netscriptadvancedfunctions.html#getbitnodemultipliers" > getBitNodeMultipliers< / a > < / li >
< / ul >
< / li >
< li class = "toctree-l2" > < a class = "reference internal" href = "netscripthacknetnodeapi.html" > Hacknet Node API< / a > < ul >
< li class = "toctree-l3" > < a class = "reference internal" href = "netscripthacknetnodeapi.html#hacknetnodes" > hacknetnodes< / a > < / li >
< li class = "toctree-l3" > < a class = "reference internal" href = "netscripthacknetnodeapi.html#hacknet-node-member-variables" > Hacknet Node Member Variables< / a > < / li >
< li class = "toctree-l3" > < a class = "reference internal" href = "netscripthacknetnodeapi.html#hacknet-node-methods" > Hacknet Node Methods< / a > < / li >
< li class = "toctree-l3" > < a class = "reference internal" href = "netscripthacknetnodeapi.html#example-s" > Example(s)< / a > < / li >
< / ul >
< / li >
< li class = "toctree-l2" > < a class = "reference internal" href = "netscriptixapi.html" > Trade Information eXchange (TIX) API< / a > < ul >
< li class = "toctree-l3" > < a class = "reference internal" href = "netscriptixapi.html#getstockprice" > getStockPrice< / a > < / li >
< li class = "toctree-l3" > < a class = "reference internal" href = "netscriptixapi.html#getstockposition" > getStockPosition< / a > < / li >
< li class = "toctree-l3" > < a class = "reference internal" href = "netscriptixapi.html#buystock" > buyStock< / a > < / li >
< li class = "toctree-l3" > < a class = "reference internal" href = "netscriptixapi.html#sellstock" > sellStock< / a > < / li >
< li class = "toctree-l3" > < a class = "reference internal" href = "netscriptixapi.html#shortstock" > shortStock< / a > < / li >
< li class = "toctree-l3" > < a class = "reference internal" href = "netscriptixapi.html#sellshort" > sellShort< / a > < / li >
< li class = "toctree-l3" > < a class = "reference internal" href = "netscriptixapi.html#placeorder" > placeOrder< / a > < / li >
< li class = "toctree-l3" > < a class = "reference internal" href = "netscriptixapi.html#cancelorder" > cancelOrder< / a > < / li >
< / ul >
< / li >
< li class = "toctree-l2" > < a class = "reference internal" href = "netscriptsingularityfunctions.html" > Singularity Functions< / a > < ul >
< li class = "toctree-l3" > < a class = "reference internal" href = "netscriptsingularityfunctions.html#universitycourse" > universityCourse< / a > < / li >
< li class = "toctree-l3" > < a class = "reference internal" href = "netscriptsingularityfunctions.html#gymworkout" > gymWorkout< / a > < / li >
< li class = "toctree-l3" > < a class = "reference internal" href = "netscriptsingularityfunctions.html#traveltocity" > travelToCity< / a > < / li >
< li class = "toctree-l3" > < a class = "reference internal" href = "netscriptsingularityfunctions.html#purchasetor" > purchaseTor< / a > < / li >
< li class = "toctree-l3" > < a class = "reference internal" href = "netscriptsingularityfunctions.html#purchaseprogram" > purchaseProgram< / a > < / li >
< li class = "toctree-l3" > < a class = "reference internal" href = "netscriptsingularityfunctions.html#getstats" > getStats< / a > < / li >
< li class = "toctree-l3" > < a class = "reference internal" href = "netscriptsingularityfunctions.html#isbusy" > isBusy< / a > < / li >
2018-02-15 05:34:57 +01:00
< li class = "toctree-l3" > < a class = "reference internal" href = "netscriptsingularityfunctions.html#stopaction" > stopAction< / a > < / li >
2018-01-09 21:48:06 +01:00
< li class = "toctree-l3" > < a class = "reference internal" href = "netscriptsingularityfunctions.html#upgradehomeram" > upgradeHomeRam< / a > < / li >
< li class = "toctree-l3" > < a class = "reference internal" href = "netscriptsingularityfunctions.html#getupgradehomeramcost" > getUpgradeHomeRamCost< / a > < / li >
< li class = "toctree-l3" > < a class = "reference internal" href = "netscriptsingularityfunctions.html#workforcompany" > workForCompany< / a > < / li >
< li class = "toctree-l3" > < a class = "reference internal" href = "netscriptsingularityfunctions.html#applytocompany" > applyToCompany< / a > < / li >
< li class = "toctree-l3" > < a class = "reference internal" href = "netscriptsingularityfunctions.html#getcompanyrep" > getCompanyRep< / a > < / li >
< li class = "toctree-l3" > < a class = "reference internal" href = "netscriptsingularityfunctions.html#checkfactioninvitations" > checkFactionInvitations< / a > < / li >
< li class = "toctree-l3" > < a class = "reference internal" href = "netscriptsingularityfunctions.html#joinfaction" > joinFaction< / a > < / li >
< li class = "toctree-l3" > < a class = "reference internal" href = "netscriptsingularityfunctions.html#workforfaction" > workForFaction< / a > < / li >
< li class = "toctree-l3" > < a class = "reference internal" href = "netscriptsingularityfunctions.html#getfactionrep" > getFactionRep< / a > < / li >
< li class = "toctree-l3" > < a class = "reference internal" href = "netscriptsingularityfunctions.html#createprogram" > createProgram< / a > < / li >
< li class = "toctree-l3" > < a class = "reference internal" href = "netscriptsingularityfunctions.html#commitcrime" > commitCrime< / a > < / li >
< li class = "toctree-l3" > < a class = "reference internal" href = "netscriptsingularityfunctions.html#getcrimechance" > getCrimeChance< / a > < / li >
< li class = "toctree-l3" > < a class = "reference internal" href = "netscriptsingularityfunctions.html#getownedaugmentations" > getOwnedAugmentations< / a > < / li >
< li class = "toctree-l3" > < a class = "reference internal" href = "netscriptsingularityfunctions.html#getaugmentationsfromfaction" > getAugmentationsFromFaction< / a > < / li >
< li class = "toctree-l3" > < a class = "reference internal" href = "netscriptsingularityfunctions.html#getaugmentationcost" > getAugmentationCost< / a > < / li >
< li class = "toctree-l3" > < a class = "reference internal" href = "netscriptsingularityfunctions.html#purchaseaugmentation" > purchaseAugmentation< / a > < / li >
< li class = "toctree-l3" > < a class = "reference internal" href = "netscriptsingularityfunctions.html#installaugmentations" > installAugmentations< / a > < / li >
< / ul >
< / li >
2018-02-24 23:55:06 +01:00
< li class = "toctree-l2" > < a class = "reference internal" href = "netscriptmisc.html" > Miscellaneous< / a > < ul >
< li class = "toctree-l3" > < a class = "reference internal" href = "netscriptmisc.html#comments" > Comments< / a > < / li >
< li class = "toctree-l3" > < a class = "reference internal" href = "netscriptmisc.html#javascript-math-module" > Javascript Math Module< / a > < / li >
< li class = "toctree-l3" > < a class = "reference internal" href = "netscriptmisc.html#javascript-date-module" > Javascript Date Module< / a > < / li >
< / ul >
< / li >
2018-01-09 21:48:06 +01:00
< / ul >
< / li >
< / ul >
< / div >
< / div >
< / div >
< div class = "section" id = "indices-and-tables" >
< h1 > Indices and tables< a class = "headerlink" href = "#indices-and-tables" title = "Permalink to this headline" > ¶< / a > < / h1 >
< ul class = "simple" >
< li > < a class = "reference internal" href = "genindex.html" > < span class = "std std-ref" > Index< / span > < / a > < / li >
< li > < a class = "reference internal" href = "py-modindex.html" > < span class = "std std-ref" > Module Index< / span > < / a > < / li >
< li > < a class = "reference internal" href = "search.html" > < span class = "std std-ref" > Search Page< / span > < / a > < / li >
< / ul >
< / div >
< / div >
< / div >
< / div >
< / div >
< div class = "sidebar" >
< h3 > Table Of Contents< / h3 >
< p class = "caption" > < span class = "caption-text" > Contents:< / span > < / p >
< ul >
< li class = "toctree-l1" > < a class = "reference internal" href = "netscript.html" > Netscript< / a > < / li >
< / ul >
< div role = "search" >
< h3 style = "margin-top: 1.5em;" > Search< / h3 >
< form class = "search" action = "search.html" method = "get" >
< input type = "text" name = "q" / >
< input type = "submit" value = "Go" / >
< input type = "hidden" name = "check_keywords" value = "yes" / >
< input type = "hidden" name = "area" value = "default" / >
< / form >
< / div >
< / div >
< div class = "clearer" > < / div >
< / div >
< / div >
< div class = "footer-wrapper" >
< div class = "footer" >
< div class = "left" >
< div role = "navigation" aria-label = "related navigaton" >
< a href = "netscript.html" title = "Netscript Documentation"
>next< / a > |
< a href = "genindex.html" title = "General Index"
>index< / a >
< / div >
< div role = "note" aria-label = "source link" >
< br / >
< a href = "_sources/index.rst.txt"
rel="nofollow">Show Source< / a >
< / div >
< / div >
< div class = "right" >
< div class = "footer" role = "contentinfo" >
© Copyright 2017, Bitburner.
Created using < a href = "http://sphinx-doc.org/" > Sphinx< / a > 1.6.4.
< / div >
< / div >
< div class = "clearer" > < / div >
< / div >
< / div >
< / body >
< / html >
