Repo for the official bitburner filesynchronisation package.
Find a file
2022-10-01 13:58:08 -07:00
.github/workflows Adds basic CI GitHub workflow 2022-09-30 22:24:21 -04:00
npx Updates package.json and launch script to use ts-node 2022-09-30 20:17:04 -04:00
src Converts JS files to TS 2022-09-30 20:17:00 -04:00
test Adds Mocha, Chai and Sinon testing utilities, as well as basic specs 2022-09-30 22:24:21 -04:00
.gitignore Initial commit 2022-08-23 19:07:51 +02:00
.prettierrc Add prettier config and format script 2022-09-30 21:09:56 +02:00
CONTRIBUTING.md Add CONTRIBUTING.md 2022-10-01 13:58:08 -07:00
LICENSE Initial commit 2022-08-23 19:07:51 +02:00
package-lock.json Fix merge mistakes 2022-10-01 12:42:38 +02:00
package.json Fix merge mistakes 2022-10-01 12:42:38 +02:00
README.md Descriptive config name 2022-08-28 15:55:57 +01:00
tsconfig.json Adds Mocha, Chai and Sinon testing utilities, as well as basic specs 2022-09-30 22:24:21 -04:00

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:

{
  "allowedFiletypes": [
    ".js",
    ".script",
    ".txt"
  ],
  "allowDeletingFiles": false,
  "port": 12525,
  "scriptsFolder": ".",
  "quiet": false,
  "dry": false,
  "definitionFile": {
    "update": false,
    "location": "NetScriptDefinitions.d.ts"
  },
  "pushAllOnConnection": false
}