https://github.com/bitburner-official/bitburner-filesync

Repo for the official bitburner filesynchronisation package.
https://github.com/bitburner-official/bitburner-filesync

Last synced: about 5 hours ago
JSON representation

Repo for the official bitburner filesynchronisation package.

• Host: GitHub
• URL: https://github.com/bitburner-official/bitburner-filesync
• Owner: bitburner-official
• License: unlicense
• Created: 2022-08-23T18:51:16.000Z (over 2 years ago)
• Default Branch: main
• Last Pushed: 2023-06-30T09:23:20.000Z (over 1 year ago)
• Last Synced: 2024-12-02T11:38:12.296Z (10 days ago)
• Language: TypeScript
• Homepage:
• Size: 176 KB
• Stars: 28
• Watchers: 5
• Forks: 12
• Open Issues: 3
• Metadata Files:
  • Readme: README.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE

Awesome Lists containing this project

• stars - bitburner-filesync - official | 28 | (TypeScript)
• stars - bitburner-filesync - official | 28 | (TypeScript)

README

        
# bitburner-filesync

A file synchronisation utility for Bitburner, using the Remote File API.

It allows players to synchronize scripts and text files from their computer's disk to the game in both the Electron build and website.

## How to use (for users)

You must have a recent version of `npm` installed after which you can run

```

npx bitburner-filesync

```

This pulls and runs the latest release of bitburner-filesync for you.

## Configuration

The program, when ran, uses a local file to have itself configured to your preferences.

This file is `filesync.json` within the directory you start bitburner-filesync.

Here's an example of it's contents:

```js

{

  "allowedFiletypes": [

    ".js",

    ".script",

    ".txt"

  ],

  "allowDeletingFiles": false,

  "port": 12525,

  "scriptsFolder": ".",

  "quiet": false,

  "dry": false,

  "definitionFile": {

    "update": false,

    "location": "NetScriptDefinitions.d.ts"

  },

  "pushAllOnConnection": false

}

```