Viteburner-template

NOTE: All user scripts to be synced with the game is found under src/.

This is a template for a viteburner project. It is a simple example of how to use Viteburner.

How to use

Prerequisites: Node.js

git clone https://github.com/Tanimodori/viteburner-template.git
cd viteburner-template
npm i
npm run dev

In bitburner, select "Options > Remote API", enter the port of viteburner displays (default: 12525) and click "Connect".

API

See viteburner.

How to update my clone to the latest version of the template

Usually you only need to upgrade viteburner using npm (or any other package manager you use).

npm i -D viteburner@latest

Or if you want to update all configs:

# add "upstream" to git remote in case you've overwritten the "origin"
git remote add upstream https://github.com/Tanimodori/viteburner-template.git
# fetch the updates from "upstream"
git fetch upstream
# perform the merge
git merge upstream/main
# NOTE: resolve git conflicts manually now.
# install packages if any gets updated.
npm i

License

MIT License © 2022-present Tanimodori