Merge pull request #39 from tresabhi/1.13.1

README.md

@@ -1,21 +1,42 @@
 # blitzkrieg
 
-A Discord bot for anything and everything related to World of Tanks Blitz.
+Tools for everything World of Tanks Blitz
 
-## Invite the Bot
+## Invite the bot
 
-Join the [Discord server](https://discord.gg/nDt7AjGJQH), click on the bot's profile, and click "Add to Server".
+Go to [application directory for Blitzkrieg](https://discord.com/application-directory/1097673957865443370) and click "Add to Server." Voila! You're ready to go.
 
-## Using
+![Blitzkrieg application directory](https://i.imgur.com/JlEA0J1.png)
 
-### Installing dependencies
+## Visit the website
+
+### https://blitz-krieg.vercel.app/
+
+![Blitzkrieg website](https://i.imgur.com/QOXUP63.png)
+
+## Visit the documentation website
+
+### https://tresabhi.github.io/blitzkrieg/
+
+![Blitzkrieg documentation website](https://i.imgur.com/mCZCZEI.png)
+
+## Run the bot
+
+### Install dependencies
 
 ```bash
 yarn
 ```
 
-### Running
+### Create `.env`
+
+```env
+GH_TOKEN={YOUR_GITHUB_TOKEN_HERE}
+DISCORD_TOKEN={YOUR_DISCORD_TOKE_HERE}
+```
+
+### Run the command
 
 ```bash
-yarn start discord-token=<token> wargaming-application-id=<id>
+yarn dev:bot
 ```

docs/changelogs/1.13.1.md

@@ -0,0 +1,17 @@
+# Blitzkrieg 1.13.1
+
+The quickest minor update in town 🤠
+
+## Changes
+
+- Added a title, description, and icon to the website
+- Added display options to the session tracker
+
+## Fixes
+
+- Center aligned stats in breakdown to work better on low width devices
+- Center aligned the Blitzkrieg logo in the navbar
+
+## Technical Changes
+
+- Added up-to-date information to `README.md` and embed docs

docs/guide/embeds.md

@@ -1,23 +1,23 @@
 # Embeds
 
-Embeds are generated by a few commands as a URL that can be loaded in a browser/streaming software.
+Embeds are URLs generated by commands or tools that represent the "naked" version of the respective command or tool
 
 ## Creating Embeds
 
-1. Use a command of your liking (for example, `/stats`).
-2. Customize the command however you like and the URL generated for the embed will match your needs.
-3. Send the command and when the bot is "done thinking," an "Embed" button will appear below the bot's reply.
+1. Use a command or tool and click on "Embed" if it's available
+2. Make sure to tweak the settings of the command or tool because embeds replicate everything
 
 ## Using Embeds in Streaming Softwares
 
-1. Click on the "Embed" button.
-2. Copy the URL from your browser.
-3. Paste the URL into a Browser Source.
-4. Set the refresh rate/FPS to something very low like `0.0167` (that's 1 frame every 60 seconds).
+1. Click on the "Embed" button
+   - If this was generated by a command, copy the URL from the browser
+   - If this was generated by a tool, the URL has been copied to your clipboard already
+2. Paste this URL into your streaming service as a "Browser Source"
+   - Tool embeds use local storage so data won't be transferred from you browser to your streaming software
+   - Make sure to visit the tool's page in your streaming software (using the "Interact" feature) and then open the embed
+   - Set your browser source refresh rate to `1Hz` because that's how fast embeds refresh
 
 ## How Embeds Behave
 
-- They load like any normal website albeit with a significant delay.
-- They auto refresh every `60s`.
-- All embeds and images generated by Blitzkrieg have a width of `640px` but the height varies and must be found manually through trial and error.
-  - It's okay to have a Browser Source that has a height larger than needed as Blitzkrieg embeds are transparent.
+- They load like any normal website
+- They auto refresh every `1s`

package.json

@@ -1,7 +1,7 @@
 {
   "name": "blitzkrieg",
-  "version": "1.13.0",
-  "description": "🎉 All-in-one Discord bot for everything World of Tanks Blitz",
+  "version": "1.13.1",
+  "description": "🎉 Tools for everything World of Tanks Blitz",
   "main": "src/server.ts",
   "type": "module",
   "scripts": {
@@ -37,6 +37,7 @@
     "esbuild": "^0.19.3",
     "express": "^4.18.2",
     "fuzzysort": "^2.0.4",
+    "immer": "^10.0.2",
     "lodash": "^4.17.21",
     "markdown-escape": "^2.0.0",
     "next": "^13.5.2",