Go to file
Cyn e0f16244db
Merge pull request #1 from jornedesmedt/main
Added @ns tsconfig.js, used in snippet + example
2022-01-06 15:47:51 -05:00
.vscode Added @ns tsconfig.js, used in snippet + example 2022-01-06 21:14:42 +01:00
src Added @ns tsconfig.js, used in snippet + example 2022-01-06 21:14:42 +01:00
.eslintrc.js Update template for new extension link 2022-01-05 19:35:19 -05:00
.gitignore Update template for new extension link 2022-01-05 19:35:19 -05:00
README.md Update template for new extension link 2022-01-05 19:35:19 -05:00
package.json Update template for new extension link 2022-01-05 19:35:19 -05:00
tsconfig.json Added @ns tsconfig.js, used in snippet + example 2022-01-06 21:14:42 +01: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