OnigiriBot - A Lightweight, Simple, Versatile Discord Bot

Overview • Installation

Overview

OnigiriBot is a simple and lightweight Discord bot that can moderate your Discord server, play music, and more.

Installation

To install OnigiriBot, you must have Docker installed on your machine.

Step 1: Registering the bot on Discord and retrieving bot's token

1. Create Your Bot:

   • Go to the Discord Developer Portal and login with your Discord account.
   • Click on “New Application”, give it a name (like OnigiriBot), and create your application. (If you don't have a profile picture to use, feel free to download the one at the top of this document)

2. Get Your Bot Token and Application ID:

   • Under the "General Information" section, you'll find your application ID. Copy and save it somewhere.
   • Under the “Bot” section, you’ll find your bot’s token. Copy and save this token somewhere safe, as you'll need it for your bot's configuration. Note that anyone in possess of this token can run whatever code they want using your bot tied to your Discord account.

3. Enable Bot's Privileged Gateway Intents:

   • Under the "Bot" section, enable all privileged gateway intents, as OnigiriBot requires them to run properly.

Step 2: cloning the repository and configuration

Clone the OnigiriBot repository through this command:

git clone https://github.com/zeke-code/OnigiriBot.git

Create a .env file and place it in the root folder. Open the .env file with any kind of text editor and add the following lines to it, replacing YOUR_BOT_TOKEN, YOUR_APPLICATION_ID with the token and application ID you obtained from the Discord Developer Portal.

You should also replace values like YOUR_POSTGRES_USER with the configuration of your DB and any other service (such as Lavalink). Configuration of the other services can be customized through the docker-compose.yml file. Your .env file should be similar to this:

DISCORD_TOKEN=<YOUR_BOT_TOKEN>
APPLICATION_ID=<YOUR_APPLICATION_ID>

# Postgres Configuration
POSTGRES_USER=<YOUR_POSTGRES_USER>
POSTGRES_PASSWORD=<YOUR_POSTGRES_PASSWORD>
POSTGRES_DB=<YOUR_DB_NAME>
DATABASE_URL="postgresql://${POSTGRES_USER}:${POSTGRES_PASSWORD}@postgres:5432/${POSTGRES_DB}?schema=public"


# Lavalink Config
LAVALINK_HOST=lavalink
LAVALINK_PORT=2333
LAVALINK_PASSWORD=<YOUR_LAVALINK_PASSWORD>
# Additional Lavalink config to add if you want Spotify URLs to work.
SPOTIFY_CLIENT_ID=<YOUR_SPOTIFY_CLIENT_ID>
SPOTIFY_CLIENT_SECRET=<YOUR_SPOTIFY_CLIENT_SECRET>

Save the file.

Step 3: startup

Ensure the Docker daemon is up and running. On the terminal, while inside OnigiriBot's folder, type:

docker compose up

This will startup OnigiriBot. If configuration was successful, you'll see a message similiar to the following:

info: Started refreshing 15 application (/) commands. {"service":"OnigiriBot","timestamp":"2024-09-12 00:00:00"}
info: Successfully reloaded 15 application (/) commands. {"service":"OnigiriBot","timestamp":"2024-09-12 00:00:03"}
Ready! Logged in as OnigiriBot#3212

Now, to add OnigiriBot to your private Discord server, follow "Adding OnigiriBot to your server" section of this document.

Adding OnigiriBot to Your Server

To add OnigiriBot to your server, create an invite link:

• Go back to the Discord Developer Portal, navigate to the “OAuth2” tab.
• Under “Scopes”, select “bot”.
• Under “Bot Permissions”, select the permissions you want to give the bot (keep in mind that the bot might require permissions based on what you want it to do. I suggest starting out with it being able to read and write messages, join voice channels and speak to let the music service do its thing.)
• Use the generated URL to invite OnigiriBot to your server by accessing the URL on your browser.

Notes

If you encounter any issues, feel free to open an issue on the GitHub repository.

Disclaimer: The developer of this bot assumes no responsibility or liability for any actions taken by users of this bot. This bot is intended solely for instructive and demonstrative purposes. Users are responsible for ensuring that their use complies with all applicable laws and regulations.