README.md

# BlitzKit

Your Blitz experience, elevated. https://blitzkit.app/.

## Developing

### Prerequisites

#### Bun

[Bun](https://bun.sh/) is the package manager and runtime that BlitzKit uses.

Ideally, you should also uninstall Node.js if you have it installed to avoid any cases where Node.js is used to run code instead of Bun which happens in some cases. But, this is not required and is unlikely to cause issues.

#### Linux (Optional)

All work on BlitzKit is done on Linux and macOS. It is theoretically possible to work on Windows; please feel free to try and share your discoveries with us!

### Setting Up

Start by cloning the repository and changing directories.

```bash
git clone https://github.com/blitzkit/blitzkit.git
cd blitzkit
```

> [!INFO]
> There is a closed source submodule under `packages/closed` that you can safely ignore. This sole purpose of this submodule is to provide `dvp.ts`, a proprietary Wargaming game asset tree compression tool. You will not need this at any point.
feat: submodules and packages 2025-09-28 13:44:15 -05:00			`# BlitzKit`
feat: update readme 2024-12-23 12:37:12 -06:00
start of docs 2026-10-04 13:11:36 -05:00			`Your Blitz experience, elevated. https://blitzkit.app/.`
feat: env vars 2025-09-28 14:10:34 -05:00
start of docs 2026-10-04 13:11:36 -05:00			`## Developing`

			`### Prerequisites`

			`#### Bun`

			`[Bun](https://bun.sh/) is the package manager and runtime that BlitzKit uses.`

			`Ideally, you should also uninstall Node.js if you have it installed to avoid any cases where Node.js is used to run code instead of Bun which happens in some cases. But, this is not required and is unlikely to cause issues.`

			`#### Linux (Optional)`

			`All work on BlitzKit is done on Linux and macOS. It is theoretically possible to work on Windows; please feel free to try and share your discoveries with us!`

			`### Setting Up`

			`Start by cloning the repository and changing directories.`

			```bash
			`git clone https://github.com/blitzkit/blitzkit.git`
			`cd blitzkit`
			```

			`> [!INFO]`
			> There is a closed source submodule under `packages/closed` that you can safely ignore. This sole purpose of this submodule is to provide `dvp.ts`, a proprietary Wargaming game asset tree compression tool. You will not need this at any point.