Paladins Assistant

A powerful and unique Discord Bot for getting statistics on Paladins players.

Important

The purpose of having this bot's code now public is so it can be used as a learning resource. To understand some coding concepts used within this bot it's assumed you have a basic understand of both Python 3 and the Python Discord Wrapper Discord.py.

Getting Started

Clone this GitHub repo using whatever method you prefer. Next install all the necessary libraries however you prefer (either one by one or using requirements.txt). Again this repo is not for beginners. There are plenty of online resources for setting up a discord bot if you need help.

To get the bot to actually run correctly, you will need to copy the file: token_example.json and rename the copy to: token.json and then update most of the variables inside it. Below is an explanation of what each config parameter does.

discord_token (Your Discord Bot Token)
prefix (What default prefix you want the bot to have)
id (Paladins API ID)
key (Paladins API KEY)
is_live_bot (In general it's good practice when developing a public discord bot to have two separate versions of the bot so when you are making changes you are not messing with the version people are using. Setting this to true enables some background tasks.)
guild_id (Whatever guild ID this points too will be what bot uses to count the online members.)
dev_guild_id (Development Guild ID of where you are messing with this bot.)
dev_guild_api_error_channel_id (Specific Channel ID in your above server for Paladins API Errors.)
dev_guild_user_error_channel_id (Specific Channel ID in your above server for self reported User Errors. This can be the same ID as above if wanted.)

Warning

If you would like to contribute code (specifically new commands or features) to the bot while it's still active. Please join the discord support server before submitting a pull request, so the feature can be discussed beforehand. Go to the #role-menu channel and react with the lock symbol to give yourself the programmer role.

API Wrappers Used

Paladins Assistant uses the Python Discord wrapper Discord.py to connect to the Discord API.

Paladins Assistant uses the wrapper Pyrez and aRez to access the Hi-Rez Studios Paladins API.

Legacy Contributors

Code: @Luís

Code: @DevilXD

Bot Logo: @Lockness4

Paladins License

All information obtained is provided by Hi-Rez Studios API and is thus their property. According to Section 11a of the API Terms of Use, you must attribute any data provided as below.