Skip to content

Latest commit

 

History

History
80 lines (49 loc) · 5.43 KB

README.md

File metadata and controls

80 lines (49 loc) · 5.43 KB

Project logo

Base Discord.js Bot

Status GitHub Issues GitHub Pull Requests License


Welome! This repository exists as an easy to install base DiscordJS based Discord Bot.

📝 Table of Contents

🏁 Getting Started

    I created this setup script and repository to exist as easy starting point for anyone who is interesting in beginning creating their own hosted discord bot! My script will make sure you have all required dependencies and libraries and even create the required config.json file with your own personal keys! If you choose to install through this script then you will be able to start Discord.js's own guide at the point right after creating an event handler. I also include an easy to use "bot start.bat" file that will quickly launch and log in your bot for you. If you would rather use the manual install instructions, you can find them HERE.

Alt Text

✔ Prerequisites

If you choose to use my setup script then it will install all of the necessary missing dependencies, get all your files ready, and leave you with a completely prepared environment for your bot as seen in the above example!

You will need to have already made a bot-account/application through discord. You can do so HERE. Afterwards you'll need to invite your bot to whatever server you want it working in. Under your Developer Portal open your application and on the left side chose OAuth2->URL Generator. In the "scopes" box choose "bot". In the permissions box that pops up choose the permissions you want. Copy the url at the bottom of the page, enter it into your address bar, and choose whichever server you'll be inviting your bot to.

💻 Installing

If you've gotten your bot token and are ready to install the bot, you can download the install script HERE and place it anywhere you would like you would like the folder for your bot to live! For instance, if placed and executed in the Documents folder the batch file will create the bot folder at: "Documents/Base-Discordjs-Bot".

You absolutely MUST RUN THE SCRIPT AS AN ADMINISTRATOR! It will not run properly without it. Right click the script and select "Run as Administrator". If prompted if you would like to proceed then choose to run anyway.

At this point the script will proceed to install all of the missing dependencies and download (clone) my entire git repository to the folder you placed the script in. Before we can wrap up however you will need to supply the following information for the bot to work:

  • Your Discord bot token found HERE aplication->Bot->Bot Token
  • Your Application ID found HERE aplication->General Information->Application ID
  • Your Server ID found HERE Open discord application->Right click your server->Copy server ID

After that last prompt it will close and you're left with a completely prepared environment for your bot! If you look inside "base-discordjs-bot" you'll see a file named "bot start.bat". So long as you gave your keys correctly then running that script will start up and log in your bot!

🎈 Usage

Congrats! You've sucessfully set up a working discordjs dev environment for your bot! At this point you should follow Discord.js's own guide for continuing development of your bot! As stated at the beginining of the guide, the script has taken you to the point right after creating an event handler.

⛏️ Built Using

✍️ Authors

🎉 Acknowledgements

  • Hat tip to anyone whose code was used
  • @kylelobo -ReadMe Generator. Very useful as a template builder.
  • @torphedo -Told me how I could use batch scripts to install things that python could not. Ty sir.