From f8aa9e75d5c9a70e4748f4a4df7fe8987af5c9ae Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Tr=C3=A8sAbhi?= <43380238+tresabhi@users.noreply.github.com> Date: Sat, 3 Oct 2026 21:42:03 -0500 Subject: [PATCH 01/13] Update issue templates --- .github/ISSUE_TEMPLATE/bug_report.md | 38 +++++++++++++++++++++++ .github/ISSUE_TEMPLATE/feature_request.md | 20 ++++++++++++ 2 files changed, 58 insertions(+) create mode 100644 .github/ISSUE_TEMPLATE/bug_report.md create mode 100644 .github/ISSUE_TEMPLATE/feature_request.md diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md new file mode 100644 index 000000000..dd84ea782 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug_report.md @@ -0,0 +1,38 @@ +--- +name: Bug report +about: Create a report to help us improve +title: '' +labels: '' +assignees: '' + +--- + +**Describe the bug** +A clear and concise description of what the bug is. + +**To Reproduce** +Steps to reproduce the behavior: +1. Go to '...' +2. Click on '....' +3. Scroll down to '....' +4. See error + +**Expected behavior** +A clear and concise description of what you expected to happen. + +**Screenshots** +If applicable, add screenshots to help explain your problem. + +**Desktop (please complete the following information):** + - OS: [e.g. iOS] + - Browser [e.g. chrome, safari] + - Version [e.g. 22] + +**Smartphone (please complete the following information):** + - Device: [e.g. iPhone6] + - OS: [e.g. iOS8.1] + - Browser [e.g. stock browser, safari] + - Version [e.g. 22] + +**Additional context** +Add any other context about the problem here. diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md new file mode 100644 index 000000000..bbcbbe7d6 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/feature_request.md @@ -0,0 +1,20 @@ +--- +name: Feature request +about: Suggest an idea for this project +title: '' +labels: '' +assignees: '' + +--- + +**Is your feature request related to a problem? Please describe.** +A clear and concise description of what the problem is. Ex. I'm always frustrated when [...] + +**Describe the solution you'd like** +A clear and concise description of what you want to happen. + +**Describe alternatives you've considered** +A clear and concise description of any alternative solutions or features you've considered. + +**Additional context** +Add any other context or screenshots about the feature request here. From 46bd8f631638ac82cea503f83750fc3066b8ea2d Mon Sep 17 00:00:00 2001 From: tresabhi <43380238+tresabhi@users.noreply.github.com> Date: Sat, 3 Oct 2026 21:51:21 -0500 Subject: [PATCH 02/13] add template --- .github/ISSUE_TEMPLATE/bug_report.md | 38 ------------ .github/ISSUE_TEMPLATE/bug_report.yaml | 70 +++++++++++++++++++++++ .github/ISSUE_TEMPLATE/config.yaml | 10 ++++ .github/ISSUE_TEMPLATE/feature_request.md | 20 ------- 4 files changed, 80 insertions(+), 58 deletions(-) delete mode 100644 .github/ISSUE_TEMPLATE/bug_report.md create mode 100644 .github/ISSUE_TEMPLATE/bug_report.yaml create mode 100644 .github/ISSUE_TEMPLATE/config.yaml delete mode 100644 .github/ISSUE_TEMPLATE/feature_request.md diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md deleted file mode 100644 index dd84ea782..000000000 --- a/.github/ISSUE_TEMPLATE/bug_report.md +++ /dev/null @@ -1,38 +0,0 @@ ---- -name: Bug report -about: Create a report to help us improve -title: '' -labels: '' -assignees: '' - ---- - -**Describe the bug** -A clear and concise description of what the bug is. - -**To Reproduce** -Steps to reproduce the behavior: -1. Go to '...' -2. Click on '....' -3. Scroll down to '....' -4. See error - -**Expected behavior** -A clear and concise description of what you expected to happen. - -**Screenshots** -If applicable, add screenshots to help explain your problem. - -**Desktop (please complete the following information):** - - OS: [e.g. iOS] - - Browser [e.g. chrome, safari] - - Version [e.g. 22] - -**Smartphone (please complete the following information):** - - Device: [e.g. iPhone6] - - OS: [e.g. iOS8.1] - - Browser [e.g. stock browser, safari] - - Version [e.g. 22] - -**Additional context** -Add any other context about the problem here. diff --git a/.github/ISSUE_TEMPLATE/bug_report.yaml b/.github/ISSUE_TEMPLATE/bug_report.yaml new file mode 100644 index 000000000..9ea35e4ab --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug_report.yaml @@ -0,0 +1,70 @@ +name: 🐞 Bug Report +description: BlitzKit is not behaving as expected +title: "[Bug]: " +labels: ["bug", "triage"] +type: bug + +body: + - type: markdown + attributes: + value: | + Thanks for taking the time to fill out this bug report! + - type: input + id: contact + attributes: + label: Contact Details + description: How can we get in touch with you if we need more info? + placeholder: ex. email@example.com + validations: + required: false + - type: textarea + id: what-happened + attributes: + label: What happened? + description: Also tell us, what did you expect to happen? + placeholder: Tell us what you see! + value: "A bug happened!" + validations: + required: true + - type: dropdown + id: version + attributes: + label: Version + description: What version of our software are you running? + options: + - 1.0.2 (Default) + - 1.0.3 (Edge) + default: 0 + validations: + required: true + - type: dropdown + id: browsers + attributes: + label: What browsers are you seeing the problem on? + multiple: true + options: + - Firefox + - Chrome + - Safari + - Microsoft Edge + - type: textarea + id: logs + attributes: + label: Relevant log output + description: Please copy and paste any relevant log output. This will be automatically formatted into code, so no need for backticks. + render: shell + - type: checkboxes + id: terms + attributes: + label: Code of Conduct + description: By submitting this issue, you agree to follow our [Code of Conduct](https://example.com). + options: + - label: I agree to follow this project's Code of Conduct + required: true + - type: upload + id: screenshots + attributes: + label: Upload screenshots + description: If applicable, add screenshots to help explain your problem. + validations: + required: false diff --git a/.github/ISSUE_TEMPLATE/config.yaml b/.github/ISSUE_TEMPLATE/config.yaml new file mode 100644 index 000000000..6f47ee63c --- /dev/null +++ b/.github/ISSUE_TEMPLATE/config.yaml @@ -0,0 +1,10 @@ +blank_issues_enabled: false + +contact_links: + - name: Discord Server + about: Got questions? We answer better on Discord! + url: https://discord.gg/nDt7AjGJQH + + - name: Formal Email + about: Reach out to BlitzKit formally through email. + url: mailto:support@blitzkit.app diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md deleted file mode 100644 index bbcbbe7d6..000000000 --- a/.github/ISSUE_TEMPLATE/feature_request.md +++ /dev/null @@ -1,20 +0,0 @@ ---- -name: Feature request -about: Suggest an idea for this project -title: '' -labels: '' -assignees: '' - ---- - -**Is your feature request related to a problem? Please describe.** -A clear and concise description of what the problem is. Ex. I'm always frustrated when [...] - -**Describe the solution you'd like** -A clear and concise description of what you want to happen. - -**Describe alternatives you've considered** -A clear and concise description of any alternative solutions or features you've considered. - -**Additional context** -Add any other context or screenshots about the feature request here. From 551183a65bc883f1af27b5f75f190d3f639c2148 Mon Sep 17 00:00:00 2001 From: tresabhi <43380238+tresabhi@users.noreply.github.com> Date: Sat, 3 Oct 2026 21:51:50 -0500 Subject: [PATCH 03/13] yml --- .github/ISSUE_TEMPLATE/{config.yaml => config.yml} | 0 1 file changed, 0 insertions(+), 0 deletions(-) rename .github/ISSUE_TEMPLATE/{config.yaml => config.yml} (100%) diff --git a/.github/ISSUE_TEMPLATE/config.yaml b/.github/ISSUE_TEMPLATE/config.yml similarity index 100% rename from .github/ISSUE_TEMPLATE/config.yaml rename to .github/ISSUE_TEMPLATE/config.yml From d7e06a2b46a8d55471a07a4a701c0547ebca1457 Mon Sep 17 00:00:00 2001 From: tresabhi <43380238+tresabhi@users.noreply.github.com> Date: Sat, 3 Oct 2026 21:52:39 -0500 Subject: [PATCH 04/13] email link --- .github/ISSUE_TEMPLATE/config.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/ISSUE_TEMPLATE/config.yml b/.github/ISSUE_TEMPLATE/config.yml index 6f47ee63c..ba8f3ae9f 100644 --- a/.github/ISSUE_TEMPLATE/config.yml +++ b/.github/ISSUE_TEMPLATE/config.yml @@ -7,4 +7,4 @@ contact_links: - name: Formal Email about: Reach out to BlitzKit formally through email. - url: mailto:support@blitzkit.app + url: https://blitzkit.com/contact From a5637c9f0771cb1b13f41bf12afb38590b54b154 Mon Sep 17 00:00:00 2001 From: tresabhi <43380238+tresabhi@users.noreply.github.com> Date: Sat, 3 Oct 2026 22:01:26 -0500 Subject: [PATCH 05/13] format --- .github/ISSUE_TEMPLATE/bug.yaml | 42 ++++++++++++++++ .github/ISSUE_TEMPLATE/bug_report.yaml | 70 -------------------------- .github/ISSUE_TEMPLATE/config.yml | 6 +-- 3 files changed, 45 insertions(+), 73 deletions(-) create mode 100644 .github/ISSUE_TEMPLATE/bug.yaml delete mode 100644 .github/ISSUE_TEMPLATE/bug_report.yaml diff --git a/.github/ISSUE_TEMPLATE/bug.yaml b/.github/ISSUE_TEMPLATE/bug.yaml new file mode 100644 index 000000000..25e6f4e54 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug.yaml @@ -0,0 +1,42 @@ +name: 🐞 Bug Report +description: BlitzKit is not behaving as expected. +labels: ["bug"] +type: bug + +body: + - type: markdown + attributes: + value: | + Thank you so much for reporting an issue! Please fill out the form + below in its entirety and we'll address your issue as soon as possible. + + - type: textarea + validations: + required: true + attributes: + label: What happened? + description: What about BlitzKit's behavior did you find unexpected? + + - type: textarea + validations: + required: true + attributes: + label: What should've happened? + description: What did you expect BlitzKit to do instead of what you observed? + + - type: textarea + attributes: + label: How do you reproduce the issue? + description: What steps one must follow to recreate your issue? + + - type: dropdown + attributes: + label: Branch + description: What branch of BlitzKit were you using? Please see the "Branch" section of the footer at the very bottom of any page. + options: + - Production + - Preview + - OpenTest + default: 0 + validations: + required: true diff --git a/.github/ISSUE_TEMPLATE/bug_report.yaml b/.github/ISSUE_TEMPLATE/bug_report.yaml deleted file mode 100644 index 9ea35e4ab..000000000 --- a/.github/ISSUE_TEMPLATE/bug_report.yaml +++ /dev/null @@ -1,70 +0,0 @@ -name: 🐞 Bug Report -description: BlitzKit is not behaving as expected -title: "[Bug]: " -labels: ["bug", "triage"] -type: bug - -body: - - type: markdown - attributes: - value: | - Thanks for taking the time to fill out this bug report! - - type: input - id: contact - attributes: - label: Contact Details - description: How can we get in touch with you if we need more info? - placeholder: ex. email@example.com - validations: - required: false - - type: textarea - id: what-happened - attributes: - label: What happened? - description: Also tell us, what did you expect to happen? - placeholder: Tell us what you see! - value: "A bug happened!" - validations: - required: true - - type: dropdown - id: version - attributes: - label: Version - description: What version of our software are you running? - options: - - 1.0.2 (Default) - - 1.0.3 (Edge) - default: 0 - validations: - required: true - - type: dropdown - id: browsers - attributes: - label: What browsers are you seeing the problem on? - multiple: true - options: - - Firefox - - Chrome - - Safari - - Microsoft Edge - - type: textarea - id: logs - attributes: - label: Relevant log output - description: Please copy and paste any relevant log output. This will be automatically formatted into code, so no need for backticks. - render: shell - - type: checkboxes - id: terms - attributes: - label: Code of Conduct - description: By submitting this issue, you agree to follow our [Code of Conduct](https://example.com). - options: - - label: I agree to follow this project's Code of Conduct - required: true - - type: upload - id: screenshots - attributes: - label: Upload screenshots - description: If applicable, add screenshots to help explain your problem. - validations: - required: false diff --git a/.github/ISSUE_TEMPLATE/config.yml b/.github/ISSUE_TEMPLATE/config.yml index ba8f3ae9f..eb67d647a 100644 --- a/.github/ISSUE_TEMPLATE/config.yml +++ b/.github/ISSUE_TEMPLATE/config.yml @@ -1,10 +1,10 @@ blank_issues_enabled: false contact_links: - - name: Discord Server + - name: 🎮 Discord Server about: Got questions? We answer better on Discord! url: https://discord.gg/nDt7AjGJQH - - name: Formal Email + - name: ✉️ Email about: Reach out to BlitzKit formally through email. - url: https://blitzkit.com/contact + url: https://blitzkit.app/contact From 8d5ef297719ea60fbf564927255576c3408a1289 Mon Sep 17 00:00:00 2001 From: tresabhi <43380238+tresabhi@users.noreply.github.com> Date: Sat, 3 Oct 2026 22:05:07 -0500 Subject: [PATCH 06/13] feature --- .github/ISSUE_TEMPLATE/bug.yaml | 9 ++++++--- .github/ISSUE_TEMPLATE/feature.yaml | 16 ++++++++++++++++ 2 files changed, 22 insertions(+), 3 deletions(-) create mode 100644 .github/ISSUE_TEMPLATE/feature.yaml diff --git a/.github/ISSUE_TEMPLATE/bug.yaml b/.github/ISSUE_TEMPLATE/bug.yaml index 25e6f4e54..f02658323 100644 --- a/.github/ISSUE_TEMPLATE/bug.yaml +++ b/.github/ISSUE_TEMPLATE/bug.yaml @@ -6,9 +6,7 @@ type: bug body: - type: markdown attributes: - value: | - Thank you so much for reporting an issue! Please fill out the form - below in its entirety and we'll address your issue as soon as possible. + value: Thank you so much for reporting an issue! Please fill out the form below in its entirety and we'll address your issue as soon as possible. - type: textarea validations: @@ -40,3 +38,8 @@ body: default: 0 validations: required: true + + - type: input + attributes: + label: Discord username + description: Do you have a Discord account that we can reach out to for further information? diff --git a/.github/ISSUE_TEMPLATE/feature.yaml b/.github/ISSUE_TEMPLATE/feature.yaml new file mode 100644 index 000000000..3c456044e --- /dev/null +++ b/.github/ISSUE_TEMPLATE/feature.yaml @@ -0,0 +1,16 @@ +name: 💡 Feature Request +description: BlitzKit could use a new idea. +labels: ["enhancement"] +type: feature + +body: + - type: markdown + attributes: + value: Thank you so much for pitching in an idea! + + - type: textarea + validations: + required: true + attributes: + label: What's your idea? + description: Please be descriptive and feel free to add drawings/screenshots if needed. From 067c9cb2670ccc014e61c41d87c3c4150c305659 Mon Sep 17 00:00:00 2001 From: tresabhi <43380238+tresabhi@users.noreply.github.com> Date: Sat, 3 Oct 2026 22:10:10 -0500 Subject: [PATCH 07/13] simpler bug forms --- .github/ISSUE_TEMPLATE/bug.yaml | 7 ------- 1 file changed, 7 deletions(-) diff --git a/.github/ISSUE_TEMPLATE/bug.yaml b/.github/ISSUE_TEMPLATE/bug.yaml index f02658323..58ff6f92c 100644 --- a/.github/ISSUE_TEMPLATE/bug.yaml +++ b/.github/ISSUE_TEMPLATE/bug.yaml @@ -15,13 +15,6 @@ body: label: What happened? description: What about BlitzKit's behavior did you find unexpected? - - type: textarea - validations: - required: true - attributes: - label: What should've happened? - description: What did you expect BlitzKit to do instead of what you observed? - - type: textarea attributes: label: How do you reproduce the issue? From 86e7ace3f0be232646598b18ff5344f975c58946 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Tr=C3=A8sAbhi?= <43380238+tresabhi@users.noreply.github.com> Date: Sun, 4 Oct 2026 12:22:36 -0500 Subject: [PATCH 08/13] Remove misleading text Removed contribution note regarding sensitive submodules. --- README.md | 2 -- 1 file changed, 2 deletions(-) diff --git a/README.md b/README.md index cc7f8f283..620b2af73 100644 --- a/README.md +++ b/README.md @@ -3,5 +3,3 @@ Tools for everything and anything, World of Tanks Blitz. 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/. - -If you intend to contribute to the code, note that you may need to check out sensitive, closed-source submodules to locally develop certain aspects of BlitzKit. Communicate with `@tresabhi` on Discord to get started or discuss sensitive content, such as environment variables or submodules. From d9f29cd0c9c90e03c740c733eff8002dd34ad145 Mon Sep 17 00:00:00 2001 From: tresabhi <43380238+tresabhi@users.noreply.github.com> Date: Sun, 4 Oct 2026 13:11:36 -0500 Subject: [PATCH 09/13] start of docs --- README.md | 28 ++++++++++++++++++++++++++-- packages/scripts/src/protos.ts | 2 ++ 2 files changed, 28 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 620b2af73..658c47e5e 100644 --- a/README.md +++ b/README.md @@ -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. diff --git a/packages/scripts/src/protos.ts b/packages/scripts/src/protos.ts index 28789d95a..6972d3bd2 100644 --- a/packages/scripts/src/protos.ts +++ b/packages/scripts/src/protos.ts @@ -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 = [ From 8b03784be5d2b8a497ebb120b3d4287d623122ed Mon Sep 17 00:00:00 2001 From: tresabhi <43380238+tresabhi@users.noreply.github.com> Date: Sun, 4 Oct 2026 13:21:21 -0500 Subject: [PATCH 10/13] clis --- README.md | 24 +++++++++++++++++++----- 1 file changed, 19 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index 658c47e5e..4dc57a641 100644 --- a/README.md +++ b/README.md @@ -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 From 784c3e58c162ef9f4f9797df9028a17f4b0bbb82 Mon Sep 17 00:00:00 2001 From: tresabhi <43380238+tresabhi@users.noreply.github.com> Date: Sun, 4 Oct 2026 13:27:46 -0500 Subject: [PATCH 11/13] protos --- README.md | 22 +++++++++++++++++++++- 1 file changed, 21 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 4dc57a641..0f9e9b155 100644 --- a/README.md +++ b/README.md @@ -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 +``` From 6be4ff97f3b0707c22356b04126f84acd2f30dd2 Mon Sep 17 00:00:00 2001 From: tresabhi <43380238+tresabhi@users.noreply.github.com> Date: Sun, 4 Oct 2026 13:36:33 -0500 Subject: [PATCH 12/13] env --- README.md | 4 ++++ packages/website/template.env | 35 +++++++++++++++++++++++++++++++++++ 2 files changed, 39 insertions(+) create mode 100644 packages/website/template.env diff --git a/README.md b/README.md index 0f9e9b155..e2a50f4ef 100644 --- a/README.md +++ b/README.md @@ -56,6 +56,10 @@ Finally, compile the proto files into TypeScript. build build-protos ``` +## Developing: Environment + +Go through the different packages in the `packages` directory and clone their respective `template.env`'s to `.env` files. Follow the instructions in the `.env` files to fill them out as much as you can. + ## Developing: Running ```bash diff --git a/packages/website/template.env b/packages/website/template.env new file mode 100644 index 000000000..e2f4d103f --- /dev/null +++ b/packages/website/template.env @@ -0,0 +1,35 @@ +# Point this to your local installation of the game (make sure you see the Data +# folder within the directory you're putting here); don't forget to use +# double quotation marks if your path has spaces +CLIENT_DIR= + +# Should be set to * for local development to build all chunks at once +CHUNK=* + +# Should always be development when using CHUNKS=* +PUBLIC_ENVIRONMENT=development + +# GuidesBlitz is the official textual partner of BlitzKit, but, really any +# website that supports BlitzKit tank slugs like example.com/tank-slug works +# too +PUBLIC_GUIDE_WEBSITE=https://guidesblitz.com + +# The tag manager doesn't do anything in localhost, but here's what BlitzKit +# uses for completeness sake +PUBLIC_GOOGLE_TAG_MANAGER_ID=G-GL2JVHCGPQ + +# A very rare, but required variable, enabling the advertising of BlitzKit +# OpenTest; TODO: make this a string field to allow for cross-advertising for +# any branch of BlitzKit +PUBLIC_PROMOTE_OPENTEST=false + +# Legacy variable; this will be removed soon +PUBLIC_STATIC_ASSET_BASE=https://assets.blitzkit.app + +# Proprietary Wargaming fields; you shouldn't need these for 99% of the tasks +WOTB_GLOSSARY= +WOTB_GLOSSARY_DOMAIN= +WOTB_GLOSSARY_PATH= + +# Generate your own application id: https://developers.wargaming.net +PUBLIC_WARGAMING_APPLICATION_ID= \ No newline at end of file From dd11efd48165e79ffe7ac3cc8a6ed7793aa8f864 Mon Sep 17 00:00:00 2001 From: tresabhi <43380238+tresabhi@users.noreply.github.com> Date: Sun, 4 Oct 2026 13:37:21 -0500 Subject: [PATCH 13/13] running --- README.md | 8 ++++++++ 1 file changed, 8 insertions(+) diff --git a/README.md b/README.md index e2a50f4ef..1568ac800 100644 --- a/README.md +++ b/README.md @@ -62,6 +62,14 @@ Go through the different packages in the `packages` directory and clone their re ## Developing: Running +Launching the website is as easy as running the `dev` script. + ```bash bun dev ``` + +If you ever make a change to any proto file, make sure to rebuild them. + +```bash +build build-protos +```