Simple discord giveaway bot

Hi! This is a repository for a simple discord giveaway bot, this discord bot is made with discord.js and an npm package called discord-giveaways. If you would like to know how to install and setup this discord bot head to "How to install?"

Preview of discord bot

This is what will show when the bot has been setup successfully.

Features

• Create your own custom giveaways!
• Custom time!
• Custom prize!
• Custom role mention!
• Multiple winners!
• Not manipulable!

How to install?

Using git clone:

1. You have to install Node.js and Git.
2. Create a folder in a place you won't accidentally delete it.
3. Open Command Prompt (Windows) or terminal (Linux).
4. Execute command cd [path to folder].
   • Example on Windows: cd C:\Users\fez6\Desktop\discord-giveaway-bot
   • Example on Linux: cd /home/fez6/Documents/discord-giveaway-bot
5. Execute git clone https://github.com/fez6/discord-giveaway-bot.git command.
6. When you see all of the github files in your folder this means that you downloaded the bot succesfully.

Using this repo zip file:

1. You have to install Node.js and a program to extract zip files. I recommend 7-Zip since it is 100% free, no ad and open-source.
2. Create a folder in a place you won't accidentally delete it.
3. Download the repository as a zip file, which can be done here.
4. Extract the zip file to the folder.
5. When you see all of the github files in your folder this means that you downloaded the bot succesfully.

Usage + Setup

Step 1: Open config.json and change the following values:

Required value	What does this value mean?
token	(String) This is what discord will use to log into your bot. Get this token from the Discord Developer Portal
prefix	(String) This is the prefix to the commands.

Optional Value	What does this value mean?
giveawayRoleID	(String) This is the role the bot will mention when the giveaway starts. Default (empty) will be set to @everyone. Has to be a role ID
showMention	(Boolean) This determines if the mention will be shown or not.
giveawayMention	(Boolean) This determines if there will be a role mentioned.
giveawayManagerID	(String) This options lets the bot know who is able to start giveaways. Default (empty) will be set to any user with MANAGE_MESSAGES permission. Has to be a user ID.

Step 2: Install dependencies (only the first time)

• Windows:
  • Run setup.bat file
• Linux:
  • Run npm i command

Step 3: Start the bot

• Windows:
  • Run start.bat file
• Linux:
  • Run node index.js command

And you are done! You have successfully made your discord bot run. If you are having any troubles refer to the GIF below or open an issue.

The token in this GIF is invalid. You have to use your own.

Contributing to the repository

1. Fork the repository!
2. Clone your fork: git clone https://github.com/your-username/discord-giveaway-bot.git
3. Create your feature branch: git checkout -b my-new-feature
4. Commit your changes: git commit -am 'Add some feature'
5. Push to the branch: git push origin my-new-feature
6. Submit a pull request! ₍ᐢ•ﻌ•ᐢ₎*･ﾟ｡

Contributors ✨

Thanks goes to these wonderful people (emoji key):

fez 💻 📖 🚧 📆

jac 💻 📖 🤔 💬 🐛

OofChair 📖

Tanya 💻

LeVonara 💻

Thomas Fournier 📖

This project follows the all-contributors specification. Contributions of any kind welcome!

LICENSE

MIT