https://github.com/codeman99/blitzbot
Blitz bot is your friendly stat freak for your very own Discord server!
https://github.com/codeman99/blitzbot
bot discord nodejs wotblitz
Last synced: about 1 year ago
JSON representation
Blitz bot is your friendly stat freak for your very own Discord server!
- Host: GitHub
- URL: https://github.com/codeman99/blitzbot
- Owner: CodeMan99
- License: isc
- Created: 2016-04-17T01:12:55.000Z (almost 10 years ago)
- Default Branch: master
- Last Pushed: 2024-02-07T03:19:50.000Z (about 2 years ago)
- Last Synced: 2024-02-07T04:26:00.613Z (about 2 years ago)
- Topics: bot, discord, nodejs, wotblitz
- Language: JavaScript
- Homepage:
- Size: 1.84 MB
- Stars: 5
- Watchers: 5
- Forks: 7
- Open Issues: 5
-
Metadata Files:
- Readme: README.md
- Changelog: change-log.json
- Contributing: CONTRIBUTING.md
- License: LICENSE.md
Awesome Lists containing this project
README
blitzbot [](https://circleci.com/gh/CodeMan99/blitzbot)
========
Statistics chat bot for World of Tanks Blitz on Discord.
# IMPORTANT: END OF LIFE
As of February 5, 2024 this project is officially at end of life. The active discord instance will stop indefinitely on February 29, 2024. The repository will also be marked as _archived_.
Commands
--------
The following are commands as of v2.3.3. An argument in `[braces]` is optional. An argument in `` is required.
* `@blitzbot help [command]` -- List all known commands or get help for a particular command.
* `(direct message): help [command]` -- List all known commands or get help for a particular command.
* `@blitzbot hi` -- Just saying hello.
* `@blitzbot hello` -- Just saying hello.
* `@blitzbot changes [version]` -- Get the update notes from the author (defaults to current version).
* `@blitzbot version` -- Replies the current blitzbot version.
* `@blitzbot add ` -- Associate your blitz screen name with discord.
* `@blitzbot win-rate` -- Get the win rate of your account.
* `@blitzbot tank-win-rate ` -- Get your win rate on the given tank (replace spaces with dashes).
* `@blitzbot mastery-list [level]` -- List tanks at the given mastery level, sorted by battle count (default: "Mastery").
* `@blitzbot roster [clan-tag]` -- List a clan roster. Defaults to your clan if none specified.
* `@blitzbot max-xp` -- Get your top 10 *max-xp* values.
* `@blitzbot donate` -- Get a link to generously donate via paypal.
Installation Setup
------------------
Running your own instance probably isn't necessary unless you are forking this project. Follow these steps to get started.
1. Install [node.js](https://nodejs.org), v12.x or newer.
2. Get a WarGaming [application id](https://na.wargaming.net/developers/applications/).
3. Create a Discord [api application](https://discordapp.com/developers/applications/me).
4. Create a Discord user. Use a unique name, not "blitzbot" please.
5. Decide which region is your default. One of "na", "eu", "ru", or "asia".
6. Create a package that you can install by running `npm pack` in the repo root.
7. Install the resulting package globally: `npm install -g blitzbot-3.5.0.tgz`.
8. Create a file called "blitzbot.json" in the root of the install, in it store the values from steps 2-5.
```json
{
"app": {
"secret": "-- discord application secret here --"
},
"user": {
"token": "-- discord user token here --"
},
"wotblitz": {
"default_region": "na",
"key": "-- WarGaming application id here --"
}
}
```
Finally, start the bot by running the command `blitzbot` in your shell. It is suggested to run the code via a process monitor
like [forever](https://www.npmjs.com/package/forever), so when your bot crashes it will be silent to your audience.
Work in progress
----------------
*Everything* is a work in progress. Expect large and breaking changes at any point. In particular,
expect responses to become more streamlined, using more "natural" English.