@r4dixx/discord-quotebot v5.0.1

Discord-QuoteBot 🤖

Discord bot to output, save, and edit quotes upon commands.

• Get a random quote → !quote
• Save a quote → !quote your_quote
• Edit last saved quote (admins only) → !requote your_quote_edited
• Edit chosen quote (admins only) → !requote your_quote **>** your_quote_edited
• Delete last saved quote (admins only) → !unquote
• Delete chosen quote (admins only) → !unquote your_quote_to_delete
• Display help message (admins only) → !help or mention the bot

These can be customized pretty heavily in src/config/config.json

📖 Table of contents

• Preliminary steps
  • Important notes
• Setup
  • Locally
  • In the cloud
• Customization
• Test if everything is up and running
• About the author
• Contributing
• Show your support
• License

🏁 Preliminary steps

1. Create a new Discord app and an associated bot account.

2. Create a Discord invite with send messages permissions and your application client ID:

   https://discordapp.com/oauth2/authorize?scope=bot&permissions=2048&client_id=YOUR_CLIENT_ID

3. Grab the latest release

4. Open src/config/private.json and:

   • Copy your bot account token and paste it into the token field.

   • Paste your user ID in botAdminIds.

     This will give you more rights (edition, deletion, etc).
     You can add as many admins as you'd like but I recommend you tread carefully.

Important notes

• Users declared as admins of this bot are not server admins (and vice-versa)
• Never commit private information. To avoid accidents I recommend you run: git update-index --assume-unchanged src/private.json
• To find your user ID, check the official support page.
• If you're lost, see the official documentation.

🏗 Setup

Locally

Make sure you have Node.js installed.

$ cd Discord-QuoteBot
$ npm install
$ npm start

In the cloud

Make sure you have the Heroku CLI installed.

$ cd Discord-QuoteBot
$ heroku create
$ git push heroku main

We only need a worker process to run the bot.

$ heroku ps:scale web=0
$ heroku ps:scale worker=1

⚙️ Customization

Edit src/config/config.json and customize it to your likings

Warning: Some prefix/commands can cause conflicts with other bots!

🧪 Test if everything is up and running

Send !ping in your Discord server and see the magic happen

👤 About the author

• Website: r4dixx.github.io
• Twitter: @r4dixx
• Github: @r4dixx
• LinkedIn: @r4dixx

🤝 Contributing

Contributions, issues and feature requests are welcome!Feel free to check issues page.

🤗 Show your support

Give a ⭐️ if this project helped you!

📝 License

Copyright © 2021 r4dixx. This project is GPL-3.0 licensed.

This README was partially generated with ❤️ by readme-md-generator