:video_game: StatG - PUBG Statistics Discord Bot

StatG is an open source, self-hosted discord bot that can post PUBG statistics in your discord channel!

Alt text

:star: Features

Fetch and display your PUBG stats inside your Discord channel
Get infos and statistics about your and your teams latest match performance
Links to your pubg.op.gg page for all stats
Works with PC regions (XBOX and PS4 might follow later)
Open-source and self-hosted

:blue_book: Commands

!statg stats [GAME_MODE] Shows your current season stats. Per default your Discord name is used to fetch stats. If your Discord name differs from your PUBG name, use the !statg register command as described below to manually set your PUBG name for all future commands. The optional GAME_MODE arguments are:
- solo Stats from third-person solo matches only.
- solo-fpp Stats from first-person solo matches only.
- duo Stats from third-person duo matches only.
- duo-fpp Stats from first-person duo matches only.
- squad Stats from third-person squad matches only.
- squad-fpp Stats from first-person squad matches only.
!statg register PUBG_PLAYER_NAME [REGION_NAME] Links your PUBG player name to your Discord account and enables you to fetch your stats even when your Discord name is different from your PUBG name. The optional argument REGION_NAME specifies the region of the player. If omitted the default region is used which can be set using the !statg region command (see below). For a list of available regions, also see !statg region command.
!statg match Shows your and your squads latest match info (all game modes combined). Similar to the !statg stats command your Discord name is used per default unless you registered another PUBG name through !statg register.
!statg unregister Undoes register command.
!statg region REGION_NAME Sets the default region used by register command. Available regions are:
- steam (for everyone outside of South Korea)
- kakao (for players in South Korea)
!statg help Displays help about commands.
!statg version Displays version of the stat-g bot.
!statg status Displays the current status of the PUBG api.

:computer: Installation

To run the bot locally on your machine, you will need:

Node.js (Download-Link)
A PUBG API key (obtainable from here)
A discord bot token + client id (get them here)
Add the bot to your server by opening the following link and logging in
```
https://discordapp.com/oauth2/authorize?&client_id=YOUR_CLIENT_ID&scope=bot&permissions=0
```
(replace YOUR_CLIENT_ID with the client id of your bot)

IMPORTANT: Keep the discord token and pubg api key secret.

After that, everything else is straightforward:

Clone this repo or download it as .zip-file and unpack it to a folder of your liking
Open a terminal and navigate to the project folder
Run the bot with the commands
```
npm install
node ./src/bot.js discordToken=TOKEN_HERE pubgApiKey=API_KEY_HERE
```
(replace TOKEN_HERE and API_KEY_HERE with the respective values)

For easier starting during development you can add a file named auth.json to the config directory with the following contents:

{
  "pubgApiKey": "API_KEY_HERE",
  "discordToken": "TOKEN_HERE"
}

Since this file will contain your secret tokens and keys you will have to make sure to keep this file secret too. Once created you can run the bot with

node ./src/bot.js runConfig=debug

or, even easier in case you have nodemon installed, with

npm run debug

:whale: Running in Docker

Alternatively you can run the bot inside a docker container. For now you will have to build the image by yourself using the Dockerfile of this repo. You will also need to get PUBG API key and Discord token as described above.

Clone this repo or download it as .zip-file and unpack it to a folder of your liking
Open a terminal and navigate to the project folder
Build the image using docker build -t statg-bot:latest .
Start the container using the command
```
docker run statg-bot discordToken=TOKEN_HERE pubgApiKey=API_KEY_HERE
```
(again replace TOKEN_HERE and API_KEY_HERE with the respective values)

To persist data there are two volumes you can mount to: /statg/data (contains SQLite-DB-File) and /statg/logs (contains log file). A docker-compose.yml file could look like this:

version: '3'
services:
  statg-bot:
    restart: always
    image: statg-bot:latest
    container_name: statg-bot
    entrypoint: 
    - "node"
    - "./src/bot.js"
    - "discordToken=TOKEN_HERE"
    - "pubgApiKey=API_KEY_HERE"
    volumes: 
    - "YOUR_DATA_VOLUME_HERE:/statg/data"
    - "YOUR_LOGS_VOLUME_HERE:/statg/logs"

:sparkles: Contributing

All contributions are generally welcomed and make me happy ;) Before coding you should get yourself Node.js, npm (which comes with Node.js) and the api keys/discord tokens as described under Installation. For code editing I can recommend Visual Studio Code, but feel free to use any code editor you like.

If you want to make doubly sure that your pull request will be accepted, you can run the unit tests inside the test directory with npm t or npm test. By running npm run lint you can also make sure that your code is fulfills the Airbnb js conventions used in this project.

:heart: Thanks to all contributors

:statue_of_liberty: License

MIT

kuper-adrian / statg-bot

readme