diff --git a/README.md b/README.md index 0192d21..303a87a 100755 --- a/README.md +++ b/README.md @@ -4,10 +4,27 @@ Welcome to my GitHub This is a Discord bot that you host yourself (tutorial below) that can tell you the status of your (or any public) Minecraft server and lists the players online. More functions listed below. -##### Table of Contents +## Table of Contents +[Running The Bot](#running-the-bot) +[ Prerequisites](#Prerequisites) +[ Hardware](#Hardware) [Set Up Bot](#setting-up-the-discord-bot) [Add Bot To Server](#inviting-your-bot) +## Running the bot +To run this bot, just start __run.py__ in Python3 +To change settings in this bot, run __setup.py__ in Python3 + +### Prerequisites +You need __*Python 3.5.9*__+ and a stable internet connection in order to run this bot. +When the code is run, it should automatically install the following libraries using pip3: +1. mcstatus +1. discord.py
+If this doesn't happen, please report it as an issue and install them manually. pip3 should automatically install if you don't already have it. + +### Hardware +You can run this bot on just about any hardware that can run Python but if you don't have a device that can keep this bot hosted 24/7, I would recommend using a ![Raspberry Pi](https://www.raspberrypi.org/). They run Linux, are low cost, use very little power and are capable of running this code without an issue. + ## Setting up the Discord bot 1) Go to the [Discord developer site](https://discordapp.com/developers/applications)