https://github.com/ki-er/clarence-bot
A multipurpose discord bot with admin, fun and information commands
https://github.com/ki-er/clarence-bot
bot discord discord-bot discord-js hacktoberfest multipurpose multipurpose-discord-bot nodejs
Last synced: about 1 year ago
JSON representation
A multipurpose discord bot with admin, fun and information commands
- Host: GitHub
- URL: https://github.com/ki-er/clarence-bot
- Owner: Ki-er
- License: mit
- Created: 2021-10-11T07:21:46.000Z (over 4 years ago)
- Default Branch: master
- Last Pushed: 2025-01-28T14:51:33.000Z (over 1 year ago)
- Last Synced: 2025-03-29T01:52:37.886Z (about 1 year ago)
- Topics: bot, discord, discord-bot, discord-js, hacktoberfest, multipurpose, multipurpose-discord-bot, nodejs
- Language: JavaScript
- Homepage:
- Size: 38.3 MB
- Stars: 32
- Watchers: 1
- Forks: 16
- Open Issues: 16
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: .github/CONTRIBUTING.md
- License: LICENSE
- Code of conduct: .github/CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
## 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](.github/workflows/publish.yml) workflow, the newest build will automatically be pushed to DockerHub.
Using a tool like [Ouroboros](https://github.com/gmt2001/ouroboros), you can automatically update containers without the need for restarts.
```console
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](https://www.writebots.com/discord-bot-token/), after going through it you are expected to:
- Create a new application & make it a bot, from [here](https://discord.com/developers/applications/).
- 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](https://github.com/KieranRobson), contributors are welcome! See [Contributing.md](/.github/CONTRIBUTING.md).
## Invite
Invite Clarence to your discord server [here](https://discord.com/api/oauth2/authorize?client_id=875491402497294447&permissions=8&scope=bot%20applications.commands) with administrator and slash command permissions.
## License
Clarence-Bot is licensed under the MIT License. The full license text is included in the [LICENSE](LICENSE) file in this repository. TLDR legal have a [great summary](https://www.tldrlegal.com/l/mit) of the license if you're interested.