quick-start.md

Quick start

Using viteburner-template

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".

Migrate your existing project to viteburner

1. Install devDependencies

npm i -D viteburner vite

2. (a) Sync-only setup

In vite.config.js

/* eslint-env node */
import { defineConfig } from 'viteburner';
import { resolve } from 'path';
export default defineConfig({
  /** basic vite configs */
  resolve: {
    alias: {
      /** path to your source code */
      '@': resolve(__dirname, 'src'),
      '/src': resolve(__dirname, 'src'),
    },
  },
  build: { minify: false },
  /** viteburner configs */
  viteburner: {
    watch: [{ pattern: 'src/**/*.{js,script,txt}' }],
  },
});

Note: The config shown above includes basic vite configs. If your project doesn't have an existing vite.config.js/vite.config.ts, you may add them into the config. Otherwise you can just add viteburner-specific configs only. You can find more configs in vite docs.

2. (b) TS or mixed TS+JS setup

In vite.config.ts

/* eslint-env node */
import { defineConfig } from 'viteburner';
import { resolve } from 'path';
export default defineConfig({
  /** basic vite configs */
  resolve: {
    alias: {
      /** path to your source code */
      '@': resolve(__dirname, 'src'),
      '/src': resolve(__dirname, 'src'),
    },
  },
  build: { minify: false },
  /** viteburner configs */
  viteburner: {
    watch: [
      {
        pattern: 'src/**/*.{js,ts}',
        transform: true,
      },
      { pattern: 'src/**/*.{script,txt}' },
    ],
  },
});

3. configure package.json

{
  "scripts": {
    "dev": "viteburner"
  }
}

4. npm run dev in your terminal to start viteburner.