Skip to main content

A discord bot that reports PUBG match stats to a discord server

Project description

pubg-reports

A Python-based Discord bot that tracks users from a given server in PUBG to automatically send their post-match stats to a pre-specified Discord channel.

Prerequisites

  • Python 3.5.3 or higher is required
  • PUBG API Key
  • Discord API key
  • Discord server & channel IDs
    • The channel IDs are going to be used by the bot to
      1. Register new users
      2. Send reports for solo, duo and squad PUBG rounds
    • To acquire an ID for a given channel, please enabled developer mode in your Discord user settings, then simply right click a channel and there will be an option to copy ID

Installation

OS X & Linux:

$ python3 -m pip install -U pubg-reports

Windows:

$ py -3 -m pip install -U pubg-reports

Configuration

To configure the tokens that are required to run the bot

$ bot-config-tokens

To configure the Discord channels that are required for the bot to send reports at

$ bot-config-channels

To configure the tokens and channels in one go

$ bot-config-all

Running the bot

To run the bot, simply do

$ bot-run

Usage

  • To use the bot, a user must register by typing !reg PUBG-IGN [Case sensitive]

  • To check all the registered users within the server, type !users

  • After a PUBG round ends, a user can get the top 3 players kill-wise in that round by typing !top3

Example Match Report

  • This is how a post match report looks like

Known Issues

  • A round of PUBG will not get reported for one of the teams if team A is playing against team B and they are both on the same Discord server.
  • The bot supports up to one Discord server. There are plans to expand the capabilities of the bot to support multi servers.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

pubg-reports-0.0.0.1.4.1.tar.gz (15.1 kB view hashes)

Uploaded Source

Built Distribution

pubg_reports-0.0.0.1.4.1-py3-none-any.whl (19.5 kB view hashes)

Uploaded Python 3

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page