Skip to content

Latest commit

 

History

History
80 lines (68 loc) · 2.26 KB

File metadata and controls

80 lines (68 loc) · 2.26 KB

RingVC

A discord bot that tries to replicate Group Chat behavior in server Voice Channels

  • Servers can't ring people, like in Group Chats, so bot just pings people in the Voice Channel Text Chats instead

Usage

To add the bot to your server, click here

Commands

  • /help
    • A quick description of all the commands
  • /signup
    • signs you up for a voice channel, so once someone "starts" a call there (joins it when it's empty), you get pinged
  • /unsignup
    • un-signs you up for a voice channel, so you no longer get pinged
  • /ring
    • pings someone to join the voice channel you're currently in
  • /block
    • blocks someone, which prevents them from ringing you and makes it so you don't get pinged if they start a call
  • /unblock
    • unblocks someone
  • /mode
    • allows you to switch between auto, normal, and stealth modes
      • stealth means that you don't ping anyone when "starting" a call

Self-Hosting

Guide on hosting the bot yourself

Prerequisites

  • Docker Compose (installation guide)
  • Have a Discord bot created (guide)
  • Enable required permissions (for auto mode)
    • Under settings, on the left side, select Bot
    • Scroll down to Privileged Gateway Intents
    • Enable Presence Intent

Installation & Usage

  • Clone repository

    git clone https://github.com/altrup/RingVC.git
  • Enter newly created folder

    cd RingVC
  • Copy .env.example to .env in root directory and replace the values

    cp .env.example .env
  • Start bot in Docker

    docker compose up -d
  • Invite bot to your server (guide)

    • Select bot, applications.commands and Send Messages permissions
  • To stop, run

    docker compose down
  • To update, run

    docker compose build

Development

  • For development, it may be easier to use npm directly instead of docker

  • To deploy commands, run

    npm run deploy-commands
  • To start bot with hot reloading, run

    npm run dev