nodecg-discord-overlay

A Discord bot that monitors a voice channel and creates an overlay for your stream.

What is nodecg-discord-overlay?

nodecg-discord-overlay is a self-hosted Discord bot that monitors a voice channel of your choice and generates an overlay for your stream. It will show all users connected to the voice channel and will show when each user is speaking. You can specify whether you want the bot to hide users that are muted in the config. This is meant to accompany [DACBot](), which streams voice channel audio to a specified audio device.

Requirements

• NodeCG

Installation

In a Command Prompt window, navigate to your root NodeCG folder. Then execute the command nodecg install nicnacnic/nodecg-discord-overlay to install. Once completed, execute nodecg defaultconfig nodecg-discord-overlay to generate the config file.

Your config file is located in the cfg folder in your NodeCG installation. Open nodecg-discord-overlay.json, you'll see something like this.

{
    "botToken": "<bot_token>",
    "roleID": "<role_id>",
    "hideMutedUsers": true
}

• botToken: Put your bot token here. For more information see below.
• roleID: Put a role ID here. Users must have this role to operate the bot. Users with the Administrator or Manage Channels can always operate the bot regardless of their role.
• hideMutedUsers: If set to true, the bot will hide users on the overlay if they're muted.

Obtaining a Bot Token

Go to the Discord Developer Portal, and create a new application.

You can name your application whatever you want, here it doesn't matter. Once your application is created, click on Bot in the menu on the left-side, and click on Add Bot.

Here you can customize the username and avatar of your bot. The username/avatar can be seen by all users, so choose wisely. A creative username is recommended! Once done, copy the token, it will be used later. Do not share this token with anyone, otherwise they will be able to take full control of your bot.

Paste this bot token in the config next to botToken.

Back in the Discord Developer Portal, go back to the General Information page. Then copy your application ID, this is how you'll invite your bot.

To invite your bot, copy and paste the following URL in your browser. Replace <application_id> with your real application ID. https://discord.com/oauth2/authorize?scope=bot&permissions=0.&client_id=<application_id>

On the page, select your server, then click Authorize. You might need to sign into Discord if you aren't already.

Finally type nodecg start in your root NodeCG folder to start your bot.

You should see the bot become online on your server, and you're ready to type out some commands! It's a good idea to give the bot moderator permissions so it can see commands typed in hidden channels and connect to hidden voice channels.

Usage

Once the bot has started, enter a voice channel, then ping the bot with the connect command to have it join your VC and generate the overlay. To close the overlay, simply ping the bot again with the disconnect command and the bot will leave. Ping the bot with the help command for some help. Don't move the bot into another voice channel once connected, it might cause the overlay to glitch. Instead, disconnect the bot, move to the new voice channel, then connect the bot again.

Contributing

If you have any suggestions or bugfixes, please submit a pull request! Before you do, please make sure you test your code to make sure the bot works correctly with your new changes.

Special Thanks

Zoton2 and SovietPropaganda, for help and suggestions while coding the bot.

Patlabor and Titan63, for stopping their Valheim game to test the bot.

License

MIT License

Copyright (c) 2021 nicnacnic

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.