Heptagram Bot

Welcome to Heptagram.

The goal is for Heptagram to be the all in one open source discord bot with as many features as possible. Please note, this bot is open source, but is intended to use the version we have hosted. We will be publishing an bot invite link as soon as we finish getting our hosting set up.

Contributing

Contributing is welcomed! We have extensive documentation bellow as well as comments in the code to help you out. Please take a look at our GitHub issues for ideas on what to work on. Our one request is that you keep our comments in the code. You are welcome to remove them and then add them back, but please have them in whatever code you submit. To contibute, please do all your work on a fork and then open a PR.

Pull Requests

All work should be done on a fork. PR's should be to the Heptagram-Staged branch.

Bot Community.

You can join our discord at https://discord.gg/HSupF99kpq. This server is still iorning out some details, so please be patient. :)

Open Sauced

Heptagram is proud to work with Open Sauced and the Open Sauced discord server. Open Sauced is a website that helps you track your open source contributions and contribution goals. You can find the website at https://opensauced.pizza/. They also have an amaazing Discord community and I highly recommend you check it out. The link for the discord server is https://discord.gg/PDJNR7u37h. I am an admin in the server and you can feel free to message me there. My username is J-dogcoder#0803.

Documentation

Setting Up Discord

Setting Up Sandbox Server for testing.

Create a empty server in Discord.

Create roles Mods , Users , and Muted.

Invite Bot to your Server (see Creating a Bot User below).

Setting Up Bot User

First you need to go to discord developers and click "New Application" Now give your bot a name and a picture, a description isn't necessary. Click "Create Application". On the next page scroll down until you see "Create a bot user", click that. Also click yes do it. Now you can get your bot's token, by using the "click to reveal button" in the app bot user section. Remember to uncheck Public Bot There's your token! Now its time to invite your bot to your server. Don't worry about your bot being started for this next step. Change the client_id in the URL to your Client ID under App Details, then go to this url https://discordapp.com/oauth2/authorize?&client_id=YOUR_CLIENT_ID_HERE&scope=bot&permissions=0 Now select your sever, then click authorize. That's it! Now you can start your bot.

Installing Heptagram

Clone repository

git clone https://github.com/Heptagram-Bot/Heptagram.git

Or with GitHub CLI

gh repo clone Heptagram-Bot/Heptagram

Installing dependencies

Make sure you are in the correct folder.

npm install

Connecting Heptagram with Discord

To connect Heptagram with Discord you will need to set your environment variables with your credentials.

Setting up your local development

cp example-config.json config.json   # Linux/Mac.

copy example-config.json config.json # Window.

For local development we recommend copying the example-config.json file with your own credentials, for production we recommend you refer to your systems preferred way of storing environment variables securely.

Fill out the config.json will your Discord applications credentials, e.g.

{
	"prefix": "!",
	"token": "your-token-goes-here"
}

Running Heptagram

Running Heptagram locally

Make sure you are in the correct folder. Run the Heptagram using the following command.

node main.js

Troubleshooting Heptagram

Heptagram is still in active development - bugs and issues are expected. If your experience a bug or issues you could not fix, do not hesitate to open a new GitHub issue.

Heptagram crashes when trying to clear messages.

This happens when Heptagram doesn't have the correct administrative permissions to delete messages, a good fix for this is to make a role with those permissions and assign that role to Heptagram, or give the permissions to Heptagram directly.

vincentmuriuki/Heptagram