Repo for the official bitburner filesynchronisation package.
Find a file
2023-06-30 11:23:20 +02:00
.github/workflows Updates prettier configuration and adds prettier workflow 2022-10-01 10:44:07 -04:00
.vscode Updates prettier configuration and adds prettier workflow 2022-10-01 10:44:07 -04:00
npx Merge remote-tracking branch 'origin/feat/exclude' into feat/exclude 2023-04-12 17:36:27 +10:00
src Run prettier 2023-04-19 07:16:40 +10:00
test Fix lint errors 2022-10-12 00:17:48 +02:00
.eslintignore Setup eslint config and script 2022-10-12 00:14:30 +02:00
.eslintrc Setup eslint config and script 2022-10-12 00:14:30 +02:00
.gitattributes Added folder exclusion feature and .gitattributes 2023-04-11 12:12:34 +10:00
.gitignore Initial commit 2022-08-23 19:07:51 +02:00
.mocharc.jsonc Moves mocha config out of package.json into mocharc file 2022-10-01 10:44:07 -04:00
.nycrc.json Format pass 2022-10-09 13:11:54 +02:00
.prettierignore Updates prettier configuration and adds prettier workflow 2022-10-01 10:44:07 -04:00
.prettierrc Add prettier config and format script 2022-09-30 21:09:56 +02:00
CONTRIBUTING.md Fix bullet points & typo 2022-10-01 15:30:38 -07:00
LICENSE Initial commit 2022-08-23 19:07:51 +02:00
package-lock.json Bumped dependency versions to the latest 2023-04-11 14:29:05 +10:00
package.json Added a prepare script to allow installing off GitHub 2023-04-11 15:04:42 +10:00
README.md Prettier pass 2022-10-01 10:54:26 -04:00
tsconfig.base.json Updates build config to output node script for npx 2022-10-01 12:02:20 -04:00
tsconfig.json Add Istanbul for test coverage 2022-10-09 13:07:43 +02:00
tsconfig.test.json Updates build config to output node script for npx 2022-10-01 12:02:20 -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
}