This commit is contained in:
tresabhi committed 2026-10-04 13:27:46 -05:00
1 parent 8b03784be5
commit 784c3e58c1
1 file changed
+21 -1
+21 -1
View File
@@ -16,6 +16,10 @@ Ideally, you should also uninstall Node.js if you have it installed to avoid any
BlitzKit uses [Protocol Buffer's protoc CLI](https://protobuf.dev/installation/) to generate efficiently packed data structures to serve data to clients in place of JSON.
### World of Tanks Blitz
You will need a local installation of [World of Tanks Blitz](https://wotblitz.com/) for BlitzKit to build off.
### aria2 (Optional)
If you plan to use BlitzKit's client-management CLI for BlitzKit Previews, you will need to [get aria2](https://aria2.github.io/) to speed up your downloads.
@@ -37,7 +41,23 @@ git clone https://github.com/blitzkit/blitzkit.git
cd blitzkit
```
> [!INFO]
> [!NOTE]
> 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.
Then, download the dependencies with Bun.
```bash
bun install
```
Finally, compile the proto files into TypeScript.
```bash
build build-protos
```
## Developing: Running
```bash
bun dev
```