/bitburner

A collection of scripts and libraries for the game Bitburner

Primary LanguageTypeScript

Bitburner

The scripts are written in plain javascript but are type checked by typescript. For that to work each function must be documented accordingly.

Template

A template for a netscript2 is available at 'src/template.js'.

File hierarchy

The file structure in src is kept flat intentionally as Bitburner requires import paths for scripts to be absolute. Keeping the hierarchy flat will make this simple.

Typescript definitions

The typescript definitions for the game are located at 'src/typedef/bitburner.t.ts' and are pulled from the games github.

Requirements

  • python3 (opt. for serving the files)
  • make (opt. for convenient build commands)
  • tsc (typescript) (opt. for type checking the scripts)

Install

  1. Open a local server to serve the files.
make serve
  1. Run the following in the Bitburner terminal.
wget http://localhost:8080/init.js init.js
run init.js

Ressources