start of docs

This commit is contained in:
tresabhi committed 2026-10-04 13:11:36 -05:00
1 parent 86e7ace3f0
commit d9f29cd0c9
2 files changed
+28 -2

No files matched your search

+26 -2
View File
@@ -1,5 +1,29 @@
# BlitzKit
Tools for everything and anything, World of Tanks Blitz.
Your Blitz experience, elevated. https://blitzkit.app/.
This GitHub repository contains the code for BlitzKit and all its services. If you are here, looking to use BlitzKit, go to 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.
+2
View File
@@ -6,7 +6,9 @@ import { promisify } from "util";
const MAX_COMMAND_LENGTH = 2 ** 11;
const TS_PROTO_EXECUTABLE_LOCATIONS = [
"./node_modules/.bin/protoc-gen-ts_proto",
"./node_modules/.bin/protoc-gen-ts_proto.exe",
"../../node_modules/.bin/protoc-gen-ts_proto",
"../../node_modules/.bin/protoc-gen-ts_proto.exe",
];
const roots = [