Update README.md

Add .github/pull_request_template.md
Update README.md
2023-12-05 04:58:56 +00:00 · 2023-11-24 21:14:55 +00:00 · 2023-08-07 17:05:33 +00:00 · 2023-08-07 16:03:48 +00:00 · 2023-08-07 16:02:46 +00:00 · 2023-08-07 16:02:33 +00:00
6 changed files with 579 additions and 412 deletions
--- a/.github/issue_template/bug.md
+++ b/.github/issue_template/bug.md
@ -0,0 +1,30 @@
+---
+
+name: "Bug report"
+about: "Encountered an issue"
+ref: "develop"
+labels:
+- Type/Bug
+
+---
+
+# Bug Report
+<!-- Description of problem -->
+I tried to ...
+
+But instead ...
+
+## Steps to Reproduce
+<!-- How can developers replicate & test the problem? -->
+1. 
+2. 
+3. 
+
+## Logs
+<!-- Any logs that accompenied the error -->
+```
+
+```
+
+## Screenshots
+<!-- Screenshots (annoted if possible) of the problem -->
--- a/.github/issue_template/enhancement.md
+++ b/.github/issue_template/enhancement.md
@ -0,0 +1,22 @@
+---
+
+name: "Enhancement"
+about: "Request a feature"
+ref: "develop"
+labels:
+- Type/Enhancement
+
+---
+
+# Feature Request
+<!-- Detailed description -->
+...
+
+## Requirements
+<!-- Bullet list of requirments -->
+1. ...
+2. ...
+
+## Notes
+<!-- Any additional considerations, solutions or design choices -->
+...
--- a/.github/pull_request_template.md
+++ b/.github/pull_request_template.md
@ -0,0 +1,14 @@
+## Description
+<!-- Adition information & context -->
+...
+
+## Issues
+<!-- Issues this PR will address -->
+ - closes #___
+ - owner/repo#___
+
+## Checklist
+<!-- Compelte after creating PR -->
+ - [ ] Linked issues
+ - [ ] Reviewed changes
+ - [ ] Updated comments/documentation
--- a/7
+++ b/7
@ -0,0 +1,7 @@
+Copyright (c) 2023 Zakary Timson
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the “Software”), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED “AS IS”, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
--- a/README.md
+++ b/README.md
@ -1,33 +1,65 @@
-# BitBurner - Scripts
-A collection of scripts & information pertaining to the [open source](https://github.com/danielyxie/bitburner) game 
-[BitBurner](https://danielyxie.github.io/bitburner/).
+<!-- Header -->
+<div id="top" align="center">
+  <br />
+  
+  <!-- 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 -->
+  [![Version](https://img.shields.io/badge/dynamic/json.svg?label=Version&style=for-the-badge&url=https://git.zakscode.com/api/v1/repos/ztimson/bitburner/tags&query=$[0].name)](https://git.zakscode.com/ztimson/bitburner/tags)
+  [![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)
+
+  <!-- Links -->
+
+  ---
+  <div>
+    <a href="https://git.zakscode.com/ztimson/bitburner/releases" target="_blank">Release Notes</a>
+    • <a href="https://git.zakscode.com/ztimson/bitburner/issues/new?template=.github%2fissue_template%2fbug.md" target="_blank">Report a Bug</a>
+    • <a href="https://git.zakscode.com/ztimson/bitburner/issues/new?template=.github%2fissue_template%2fenhancement.md" target="_blank">Request a Feature</a>
+  </div>
+
+  ---
+</div>

 ## Table of Contents
- [BitBurner - Scripts](#bitburner-scripts)
-  - [Table of Contents](#table-of-contents)
-  - [Quick Start](#quick-start)
- [Guide](#guide)
-  - [BitNode 1](#bitnode-1)
+- [Bitburner](#top)
+  - [About](#about)
+    - [Built With](#built-with)
+  - [Quick Start](#qiuck-start)
  - [Scripts](#scripts)
-    - [banner.js](#bannerjs)
-    - [botnet-manager.js (WIP)](#botnet-managerjs-wip)
-    - [connect.js](#connectjs)
-    - [copy.js](#copyjs)
-    - [crawler.js](#crawlerjs)
-    - [find-target.js](#find-targetjs)
-    - [hacknet-manager.js](#hacknet-managerjs)
-    - [miner.js](#minerjs)
-    - [network-graph.js](#network-graphjs)
-    - [rm.js](#rmjs)
-    - [rootkit.js](#rootkitjs)
-    - [server-manager.js](#server-managerjs)
-    - [update.js](#updatejs)
+    - [banner.js](#banner)
+    - [botnet-manager.js (WIP)](#botnet)
+    - [connect.js](#connect)
+    - [copy.js](#copy)
+    - [crawler.js](#crawler)
+    - [find-target.js](#find-target)
+    - [hacknet-manager.js](#hacknet)
+    - [miner.js](#miner)
+    - [network-graph.js](#network-graph)
+    - [rm.js](#rm)
+    - [rootkit.js](#rootkit)
+    - [server-manager.js](#server-manager)
+    - [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/)
+
+### Built with
+[![JavaScript](https://img.shields.io/badge/JavaScript-000000?style=for-the-badge&logo=javascript)](https://javascript.com/)

 ## Quick Start

 ```bash
 # Download the update script in-game & run it
-wget https://gitlab.zakscode.com/ztimson/BitBurner/-/raw/develop/scripts/update.js scripts/update.js
+wget https://gitlab.zakscode.com/ztimson/Bitburner/-/raw/develop/scripts/update.js scripts/update.js
 run scripts/update.js # Repeat to pull the latest

 # View the network
@ -50,31 +82,15 @@ run scripts/connect.js CSEC
 backdoor
 ```

-Learn more about the [available scripts](#scripts) bellow or pass the `--help` flag to any of the included scripts in-game.
-
-## Guide
-This guide documents how you can use this repository to progress through the game. You should complete the tutorial
-first if you haven't already.
-
-### BitNode 1
-1. First you need to download this repo into the game. Manually download `update.js` & run it:
-`wget https://gitlab.zakscode.com/ztimson/BitBurner/-/raw/develop/scripts/update.js scripts/update.js; run scripts/update.js` 
-2. Scan the network to figure out your bearings, take note of discovered server's required hack level:
-`run scripts/network-graph.js -vd 3`
-3. Root the lowest level server (probably n00dles) & make it hack itself for money. You should repeat this step when 
-ever your hack level is high enough to hack another a new server. `run scripts/rootkit.js n00dles /scripts/miner.js`
-4. Start `hacknet-manger.js`. You won't have enough *RAM* in the beginning to run the manager & hack servers. It's 
-recommended you `tail` the manager, so you can easily start/stop it as needed. `run script/hacknet-manager.js -a`
-5. Once you have enough money ($??,???.??), upgrade your home severs *RAM*: 
-`City > alpha ent. > Upgrade 'home' RAM (8.00GB -> 16.00GB)`
-6. At this point you have enough *RAM* to use `crawler.js` to automatically discover servers & hack them. Continue to
-run this periodically as your hack level increases & you unlock more exploits:
-`run scripts/crawler.js -n /scripts/rootkit.js {{TARGET}} /scripts/miner.js`
-
 ## Scripts

-### [banner.js](./scripts/banner.js)
-**RAM:** 1.60 GB
+<details>
+<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.
 ```
@ -91,9 +107,15 @@ Options:
 	-r, --reboot            Automatically display after game reboots
 	-h, --help              Display this help message
 ```
+</details>

-### [botnet-manager.js (WIP)](./scripts/botnet-manager.js)
-**RAM:** 7.15 GB
+<details>
+<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 
 attacks against targets. It includes a bunch of utilities to quickly dispatch single commands to all workers. Manger
@ -121,9 +143,15 @@ Commands:
 	run                     Copy & run script on all worker nodes
 	start                   Start this device as the swarm manager
 ```
+</details>

-### [connect.js](./scripts/connect.js)
-**RAM:** 1.85 GB
+<details>
+<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
 backdoors installed requiring you to make several jumps. This script will automatically find a path & connect you saving
@ -143,9 +171,15 @@ Usage:	run connect.js [OPTIONS] SERVER
 Options:
 	-h, --help              Display this help message
 ```
+</details>

-### [copy.js](./scripts/copy.js)
-**RAM:** 4.20 GB
+<details>
+<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 
 will automatically scan the file being copied for imports & recursively scan & copy the dependencies. Plus it has a
@ -171,9 +205,15 @@ Options:
 	-q, --quite             Suppress program output
 	-h, --help              Display this help message
 ```
+</details>

-### [crawler.js](./scripts/crawler.js)
-**RAM:** 5.80 GB
+<details>
+<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.
 ```
@ -202,9 +242,15 @@ Options:
 	-v, --verbose           Display the server names in the final report
 	-h, --help              Display this help message
 ```
+</details>

-### [find-target.js](./scripts/find-target.js)
-**RAM:** 4.05 GB
+<details>
+<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
 minute for each server & returns the servers in a sorted list.
@ -225,9 +271,15 @@ Options:
 	-v, --verbose           Display the estimated income per minute per core
 	-h, --help              Display this help message
 ```
+</details>

-### [hacknet-manager.js](./scripts/hacknet-manager.js)
-**RAM:** 5.70 GB
+<details>
+<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.
 ```
@ -248,12 +300,18 @@ Options:
 	-s, --sleep             Amount of time to wait between purchases, defaults to 1 (second)
 	-h, --help              Display this help message
 ```
+</details>

-### [miner.js](./scripts/miner.js)
-**RAM:** 2.45 GB
+<details>
+<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, 
-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
 Running script with 1 thread(s), pid 1 and args: ["--help"].
@ -272,9 +330,15 @@ Options:
 	-s, --sleep             Amount of time to wait between purchases, defaults to 1 (second)
 	-h, --help              Display this help message
 ```
+</details>

-### [network-graph.js](./scripts/network-graph.js)
-**RAM:** 3.85 GB
+<details>
+<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
 results. It's useful for figuring out where you are, manually finding targets & discovering the path to a server & 
@ -304,11 +368,17 @@ Options:
 	-v, --verbose           Display level, specs & usage in that order: [HL|P] {CPU|RAM} (USG%)
 	-h, --help              Display this help message
 ```
+</details>

-### [rm.js](./scripts/rm.js)
-**RAM:** 2.85 GB
+<details>
+<summary>
+  <h3 id="rm" style="display: inline">rm.js</h3>
+</summary>
+<br />

-[BitBurner-Connector](https://plugins.jetbrains.com/plugin/18338-bitburner-connector) would occasionally push my IDE
+**RAM:** 2.85 GB | [Code](./scripts/rm.js)
+
+[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 
 from having to delete files one-by-one.
 ```
@ -329,9 +399,15 @@ Options:
 	-r, --recursive         Delete everything inside directory
 	-h, --help              Display this help message
 ```
+</details>

-### [rootkit.js](./scripts/rootkit.js)
-**RAM:** 4.65 GB
+<details>
+<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
 copied and automatically executed with the maximum number of threads after being rooted.
@ -359,9 +435,15 @@ Options:
 	-v, --verbose           Display level, specs & usage in that order: [HL|P] {CPU|RAM} (USG%)
 	-h, --help              Display this help message
 ```
+</details>

-### [server-manager.js](./scripts/server-manager.js)
-**RAM:** 11.35 GB
+<details>
+<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
 automatically after purchase. Useful to chain with `miner.js` or `botnet.js`.
@ -386,9 +468,15 @@ Options:
 	-s, --sleep             Amount of time to wait between purchases, defaults to 1 (second)
 	-h, --help              Display this help message
 ```
+</details>

-### [update.js](./scripts/update.js)
-**RAM:** 2.65 GB
+<details>
+<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 
 entire toolkit to the target.
@ -409,3 +497,9 @@ Options:
 	--no-banner             Hide the banner (Used internally)
 	-h, --help              Display this help message
 ```
+</details>
+
+## License
+Copyright © 2023 Zakary Timson | Available under MIT Licensing
+
+See the [license](./LICENSE) for more information.
--- a/scripts/update.js
+++ b/scripts/update.js
@ -183,7 +183,7 @@ export async function main(ns) {
 		{name: 'no-banner', desc: 'Hide the banner (Used internally)', flags: ['--no-banner'], default: false}
 	]);
 	const args = argParser.parse(ns.args || []);
-	const src = 'https://gitlab.zakscode.com/ztimson/BitBurner/-/raw/develop/scripts/';
+	const src = 'https://raw.githubusercontent.com/PointyTrident/Bitburner/develop/scripts/';
 	const dest = '/scripts/';
 	const fileList = [
 		'lib/arg-parser.js',
Author	SHA1	Message	Date
Zakary Timson	c316643787	Update README.md	2023-12-05 04:58:56 +00:00
Zakary Timson	4e6b125db7	Add .github/pull_request_template.md	2023-11-24 21:14:55 +00:00
Zakary Timson	9f867d9372	Update README.md	2023-08-07 17:05:33 +00:00
Zakary Timson	e16e56741a	Update .github/issue_template/enhancement.md	2023-08-07 16:03:48 +00:00
Zakary Timson	fa384b41ab	Update .github/issue_template/enhancment.md	2023-08-07 16:02:46 +00:00
Zakary Timson	0f450f23b8	Update .github/issue_template/bug.md	2023-08-07 16:02:33 +00:00
Zakary Timson	e25e4f989c	Add .github/issue_templates/enhancment.md	2023-08-07 16:01:59 +00:00
Zakary Timson	207fe642d4	Add .github/issue_templates/bug.md	2023-08-07 16:01:42 +00:00
Zakary Timson	4c151dc301	Update README.md	2023-08-07 16:00:53 +00:00
Zakary Timson	ef915b69ba	Update README.md	2023-08-07 15:57:46 +00:00
Zakary Timson	b961919274	Update README.md	2023-08-07 15:56:53 +00:00
Zakary Timson	865372fa9e	Delete bitburner.png	2023-08-07 15:17:18 +00:00
Zakary Timson	54e53cbfbb	Update LICENSE	2023-08-07 15:16:55 +00:00
Zakary Timson	67732b8dcd	Add LICENSE	2023-08-07 15:14:00 +00:00
Zakary Timson	24699af95d	Update README.md	2023-07-28 02:03:52 +00:00
Zakary Timson	7844d1467c	Added logo	2023-07-27 23:36:08 +00:00
Zakary Timson	e9569b24f9	Delete bitburner.png	2023-07-27 23:35:35 +00:00
Zakary Timson	e664ae3ebc	Added logo	2023-07-27 23:34:11 +00:00
Zakary Timson	f5615e985e	Delete bitburner.png	2023-07-27 23:33:31 +00:00
Zakary Timson	d46e4dfa34	Update README.md	2023-07-27 23:33:21 +00:00
Zakary Timson	c77e320550	Added logo	2023-07-27 23:32:14 +00:00
Zak Timson	40415c3a0d	Use github URL	2022-08-13 00:43:46 +00:00
Zak Timson	72d00c1d4b	Update README.md	2022-08-13 00:38:51 +00:00
Zak Timson	0e15103d31	Update README.md	2022-05-05 22:02:14 +00:00