https://github.com/camalot/voicecreatebot

https://github.com/camalot/voicecreatebot

Last synced: 20 days ago
JSON representation

• Host: GitHub
• URL: https://github.com/camalot/voicecreatebot
• Owner: camalot
• Created: 2019-11-23T17:07:08.000Z (about 5 years ago)
• Default Branch: develop
• Last Pushed: 2024-08-22T14:42:42.000Z (4 months ago)
• Last Synced: 2024-08-22T16:39:07.348Z (4 months ago)
• Language: Python
• Size: 1.17 MB
• Stars: 5
• Watchers: 3
• Forks: 0
• Open Issues: 7
• Metadata Files:
  • Readme: README.md
  • Funding: .github/FUNDING.yml

Awesome Lists containing this project

README

        
# VoiceCreateBot

[![Docker Publish](https://github.com/camalot/voice-create-bot-docker/actions/workflows/publish-main.yml/badge.svg)](https://github.com/camalot/voice-create-bot-docker/actions/workflows/publish-main.yml) ![Docker Image Version (latest semver)](https://img.shields.io/docker/v/camalot/voice-create-bot-docker) ![](https://img.shields.io/docker/pulls/camalot/voice-create-bot-docker) 

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 | :heavy_check_mark: | |

| Different Permissions Per Create Channel | :heavy_check_mark: | |

| Random Channel Names | :heavy_check_mark: | | 

| Ability for user to change channel name | :heavy_check_mark: | |

| Stage Channels | :heavy_check_mark: | |

| Per-Server Language | :heavy_check_mark: | |

| Change command prefix per-server | :heavy_check_mark: | |

| Admin role to control bot | :heavy_check_mark: | |

| Admin commands | :heavy_check_mark: | |

| Set channel limits | :heavy_check_mark: | |

| Set channel bitrate | :heavy_check_mark: | |

| User specific settings | :heavy_check_mark: | | 

| Set channel name from game | :heavy_check_mark: | |

For help with the code, or the bot [join the discord](http://discord.darthminos.tv)

# 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

- Clone [camalot/voice-create-bot-docker](https://github.com/camalot/voice-create-bot-docker)

- Modify the docker-compose.yml

- run `docker-compose up`

### DOCKER

```shell

docker run --rm \

--restart=unless-stopped \

-e VCB_DISCORD_CLIENT_ID="" \

-e DISCORD_BOT_TOKEN="" \

-e BOT_OWNER="" \

-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=&permissions=8&scope=bot`

## CONTRIBUTORS

_Note:

This started out as a fork of the bot by [@SamSanai](https://github.com/SamSanai). It has sense been completely rewritten and is no longer anything that it once was._