Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/ericl521/ringvc
A discord bot that tries to replicate Group Chat behavior in server Voice Channels
https://github.com/ericl521/ringvc
Last synced: 21 days ago
JSON representation
A discord bot that tries to replicate Group Chat behavior in server Voice Channels
- Host: GitHub
- URL: https://github.com/ericl521/ringvc
- Owner: EricL521
- License: mit
- Created: 2021-10-14T23:35:25.000Z (about 3 years ago)
- Default Branch: main
- Last Pushed: 2024-11-27T03:52:55.000Z (about 2 months ago)
- Last Synced: 2024-11-27T04:25:39.487Z (about 2 months ago)
- Language: JavaScript
- Homepage: https://discord.com/api/oauth2/authorize?client_id=885686322973536267&permissions=2048&scope=bot
- Size: 174 KB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# 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](https://discord.com/oauth2/authorize?client_id=885686322973536267&permissions=2048&integration_type=0&scope=bot+applications.commands)
### 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
- Node.js and npm ([installation guide](https://docs.npmjs.com/downloading-and-installing-node-js-and-npm))
- Have a Discord bot created ([guide](https://discordjs.guide/preparations/setting-up-a-bot-application.html#creating-your-bot))
- Enable required permissions (for [auto mode](#mode))
- Under settings, on the left side, select Bot
- Scroll down to Privileged Gateway Intents
- Enable Presence Intent
### Installation & Usage
- Clone repository
```bash
git clone https://github.com/EricL521/RingVC.git
```
- Enter newly created folder
```bash
cd RingVC
```
- Install Node.js packages
```bash
npm install
```
- Create `config.json` in root directory with the following values:
```JSON
{
"token": "Your custom Discord bot token",
"saveCooldown": "How often new data should be saved, in seconds"
}
```
- Example (with an invalid token; you'll need your own):
```JSON
{
"token": "MTE4MjM0NTY3ODkwMTIzNDU2.Gh7Kj9.dQw4w9WgXcQ_WxYz1234567890AbCdEfGhIjKlM",
"saveCooldown": "60"
}
```
- Deploy slash commands
```bash
node deploy-commands.js
```
- Start bot
```bash
node index.js
```
- Invite bot to your server ([guide](https://discordjs.guide/preparations/adding-your-bot-to-servers.html#creating-and-using-your-invite-link))
- Select `bot`, `applications.commands` and `Send Messages` permissions