Bitburner scripts

Scripts used in my Bitburner deployment.

Documentation

Extensive per-script documentation is found in the Wiki and the Website.

Documentation is generated from TSDoc via typedoc and typedoc-plugin-markdown / typedoc-github-wiki-theme.

Getting Started

Prerequisites

• Doppler token as env.DOPPLER_TOKEN to pull Bitburner auth token
• nodejs / npm
• gulp (optional)

Setting up

1. Clone this repository
2. Run npm install to install required packages, update NS definitions, and populate Bitburner auth token

Building

Run npm run build to compile TS, generate a file manifest and docs, and run prettier.

Updating Netscript defintiions

The Netscript definitions is automatically created as a npm install postrun task.

This file can be updated by running npm run postinstall:defs.

Syncing with Bitburner

VS Code Extension

Auto-sync via Bitburner VSCode Integration is automatically set up as a npm install postrun.

bitburner-sync

You can also manually sync via bitburner-sync using npm run sync, the token is also set up as a npm install postrun.

This token can be manually synced by running npm run postinstall:config.

sync.js

You can run sync.js which pulls files from a hosted or local endpoint.

Hosted scripts

To set up Bitburner for the first time, run:

wget https://bb.vlad.gg/api/sync.js
run sync.js

Afterwards, you can use run sync.js to pull the latest files.

Local development

To download the scripts from a local instance, run npm run serve to build and serve the local versions of the files.

Within Bitburner, use run sync.js http://<IP_ADDR>:8080/api to pull from the local development server.

Pull requests

Netlify will also create a deployment for each PR.

Within Bitburner, use run sync.js <PR_URL>/api to pull from the PR deployment.