Welcome to the official repository for a basic Discord.js bot utilizing the MojangJS, HypixelJS & NameMC APIs for information on Minecraft users.
DISCLAIMER: Because this was for the NameMC Discord, some of the command wordings are built for it as well. If you'd like, please go ahead and change them.
This is a basic Discord.js bot utilizing the MojangJS, HypixelJS & NameMC APIs for information on Minecraft users, including basic moderation such as modmail, avatar, and whois. Initially crafted for the NameMC Discord server, this is now being made open source by Bea#0001.
Requirements & Setup:
-
A Discord Bot Application (Register Here)
-
Obtain a Hypixel API key by joining
mc.hypixel.netwith a valid Minecraft account and running the /api command. You will then be assigned a unique key that is to remain private. You should put it in your .env (an example is in this repository.) -
Create a new application on Discord like so:
-
Give it a name!
-
When you have completed, you should see a page application like below. You’ll see information like a client ID, but that's not what we need.
-
Create your bot user by navigating to the bot section and hitting Add Bot.
-
Once your bot has been created, you should see a page like below. Make sure to hit COPY and store this copied selection somewhere safe, because once someone has that, destruction of a server/your bot can easily be caused. This is called your bot token.
-
Add your bot to a test server in Discord. You can do this by redirecting yourself in The Developer Portal by clicking Oauth2. Select bot, then give it Administrator permissions. If you make it public, I highly discourge keeping the Administrator perms. Then, copy the link it gives you. The link should look like the one below,
https://discord.com/api/oauth2/authorize?client_id=748716618267492423&permissions=8&scope=bot -
Go through all the code, and change the prefixes everywhere. If you're feeling lazy, just search the entire project for
n?which is the pre-set prefix and replaceall with the one you want. If you're new to coding, I suggest trying Visual Studio Code, a code editor which works amazingly for Discord bot development in JavaScript. -
EDIT YOUR ENV. This is the most important step because you put your token and API key here. Replace the file name
.env.examplewith.envfor it to work properly, then replaceTOKEN=YOURTOKENHEREwith your token. Make sure to also replaceHYPIXELAPI_KEY=YOURAPIKEYHEREwith your key generated in step 2. -
Install all the fancy npm packages! This is also a fun step. Go into your terminal directory to your bot wherever it's being hosted and type
npm i. This auto installs the packages this bot relies on! -
To run:
node index.js
- After that, console should start spitting out a table and a green ready message.
- If it works, you should be able to run your bot's help command in your server!
If you want to host this bot without having to re-run it locally on your computer and restarting it every time you shut it down, I suggest the following:
VPS:
Heroku, for private bots:
This has free hosting, and runs for the entire month if you link a valid debit/credit card too! This is how I host my public bot, Amour (On a professional dyno.)
DigitalOcean, a VPS company:
This is also a good solution, with a range of operating systems such as Ubuntu, which is a personal favorite (:
Glitch:
This is a simple yet effective host, especially for plain bots like this. Put your token in and you're off. Just make sure your project is private, or people can steal your tokens!
Repl.it:
This site can grab your GitHub repository with ease if you clone this one and edit it to your liking, and it has been efficient for me in the past when working on small bots for friends.
If you need help setting up the bot or are having trouble, feel free to reach out to me at bea@beasleeps.tech, my Twitter, or my Discord, REDRUM#0001.
Good luck!