Install Automatically

Download the version of the bot and dashboard for your architecture (either ARM64 or x86_64) from the GitHub releases.

 

Creating a Discord Bot

• Go to Discord Developer Portal.

• Create a new application and set up your bot.

Set up environment variables

• Create a .env file in the project root:

.env

BOT_TOKEN=GET_FROM_DISCORD_DEVELOPER_PORTAL
SECRET_KEY=REPLACE_WITH_A_RANDOM_STRING
HEAD_BOT_ADMIN_USERNAME=Admin
HEAD_ADMIN_PASSWORD=CHOOSE_A_VERY_STRONG_PASSWORD
FRONTEND_URL=http://localhost:5000
API_URL=http://localhost:5003
DISCORD_CLIENT_ID=GET_FROM_DISCORD_DEVELOPER_PORTAL
DISCORD_CLIENT_SECRET=GET_FROM_DISCORD_DEVELOPER_PORTAL
DATABASE_PATH=bot/bot.db
ENABLE_LEVELING=true
ENABLE_MODERATION=true
ENABLE_APPEALS=true
TWITCH_CLIENT_ID=GET_FROM_TWITCH_DEVELOPER_CONSOLE
TWITCH_CLIENT_SECRET=GET_FROM_TWITCH_DEVELOPER_CONSOLE
YOUTUBE_API_KEY=GET_FROM_GOOGLE_CLOUD_CONSOLE

Replace all placeholder values (like GET_FROM_DISCORD_DEVELOPER_PORTAL) with the actual values from your Discord Developer Portal.

⚠️ Never share your .env file publicly — it contains sensitive secrets!

Running the Bot and Dashboard

• Double click the dmg

Once running, access the dashboard:

• Local access: http://localhost:5000

• Remote access: http://OtherPCsIPAddress:5000

Note: You will need to keep the app running in order to keep the Dashboard and bot up.