Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/eroxl/bit-burner
💻 A collection of my bitburner scripts and develpment environment written in typescript
https://github.com/eroxl/bit-burner
bit-burner bitburner bitburner-scripts typescript
Last synced: 27 days ago
JSON representation
💻 A collection of my bitburner scripts and develpment environment written in typescript
- Host: GitHub
- URL: https://github.com/eroxl/bit-burner
- Owner: Eroxl
- License: agpl-3.0
- Created: 2022-12-18T16:26:26.000Z (almost 2 years ago)
- Default Branch: main
- Last Pushed: 2023-10-02T23:57:10.000Z (about 1 year ago)
- Last Synced: 2023-10-03T08:08:35.117Z (about 1 year ago)
- Topics: bit-burner, bitburner, bitburner-scripts, typescript
- Language: TypeScript
- Homepage:
- Size: 1.2 MB
- Stars: 3
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE.md
Awesome Lists containing this project
README
💻 Bit Burner Scripts
## 📝 Description
This repository contains scripts for the game [Bit Burner](https://github.com/danielyxie/bitburner) by [danielyxie](https://github.com/danielyxie).
The scripts are written in Typescript, transpiled into Javascript, and then transferred to the game using the [remote API](https://bitburner.readthedocs.io/en/latest/remoteapi.html).
## 📦 Installation
1. Install [Node.js](https://nodejs.org/en/download/), [Yarn](https://classic.yarnpkg.com/en/docs/install/), [Python3](https://www.python.org/downloads/), [Pip](https://pip.pypa.io/en/stable/installing/), and [Git](https://git-scm.com/downloads)
2. Clone this repository
- ```bash
git clone https://github.com/Eroxl/Bit-Burner
```
- or download the repository as a zip file and extract it
3. Navigate to the repository
- ```bash
cd Bit-Burner
```
4. Install dependencies
- ```bash
yarn install && pip install -r requirements.txt
```
5. Install the NetScript definitions
- ```bash
yarn run update:definitions
```
## 🚀 Usage
1. Build the scripts
- ```bash
yarn run build
```
2. Wait for the build to finish
3. Start the game
4. Navigate to the `options` menu
5. Select `Remote API`
6. Enter port `3200` into the `Port` field, then click `Connect`
## 💾 Development
1. Start the development server
- ```bash
yarn run dev
```
2. Wait for the server to start
3. Start the game
4. Navigate to the `options` menu
5. Select `Remote API`
6. 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](src/lsTree.ts) - List the files in a directory in a tree-like format
- [runScriptAll](src/runScriptAll.ts) - Run a script on all rooted servers
- [botNet](src/botNet/runBatcher.ts) - Run a botnet on all rooted servers that target a specific server
- [buyServer](src/buyServer.ts) - Prompt the user for a server to buy and then buy it
- [analyze-v2](src/analyze-v2.ts) - Analyze a server and print the results
- [hacknet](src/hacknetNodes.ts) - Tries to buy the best hack net node upgrades possible
- [bestCrime](src/bestCrime/bestCrime.ts) - Calculates the best crime $/s for your current stats
## 📜 License
This project is licensed under the [Affero General Public License v3.0](https://www.gnu.org/licenses/agpl-3.0.en.html) - see the [LICENSE](LICENSE) file for details
## 📧 Contact
- [Eroxl](github.com/eroxl) - [email protected]
## 📚 Resources
- [Bit Burner](https://github.com/danielyxie/bitburner)
- [Bit Burner Wiki](https://bitburner.readthedocs.io/en/latest/index.html)
- [Typescript](https://www.typescriptlang.org/)
- [Node.js](https://nodejs.org/en/)
- [Yarn](https://yarnpkg.com/)
- [Python](https://www.python.org/)
- [Pip](https://pypi.org/project/pip/)