https://github.com/tanimodori/viteburner
Daemon tools of bitburner using vite.
https://github.com/tanimodori/viteburner
bitburner typescript vite
Last synced: 30 days ago
JSON representation
Daemon tools of bitburner using vite.
- Host: GitHub
- URL: https://github.com/tanimodori/viteburner
- Owner: Tanimodori
- License: mit
- Created: 2022-10-06T05:47:14.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2023-03-14T07:17:13.000Z (about 2 years ago)
- Last Synced: 2025-05-07T14:23:18.644Z (30 days ago)
- Topics: bitburner, typescript, vite
- Language: TypeScript
- Homepage:
- Size: 1.02 MB
- Stars: 21
- Watchers: 1
- Forks: 7
- Open Issues: 9
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Viteburner
Daemon tools of bitburner using vite for script transform, file syncing, RAM monitoring and more!
[](https://www.npmjs.com/package/viteburner) [](https://github.com/Tanimodori/viteburner) [](https://github.com/Tanimodori/viteburner/stargazers) [](https://www.npmjs.com/package/viteburner) [](https://github.com/Tanimodori/viteburner)
## Why viteburner
- Write dynamic config in TypeScript and JavaScript.
- No need to monitor your `dist` folder anymore.
- Manual upload/download any time you wish.
- Monitor RAM usage of your selected scripts easily.
- Interactive CLI and well-formatted outputs.
- IDE and system independent.
- Vite is faster than tsc for TypeScript transform.
- Utilize various vite plugins.
## Quick start
Prerequisites: [Node.js](https://nodejs.org/en/download/)
Using [viteburner-template](https://github.com/Tanimodori/viteburner-template)
```bash
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".
checkout [Quick Start](docs/guide/quick-start.md) for more details if you want to use viteburner in your existing project.
## API
For detailed documentation, checkout [docs](docs/index.md).
```ts
export interface ViteBurnerUserConfig {
watch?: WatchItem[];
usePolling?: boolean | { interval?: number; binaryInterval?: number };
sourcemap?: boolean | 'inline' | 'hidden';
port?: number;
timeout?: number;
dts?: string | boolean;
ignoreInitial?: boolean;
download?: {
server?: string | string[];
location?: (file: string, server: string) => string | null | undefined;
ignoreTs?: boolean;
ignoreSourcemap?: boolean;
};
dumpFiles?: string | null | undefined | ((file: string, server: string) => string | null | undefined);
}
export interface WatchItem {
pattern: string;
transform?: boolean;
location?: RenameOutput | ((file: string) => RenameOutput);
}
export type RenameOutput = string | RenameOutputObject | Array | null | undefined;
export type RenameOutputObject = {
filename?: string;
server?: string;
};
```
## Thanks
Thank them for inspiring this package.
- [acorn](https://github.com/acornjs/acorn)
- [bitburner](https://github.com/danielyxie/bitburner)
- [bitburner-filesync](https://github.com/bitburner-official/bitburner-filesync)
- [unconfig](https://github.com/antfu/unconfig)
- [vite](https://vitejs.dev/)
- [vitest](https://vitest.dev/)
- [vite-node](https://www.npmjs.com/package/vite-node)
## License
[MIT License](LICENSE) © 2022-present Tanimodori