https://github.com/omgrod/omega-bot
A Discord bot to manage everything at once
https://github.com/omgrod/omega-bot
Last synced: about 1 year ago
JSON representation
A Discord bot to manage everything at once
- Host: GitHub
- URL: https://github.com/omgrod/omega-bot
- Owner: OmgRod
- License: gpl-2.0
- Created: 2025-02-11T21:58:40.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2025-05-09T06:40:12.000Z (about 1 year ago)
- Last Synced: 2025-05-09T07:41:45.046Z (about 1 year ago)
- Language: TypeScript
- Homepage:
- Size: 167 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
# 📖 Introduction
Omega Bot is a Discord bot that helps manage everyday tasks!
# Getting Started
## Environment Variables
1. Create a copy of `example.env` and rename it to `.env`
2. Go to the [Discord Developer Portal](https://discord.com/developers) and create a bot if you haven't yet
3. Set `BOT_TOKEN` and `CLIENT_ID` to their corresponding values.
4. For the `DB_USER`, `DB_PASSWORD`, `DB_NAME` and, `DB_HOST` values, feel free to select any values (`DB_PORT` must be `5432` but you can change it if you change the ports in [`docker-compose.yml`](https://github.com/OmgRod/omega-bot/blob/main/docker-compose.yml))
5. If you don't want Ollama (chatbot) in your bot, set `OLLAMA_ENABLED` to `0`
## Bot Permissions
1. In the [Discord Developer Portal](https://discord.com/developers), enable all `Privileged Gateway Intents` in the Bot tab.
2. When inviting the bot to servers, ensure the following OAuth2 scopes are enabled:
- `bot`
- `applications.commands`
And the following bot permissions are enabled:
- `Kick Members`
- `Ban Members`
- `Send Messages`
- `Send Messages in Threads`
- `Manage Messages`
- `Embed Links`
- `Attach Files`
- `Read Message History`
- `Use External Emojis`
- `Use External Stickers`
- `Add Reactions`
- `Use Slash Commands`
# 🏗 Development
```
npm install
npm run dev
```
If you want to use [Nodemon](https://nodemon.io/) to auto-reload while in development:
```
npm run watch
```
# 💻 Production
```
npm install --production
npm run build
npm run start
```
# 🐋 Docker
To start your application:
```
docker-compose up -d
```
To shut down your application:
```
docker-compose down
```
To view your application's logs:
```
docker-compose logs
```
For the full command list please view the [Docker Documentation](https://docs.docker.com/engine/reference/commandline/cli/).