Skip to content

Latest commit

 

History

History
90 lines (66 loc) · 3.56 KB

readme.md

File metadata and controls

90 lines (66 loc) · 3.56 KB

VoiceCreateBot

Docker Publish Docker Image Version (latest semver)

A dedicated bot for creating dynamic voice channels. Keep your voice channel count down. Allowing users to create their own channels without having to give them permissions to do so.

FEATURES

Multiple Create Channels ✔️
Different Permissions Per Create Channel ✔️
Random Channel Names ✔️
Ability for user to change channel name ✔️
Stage Channels ✔️
Per-Server Language ✔️
Change command prefix per-server ✔️
Admin role to control bot ✔️
Admin commands ✔️
Set channel limits ✔️
Set channel bitrate ✔️
User specific settings ✔️
Set channel name from game ✔️

For help with the code, or the bot join the discord

INSTALL

ENVIRONMENT VARIABLES

NAME DESCRIPTION REQUIRED DEFAULT
VCB_DB_PATH The path to the SQLITE database file false ./voice.db
VCB_MONGODB_URL MongoDB connection string false null
DISCORD_BOT_TOKEN The discord bot token true null
VCB_DISCORD_CLIENT_ID The app client id true null
BOT_OWNER The discord ID of the bot owner true null
LOG_LEVEL The minimum log level. [DEBUG|INFO|WARNING|ERROR|FATAL] false DEBUG
DB_PROVIDER The database provider to use [MONGODB|SQLITE] false MONGODB
LANGUAGE The default language of the bot to fall back to false en-us

DATABASE SUPPORT

MongoDB is the preferred database provider. SQLITE might not be fully compatible.

If using SQLITE provider, you will want to mount the /data volume, so the database file is persisted

HOW TO RUN THE BOT LOCALLY

  • clone the repo
  • Create a .env file in the root directory with the above environment variables
  • run pip install -r ./setup/requirements.txt
  • run python ./main.py
  • invite the bot to your discord (see below)

HOW TO RUN THE BOT VIA DOCKER

DOCKER COMPOSE

DOCKER

docker run --rm \
--restart=unless-stopped \
-e VCB_DISCORD_CLIENT_ID="<FILL IN YOUR DISCORD CLIENT ID>" \
-e DISCORD_BOT_TOKEN="<FILL IN YOUR DISCORD BOT TOKEN>" \
-e BOT_OWNER="<FILL IN YOUR DISCORD USER ID>" \
-e VCB_MONGODB_URL="mongodb://mdbroot:toorbdm@mongodb:27017/admin" \
-e LANGUAGE="en-us" \
-e LOG_LEVEL="INFO" \
-e DB_PROVIDER="MONGODB" \
camalot/voice-create-bot-docker:latest

INVITE TO DISCORD

https://discordapp.com/oauth2/authorize?client_id=<CLIENT_ID>&permissions=8&scope=bot

CONTRIBUTORS

Note: This started out as a fork of the bot by @SamSanai. It has sense been completely rewritten and is no longer anything that it once was.