ztimson/bitburner
ztimson/bitburner
1
0
Fork 0
Code Issues Pull Requests Releases Activity

Update README.md

Browse Source
This commit is contained in:
Zakary Timson 2023-08-07 15:56:53 +00:00
parent 865372fa9e
commit b961919274
1 changed files with 148 additions and 49 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

195
README.md
View File

@ -1,26 +1,44 @@
# Bitburner - Scripts <!-- Header -->
A collection of scripts & information pertaining to the [open source](https://github.com/danielyxie/bitburner) game [Bitburner](https://danielyxie.github.io/bitburner/) <div id="top" align="center">
<br />
![Bitburner Logo](bitburner.png) <!-- Logo -->
<img src="https://git.zakscode.com/repo-avatars/9b25b57330ba3a1d9da80dad4051be68373e52c4bfffc6f6ba9e89f7392f5f7d" alt="Logo" width="200" height="200">
<!-- Title -->
### Bitburner
<!-- Description -->
Collection of Bitburner scipts
<!-- Repo badges -->
[![Pull Requests](https://img.shields.io/badge/dynamic/json.svg?label=Pull%20Requests&style=for-the-badge&url=https://git.zakscode.com/api/v1/repos/ztimson/Bitburner&query=open_pr_counter)](https://git.zakscode.com/ztimson/Bitburner/pulls)
[![Issues](https://img.shields.io/badge/dynamic/json.svg?label=Issues&style=for-the-badge&url=https://git.zakscode.com/api/v1/repos/ztimson/Bitburner&query=open_issues_count)](https://git.zakscode.com/ztimson/Bitburner/issues)
</div>
## Table of Contents ## Table of Contents
- [Bitburner - Scripts](#bitburner-scripts) - [Bitburner](#top)
- [Table of Contents](#table-of-contents) - [About](#about)
- [Quick Start](#quick-start) - [Quick Start](#qiuck-start)
- [Scripts](#scripts) - [Scripts](#scripts)
- [banner.js](#bannerjs) - [banner.js](#banner)
- [botnet-manager.js (WIP)](#botnet-managerjs-wip) - [botnet-manager.js (WIP)](#botnet)
- [connect.js](#connectjs) - [connect.js](#connect)
- [copy.js](#copyjs) - [copy.js](#copy)
- [crawler.js](#crawlerjs) - [crawler.js](#crawler)
- [find-target.js](#find-targetjs) - [find-target.js](#find-target)
- [hacknet-manager.js](#hacknet-managerjs) - [hacknet-manager.js](#hacknet)
- [miner.js](#minerjs) - [miner.js](#miner)
- [network-graph.js](#network-graphjs) - [network-graph.js](#network-graph)
- [rm.js](#rmjs) - [rm.js](#rm)
- [rootkit.js](#rootkitjs) - [rootkit.js](#rootkit)
- [server-manager.js](#server-managerjs) - [server-manager.js](#server-manager)
- [update.js](#updatejs) - [update.js](#update)
- [License](#license)
## About
A collection of scripts & information pertaining to the [open source](https://github.com/danielyxie/bitburner) game [Bitburner](https://danielyxie.github.io/bitburner/)
## Quick Start ## Quick Start
@ -49,12 +67,15 @@ run scripts/connect.js CSEC
backdoor backdoor
``` ```
Learn more about the [available scripts](#scripts) bellow or pass the `--help` flag to any of the included scripts in-game.
## Scripts ## Scripts
### [banner.js](./scripts/banner.js) <details>
**RAM:** 1.60 GB <summary>
<h3 id="banner" style="display: inline">banner.js</h3>
</summary>
<br />
**RAM:** 1.60 GB | [Code](./src/banner.js)
Aesthetic & serves no real purpose. Prints a banner to the terminal & can repeat after game restarts. Aesthetic & serves no real purpose. Prints a banner to the terminal & can repeat after game restarts.
``` ```
@ -71,9 +92,15 @@ Options:
-r, --reboot Automatically display after game reboots -r, --reboot Automatically display after game reboots
-h, --help Display this help message -h, --help Display this help message
``` ```
</details>
### [botnet-manager.js (WIP)](./scripts/botnet-manager.js) <details>
**RAM:** 7.15 GB <summary>
<h3 id="botnet" style="display: inline">botnet-manager.js (WIP)</h3>
</summary>
<br />
**RAM:** 7.15 GB | [Code](./scripts/botnet-manager.js)
Late-game solution to hack servers. It orchestrates an unlimited number of servers to carry out distributed batched Late-game solution to hack servers. It orchestrates an unlimited number of servers to carry out distributed batched
attacks against targets. It includes a bunch of utilities to quickly dispatch single commands to all workers. Manger attacks against targets. It includes a bunch of utilities to quickly dispatch single commands to all workers. Manger
@ -101,9 +128,15 @@ Commands:
run Copy & run script on all worker nodes run Copy & run script on all worker nodes
start Start this device as the swarm manager start Start this device as the swarm manager
``` ```
</details>
### [connect.js](./scripts/connect.js) <details>
**RAM:** 1.85 GB <summary>
<h3 id="connect" style="display: inline">connect.js</h3>
</summary>
<br />
**RAM:** 1.85 GB | [Code](./scripts/connect.js)
The built in `connect` command only allows you to connect to devices in the immediate vicinity or servers that have The built in `connect` command only allows you to connect to devices in the immediate vicinity or servers that have
backdoors installed requiring you to make several jumps. This script will automatically find a path & connect you saving backdoors installed requiring you to make several jumps. This script will automatically find a path & connect you saving
@ -123,9 +156,15 @@ Usage: run connect.js [OPTIONS] SERVER
Options: Options:
-h, --help Display this help message -h, --help Display this help message
``` ```
</details>
### [copy.js](./scripts/copy.js) <details>
**RAM:** 4.20 GB <summary>
<h3 id="copy" style="display: inline">copy.js</h3>
</summary>
<br />
**RAM:** 4.20 GB | [Code](./scripts/copy.js)
Scripts often import other scripts requiring multiple `scp` calls before it can be run on a remote machine. This script Scripts often import other scripts requiring multiple `scp` calls before it can be run on a remote machine. This script
will automatically scan the file being copied for imports & recursively scan & copy the dependencies. Plus it has a will automatically scan the file being copied for imports & recursively scan & copy the dependencies. Plus it has a
@ -151,9 +190,15 @@ Options:
-q, --quite Suppress program output -q, --quite Suppress program output
-h, --help Display this help message -h, --help Display this help message
``` ```
</details>
### [crawler.js](./scripts/crawler.js) <details>
**RAM:** 5.80 GB <summary>
<h3 id="crawler" style="display: inline">crawler.js</h3>
</summary>
<br />
**RAM:** 5.80 GB | [Code](./scripts/crawler.js)
Mid-game solution to distribute & run scripts across the network. Mid-game solution to distribute & run scripts across the network.
``` ```
@ -182,9 +227,15 @@ Options:
-v, --verbose Display the server names in the final report -v, --verbose Display the server names in the final report
-h, --help Display this help message -h, --help Display this help message
``` ```
</details>
### [find-target.js](./scripts/find-target.js) <details>
**RAM:** 4.05 GB <summary>
<h3 id="find-target" style="display: inline">find-target.js</h3>
</summary>
<br />
**RAM:** 4.05 GB | [Code](./scripts/find-target.js)
A utility to help figure out which server is worth hacking the most. It does this by estimating the financial yield per A utility to help figure out which server is worth hacking the most. It does this by estimating the financial yield per
minute for each server & returns the servers in a sorted list. minute for each server & returns the servers in a sorted list.
@ -205,9 +256,15 @@ Options:
-v, --verbose Display the estimated income per minute per core -v, --verbose Display the estimated income per minute per core
-h, --help Display this help message -h, --help Display this help message
``` ```
</details>
### [hacknet-manager.js](./scripts/hacknet-manager.js) <details>
**RAM:** 5.70 GB <summary>
<h3 id="hacknet" style="display: inline">hacknet-manager.js</h3>
</summary>
<br />
**RAM:** 5.70 GB | [Code](./scripts/hacknet-manager.js)
An early game solution to automate the hacknet & get easy money. An early game solution to automate the hacknet & get easy money.
``` ```
@ -228,12 +285,18 @@ Options:
-s, --sleep Amount of time to wait between purchases, defaults to 1 (second) -s, --sleep Amount of time to wait between purchases, defaults to 1 (second)
-h, --help Display this help message -h, --help Display this help message
``` ```
</details>
### [miner.js](./scripts/miner.js) <details>
**RAM:** 2.45 GB <summary>
<h3 id="miner" style="display: inline">miner.js</h3>
</summary>
<br />
**RAM:** 2.45 GB | [Code](./scripts/miner.js)
An early-game HGW script to steal money from servers. You can deploy this on each server and have them hack themselves, An early-game HGW script to steal money from servers. You can deploy this on each server and have them hack themselves,
or they can all target the server with the most money which is more efficient (see [find-target.js](#find-targetjs)). or they can all target the server with the most money which is more efficient (see [find-target.js](#find-target)).
``` ```
[home ~/]> run scripts/miner.js --help [home ~/]> run scripts/miner.js --help
Running script with 1 thread(s), pid 1 and args: ["--help"]. Running script with 1 thread(s), pid 1 and args: ["--help"].
@ -252,9 +315,15 @@ Options:
-s, --sleep Amount of time to wait between purchases, defaults to 1 (second) -s, --sleep Amount of time to wait between purchases, defaults to 1 (second)
-h, --help Display this help message -h, --help Display this help message
``` ```
</details>
### [network-graph.js](./scripts/network-graph.js) <details>
**RAM:** 3.85 GB <summary>
<h3 id="network-graph" style="display: inline">network-graph.js</h3>
</summary>
<br />
**RAM:** 3.85 GB | [Code](./scripts/network-graph.js)
A utility to scan the network & build a visual tree of all the devices. It comes with lots of flags to narrow down the A utility to scan the network & build a visual tree of all the devices. It comes with lots of flags to narrow down the
results. It's useful for figuring out where you are, manually finding targets & discovering the path to a server & results. It's useful for figuring out where you are, manually finding targets & discovering the path to a server &
@ -284,9 +353,15 @@ Options:
-v, --verbose Display level, specs & usage in that order: [HL|P] {CPU|RAM} (USG%) -v, --verbose Display level, specs & usage in that order: [HL|P] {CPU|RAM} (USG%)
-h, --help Display this help message -h, --help Display this help message
``` ```
</details>
### [rm.js](./scripts/rm.js) <details>
**RAM:** 2.85 GB <summary>
<h3 id="rm" style="display: inline">rm.js</h3>
</summary>
<br />
**RAM:** 2.85 GB | [Code](./scripts/rm.js)
[bitburner-connector](https://plugins.jetbrains.com/plugin/18338-bitburner-connector) would occasionally push my IDE [bitburner-connector](https://plugins.jetbrains.com/plugin/18338-bitburner-connector) would occasionally push my IDE
files to the game, so I created this simple script to recursively search & delete files from a directory to save me files to the game, so I created this simple script to recursively search & delete files from a directory to save me
@ -309,9 +384,15 @@ Options:
-r, --recursive Delete everything inside directory -r, --recursive Delete everything inside directory
-h, --help Display this help message -h, --help Display this help message
``` ```
</details>
### [rootkit.js](./scripts/rootkit.js) <details>
**RAM:** 4.65 GB <summary>
<h3 id="rootkit" style="display: inline">rootkit.js</h3>
</summary>
<br />
**RAM:** 4.65 GB | [Code](./scripts/rootkit.js)
Automatically gains root on the local or remote server. A script can be passed as an additional argument; it will be Automatically gains root on the local or remote server. A script can be passed as an additional argument; it will be
copied and automatically executed with the maximum number of threads after being rooted. copied and automatically executed with the maximum number of threads after being rooted.
@ -339,9 +420,15 @@ Options:
-v, --verbose Display level, specs & usage in that order: [HL|P] {CPU|RAM} (USG%) -v, --verbose Display level, specs & usage in that order: [HL|P] {CPU|RAM} (USG%)
-h, --help Display this help message -h, --help Display this help message
``` ```
</details>
### [server-manager.js](./scripts/server-manager.js) <details>
**RAM:** 11.35 GB <summary>
<h3 id="server-miner" style="display: inline">server-miner.js</h3>
</summary>
<br />
**RAM:** 11.35 GB | [Code](./scripts/server-manager.js)
Mid-game script to handle purchasing and upgrading servers for more computer power. You can also set a script to run Mid-game script to handle purchasing and upgrading servers for more computer power. You can also set a script to run
automatically after purchase. Useful to chain with `miner.js` or `botnet.js`. automatically after purchase. Useful to chain with `miner.js` or `botnet.js`.
@ -366,9 +453,15 @@ Options:
-s, --sleep Amount of time to wait between purchases, defaults to 1 (second) -s, --sleep Amount of time to wait between purchases, defaults to 1 (second)
-h, --help Display this help message -h, --help Display this help message
``` ```
</details>
### [update.js](./scripts/update.js) <details>
**RAM:** 2.65 GB <summary>
<h3 id="update" style="display: inline">update.js</h3>
</summary>
<br />
**RAM:** 2.65 GB | [Code](./scripts/update.js)
Uses the in-game `wget` to download all the scripts in this repository. Can target remote servers to quickly copy the Uses the in-game `wget` to download all the scripts in this repository. Can target remote servers to quickly copy the
entire toolkit to the target. entire toolkit to the target.
@ -389,3 +482,9 @@ Options:
--no-banner Hide the banner (Used internally) --no-banner Hide the banner (Used internally)
-h, --help Display this help message -h, --help Display this help message
``` ```
</details>
## License
Copyright © 2023 Zakary Timson | Available under MIT Licensing
See the [license](./LICENSE) for more information.