Skip to content

Latest commit

 

History

History
87 lines (73 loc) · 3.09 KB

README.md

File metadata and controls

87 lines (73 loc) · 3.09 KB

💻 Bit Burner Scripts

📝 Description

This repository contains scripts for the game Bit Burner by danielyxie. The scripts are written in Typescript, transpiled into Javascript, and then transferred to the game using the remote API.

📦 Installation

  1. Install Node.js, Yarn, Python3, Pip, and Git
  2. Clone this repository
  • git clone https://github.com/Eroxl/Bit-Burner
  • or download the repository as a zip file and extract it
  1. Navigate to the repository
  • cd Bit-Burner
  1. Install dependencies
  • yarn install && pip install -r requirements.txt 
  1. Install the NetScript definitions
  • yarn run update:definitions

🚀 Usage

  1. Build the scripts
  • yarn run build
  1. Wait for the build to finish
  2. Start the game
  3. Navigate to the options menu
  4. Select Remote API
  5. Enter port 3200 into the Port field, then click Connect

💾 Development

  1. Start the development server
  • yarn run dev
  1. Wait for the server to start
  2. Start the game
  3. Navigate to the options menu
  4. Select Remote API
  5. Enter port 3200 into the Port field, then click Connect

📦 Development Features

  • Net Script definitions
  • Full typescript support
  • Send scripts to the game
  • Relative imports
  • Hot reloading

🎁 Scripts

  • lsTree - List the files in a directory in a tree-like format lsTree Example

  • runScriptAll - Run a script on all rooted servers

  • botNet - Run a botnet on all rooted servers that target a specific server

  • buyServer - Prompt the user for a server to buy and then buy it

  • analyze-v2 - Analyze a server and print the results analyze-v2 Example

  • hacknet - Tries to buy the best hack net node upgrades possible

  • bestCrime - Calculates the best crime $/s for your current stats

📜 License

This project is licensed under the Affero General Public License v3.0 - see the LICENSE file for details

📧 Contact

📚 Resources