This commit is contained in:
tresabhi committed 2026-10-04 13:21:21 -05:00
1 parent d9f29cd0c9
commit 8b03784be5
1 file changed
+19 -5
+19 -5
View File
@@ -2,21 +2,33 @@
Your Blitz experience, elevated. https://blitzkit.app/.
## Developing
## Developing: Prerequisites
### Prerequisites
There's a few things you'll need to get started. If this is your first time working with BlitzKit, it's completely safe to ignore all optional prerequisites below to get things running as quickly as possible.
#### Bun
### 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)
### Protocol Buffer
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.
### 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.
### libarchive (Optional)
If you plan to use BlitzKit's client-management CLI for BlitzKit OpenTests, you will need to [get libarchive](https://www.libarchive.org/) to keep your downloads completely in-memory.
### 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
## Developing: Setting Up
Start by cloning the repository and changing directories.
@@ -27,3 +39,5 @@ 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.
## Developing: Running