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 details)

Uploaded Source

Built Distribution

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

Uploaded Python 3

File details

Details for the file pubg-reports-0.0.0.1.4.1.tar.gz.

File metadata

  • Download URL: pubg-reports-0.0.0.1.4.1.tar.gz
  • Upload date:
  • Size: 15.1 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/1.13.0 pkginfo/1.5.0.1 requests/2.21.0 setuptools/41.0.1 requests-toolbelt/0.9.1 tqdm/4.32.2 CPython/3.6.8

File hashes

Hashes for pubg-reports-0.0.0.1.4.1.tar.gz
Algorithm Hash digest
SHA256 c07d5f3e682d9fb5e5a51941ea2ffc2bee1f6181c61044d3580c14dad41a6678
MD5 f48ff59f0c8d926f40a7b7492aa75bed
BLAKE2b-256 371c6072bb29753f23ee9549cd7e9750f03c9cedbb810e57fb2da80723a27a90

See more details on using hashes here.

File details

Details for the file pubg_reports-0.0.0.1.4.1-py3-none-any.whl.

File metadata

  • Download URL: pubg_reports-0.0.0.1.4.1-py3-none-any.whl
  • Upload date:
  • Size: 19.5 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/1.13.0 pkginfo/1.5.0.1 requests/2.21.0 setuptools/41.0.1 requests-toolbelt/0.9.1 tqdm/4.32.2 CPython/3.6.8

File hashes

Hashes for pubg_reports-0.0.0.1.4.1-py3-none-any.whl
Algorithm Hash digest
SHA256 fe17824a77f0c09d0fa2495aad99e174a98101cee6306ef0db5652368e5c2b20
MD5 151083b5d9b4f5b1c8fe00b333ab3995
BLAKE2b-256 9138234e1171cefddca440e9edbf0dac7cdd9130581a3046a1863d2d764127d6

See more details on using hashes here.

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