mr1bitl8r / spookybot

🎃 A spooky Discord bot

SpookyBot

🎃 A spooky Discord bot

This project is convenient for people who want to get into open source and contribute to different projects especially during the Hacktoberfest.

Don't hesitate to ask me for help on my Discord server, I would help you with great pleasure!

🤖 Add the bot on your server

You just need to click on this link and validate the form without changing any permission.

🌐 Adding a language

You can add languages to the robot so that it is translated and accessible to everyone!

To do this, nothing could be simpler, just copy the file ./app/lang/en.js then rename it following the ISO 639-1 nomenclature. Then you just need to modify the file as you wish. For the translation to be set up on the robot, do not hesitate to open a pull request by following this guide.

To react to a word, you need two elements in the translation file: the word and the emoji with which it will react.

{
  "name": "halloween",
  "emoji": "🎃"
}

You can see that the emoji element is an emoji, but you can also use a custom emoji. For that, I strongly advise you to read this guide.

💻 Testing locally

1. Create a bot on the Discord developer portal,
2. Create a webhook on your own discord server by following this tutorial,
3. Copy the ./app/config/config.example.json from the project to ./app/config/config.json and fill in the gaps with the information from the bot and the webhook. The first token is on the bot page accessed from the side of the Discord Developer Portal, and the webook information is found on the page when you navigate to the webhook url,
4. Invite your dev bot to your server by following this url, replacing the client id with your bot's client id (found on it's general information page), and the permissions with the Permission Integer created in the Developer Portal as you select permissions for your bot,
5. Once these steps are setup, simply run make startup_dev from the terminal in the root directory of the repo, 5.1 If you want to install node modules you could just add it into your local package.json and run the make build_dev_image after that you need to recreate the container.
6. Test the bot is connected by running <your-prefix>help to get a list of commands, and then initialize the DB by running <your-prefix>emitgc. It should then respond with "Join with <#> users,
7. Test that the bot reacts to comments by typing one of the words in lang/<your-lang>.js. The bot should respond with an emoji!

👤 Author

LucasAlt

• Website: https://www.lucasalt.fr
• Twitter: @LucasCtrlAlt
• GitHub: @LucasCtrl

🙏 Thanks

• @ALMerrill - Translation (es, de), code, documentation
• @marc2332 - Translation (es, ca)
• @tmetten - Translation (nl)
• @dragonDScript - Translation (ca)
• @Pervolarakis - Translation (gr)
• And many more!

🤝 Contributing

Before contributing to this project, make sure you have read the contribution guidelines!

1. Fork it (https://github.com/LucasCtrl/spookyBot/fork)
2. Create your feature branch (git checkout -b feature/fooBar)
3. Commit your changes (git commit -am 'Add some fooBar')
4. Push to the branch (git push origin feature/fooBar)
5. Create a new Pull Request

Show your support

Give a ⭐️ if you like this project!

📝 License

This project is open source and available under the MIT