Discord bot for SkyBlock graph

Description

Optional program which uses my Bank graph for Hypixel Skyblock program and connects it to a Discord bot which sends the graph to you when you type a command.

This repository requires the Bank graph for Hypixel SkyBlock in order to work!

Description
Table of Contents
How to install
How to use
How it works
Tests and results
License and credits

How to install

Installing the libraries

The libraries can be installed with pip by using this command:

pip install discord.py python-dotenv

The library os is preinstalled with Python 3.11.0.

You can also install them with requirements.txt.

Installing the required repositories

Download and install Bank graph for Hypixel SkyBlock (Installation instructions are in the linked repository).

Then download this repository as a .zip file and unzip it to a folder.

Copy and paste discordBot.py and .env in the folder you extracted while you installed Bank graph for Hypixel SkyBlock.

Your folder structure now should look like this:

\Bank-graph-for-Hypixel-Skyblock-main (or however you called your main directory)
  \data
    - readme.txt
  - main.py
  - discordBot.py
  - .env
  - (OPTIONAL LICENSE, README.md AND requirements.txt)

How to get a Discord bot Token

In order to get a Bot Token you have to create a new Bot in the Discord Developer Portal.

To do that register there and then under the tab 'Applications' click on 'New Application'

Give your Application a name and create it.

In the bot tab of your application you have to click 'Add bot' and confirm you choice in the pop-up window.

After you did that click on 'Reset Token' to get a new Token.

When you scroll down in the bot tab, you will see a category named 'Privileged Gateway Intents' where you have to enable 'MESSAGE CONTENT INTENT' and save the changes you made.

To invite your bot to a server you have to generate a link. To do that go to 'OAuth2' and 'URL Generator'.

Under the 'Scopes' category you have to enable 'bot' and under the 'General permissions' enable 'Read Messages/View Channels' and 'Send Messages'. Then you can copy the Generated URL to your browser and invite the Bot to one of your servers.

Editing the .env file

The .env file is a safe way of storing your (secret) variables like the Bot Token or your Hypixel API Key for your program.

When you open the .env file you will see the following:

DISCORD_TOKEN="[YOUR DISCORD BOT TOKEN HERE]"
API_KEY="[YOUR HYPIXEL API KEY HERE]"
PLAYER_NAME="[YOUR MINECRAFT PLAYER NAME HERE]"

This is where you have to put your Discord Bot Token, Hypixel API key and your Minecraft Player NAME so that the program can use them later.

How to use

After you installed the program and set everything up you can run the program. You should see that the previously offline bot is now online and you can start writing messages to it.

When you write '!graph' the program will generate a graph of your SkyBlock Bank Balance and send it to the channel you send the command to.

There are two ways you can customize the program. When you open discordBot.py you will see these two lines:

command_prefix = '!'
dark_mode = False

'command_prefix' is the prefix the bot uses to destinguish commands from messages. You can change it to something else (e.g. '$' or '?') which can be very useful when you have a server with many different bots.

'dark_mode' specifies if the program should create and send the graph in dark or in light mode. It is set to light mode by default. Change False to True to generate dark mode graphs instead.

Be aware that you have to terminate and rerun the program for changes to take affect.

How it works

load_dotenv(find_dotenv())

In the beginning this program loads the contents in the .env file so that it can use them later. Then it defines some basic stuff like the command prefix used by the bot to recognize a command or if the generated graph should be in dark mode or not.

command_prefix = '!'
dark_mode = False

Afterwards it sets up the Discord Message intents so that the Bot can read and react to messages.

intents = discord.Intents.default()
intents.message_content = True
client = discord.Client(intents = intents)

The the two events the bot has are defined.

The first event is when the program connects to Discord to start up the bot. In this event the program prints out when the the connection is established and it prints out the names of the servers it is connected to. Here the Bot also changes its status to "Watching your bank account".

@client.event
async def on_ready():
    print('Logged in as a bot {0.user}'.format(client))
    print('Logged in following servers: ')
    for guild in client.guilds:
        print(str(guild))
    await client.change_presence(activity=discord.Activity(type=discord.ActivityType.watching, name='your bank account'))

In the second event the bot gets the messages sent and processes them. It starts by checking if the message was sent by a bot and if it was sent by a bot it ignores the message.

if message.author.bot:
    return

Then it checks if the message contains the command graph with the predetermined command prefix. To make sure that the command is not case-sensitive the program converts the message to lowercase, which means that it does not matter if you write !graph, !GRAPH or something in between. When this command is recognized by the program it tries to generate a graph using the informations given by the .env file. When the graph was successfully built the Discord bot sends it to the channel it recieved the command from, however if generating the graph failed it sends an error message instead.

if message.content.lower() == command_prefix + 'graph':
    try:
        generateGraph(os.environ.get('API_KEY'), os.environ.get('PLAYER_NAME'), dark_mode)
        with open('graph.png', 'rb') as f:
            file = discord.File(f, filename = 'graph.png')
            await message.channel.send(file = file)
    except:
        await message.channel.send('Program ran into a problem while generating graph...')

At the end it starts a Bot using your Discord bot Token.

client.run(os.environ.get('DISCORD_TOKEN'))

Tests and results

Program tested with Python 3.11.0.

License and credits

This work is made available under the GNU Affero General Public License v3.0.

Project made by TechLife.

TachLaif/Discord-bot-for-SkyBlock-graph