https://github.com/srbrahma/bitburner-ts

https://github.com/srbrahma/bitburner-ts

Last synced: 2 months ago
JSON representation

• Host: GitHub
• URL: https://github.com/srbrahma/bitburner-ts
• Owner: SrBrahma
• Created: 2023-12-12T18:45:32.000Z (about 1 year ago)
• Default Branch: main
• Last Pushed: 2024-10-17T16:20:11.000Z (3 months ago)
• Last Synced: 2024-10-30T00:32:59.545Z (3 months ago)
• Language: TypeScript
• Size: 221 KB
• Stars: 0
• Watchers: 1
• Forks: 2
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        


[![PRs Welcome](https://img.shields.io/badge/PRs-welcome-brightgreen.svg?style=flat-square)](http://makeapullrequest.com)

[![TypeScript](https://badgen.net/npm/types/env-var)](http://www.typescriptlang.org/)

[![npm](https://img.shields.io/npm/v/bitburner-ts)](https://www.npmjs.com/package/bitburner-ts)

[![npm](https://img.shields.io/npm/dw/bitburner-ts)](https://www.npmjs.com/package/bitburner-ts)



# bitburner-ts

Rework of [bitburner-filesync](https://github.com/bitburner-official/bitburner-filesync) to work directly with Typescript and with a cleaner implementation. Also, supports WSL when the gaming is running on Windows.

Just run `npx bitburner-ts`! You don't need any special setup in your Typescript project to have this working, like [typescript-template](https://github.com/bitburner-official/typescript-template).

This will automatically set up Typescript on watch mode and will push the resulting .js files into Bitburner. Requires `outDir` and `rootDir` on `tsconfig.json` to be set.

The .js files will be by default put into the `script` directory in the game's `home` server.

You can install it via `npm i bitburner-ts` and have it as a start script in your package.json for quality of life ✨

## Usage

```bash

npx bitburner-ts [options]

# or

npm i bitburner-ts

```

```

Options:

  -p, --port   the port to be used (default: 12525)

  -d, --dest      directory in the game's home server to put the files (default: "scripts")

  -h, --help           display help for command

```