Skip to content

Latest commit

 

History

History
82 lines (57 loc) · 2.88 KB

README.md

File metadata and controls

82 lines (57 loc) · 2.88 KB
Raw

Clarence Bot

Clarence is a multipurpose discord bot with admin, fun and information commands

This bot features multiple command types from:

  • Admin
  • Fun
  • General
  • Info

Installation

Docker

Due to the Publish.yml workflow, the newest build will automatically be pushed to DockerHub.

Using a tool like Ouroboros, you can automatically update containers without the need for restarts.

docker run -d \
--name=clarence \
-p 6002:6002 \
-e DISCORD_TOKEN='INSERT DISCORD TOKEN' \
-e MONGOOSE='INSERT MONGODB URL' \
-e OPEN_WEATHERS_API='INSERT OPENWEATHER API KEY' \
-e RAPID_API ='INSERT RAPID API KEY' \
-e PREFIX='-' \
--restart unless-stopped \
kieranr27/clarence:latest

Development

Docker

  • See the tutorial, after going through it you are expected to:
    • Create a new application & make it a bot, from here.
    • Don't forget to give it the Privileged Gateway Intents
    • Invite your bot to your discord server.
    • Get your token & paste in in .env (rename .env.template to .env)
    • Default URL of MongoDB is mongodb://root:secret@mongo-discord-cont:27017/
  • After that in root folder type in powershell: docker-compose -f docker-compose-dev.yml up
  • You will see the bot online in your server.
  • Verify that it works by trying the command /ping.
  • Happy coding!

👷 Manual

  • Clone the repo
  • Remove the .template from .env.template - If contributing, please revert this change!
  • Add required variables to .env
  • Run yarn install
  • Run node .

Contributions

While this bot is maintained by Kieran, contributors are welcome! See Contributing.md.

Invite

Invite Clarence to your discord server here with administrator and slash command permissions.

License

Clarence-Bot is licensed under the MIT License. The full license text is included in the LICENSE file in this repository. TLDR legal have a great summary of the license if you're interested.