Go to file
Cyn 0c54e3cf48 switch to folder settings over workspace settings 2021-12-25 02:46:52 -05:00
.vscode switch to folder settings over workspace settings 2021-12-25 02:46:52 -05:00
src let watcher self update 2021-12-23 14:59:01 -05:00
.eslintrc.js Initial Commit 2021-12-23 13:26:41 -05:00
.gitignore Initial Commit 2021-12-23 13:26:41 -05:00
NetscriptDefinitions.d.ts Initial Commit 2021-12-23 13:26:41 -05:00
README.md Update README.md 2021-12-23 15:27:19 -05:00
package.json Clean up typos 2021-12-23 13:39:59 -05:00
tsconfig.json add rule for files at root of directory 2021-12-23 13:48:14 -05:00
updateDefs.js Clean up typos 2021-12-23 13:39:59 -05:00

README.md

Extension Recommendations

vscode-bitburner-connector (vscode extension marketplace) to upload your files into the game

vscode-eslint to use live linting in editor

auto-snippet to automate inserting the file template in .vscode/snippets.code-snippets

There is a workspace file in .vscode which contains the recommended settings for all of these

Dependencies

Node.js required for compiling typescript and installing dependencies

Installation

git clone https://github.com/SlyCedix/bitburner-typescript-template.git
npm install
npm run defs

How to use this template

Write all your typescript source code in the /src directory

Ensure you are using absolute paths to .js files in your imports or else the game will not recognize your import paths.
Example: use import {} from '/lib/helpers.js' instead of import {} from './lib/helpers'

To autocompile as you save, run npm run watch in a terminal

To update your Netscript Definitions, run npm run defs in a terminal

Press F1 and Select Bitburner: Enable File Watcher to enable auto uploading to the game

If you run watcher.js in game, the game will automatically detect file changes and restart the associated scripts