Yapper

A Discord bot that notifies when your friends join a voice channel.

Inspired by this post: https://blog.danpetrolito.xyz/i-built-something-that-changed-my-friend-gro-social-fabric/

System requirements

The application can be run via either Docker compose or podman-compose.

Docker compose

• docker >=28.1.1

podman-compose

• podman>=4.3.1
• podman-composer>=1.0.3

Prerequisites

Creating a Discord bot

Follow this guide to create a Discord bot account and invite it to your server.

• The bot needs "Send Messages" and "Use Voice Activity" permissions on the invite to your server.
• Make sure you copy the "Token" (also called "Client Secret") after creating the bot account. Treat this as if it were a password, so do not share it with anyone.

Installing

1. Download the latest release (yapper-X.Y.Z.tar.gz or yapper-X.Y.Z.zip) from github.com/randyprice/yapper/releases.
2. Extract the archive.

   # The tarball:
   tar -xzf yapper-X.Y.Z.tar.gz
   
   # The zip file:
   unzip yapper-X.Y.Z.tar.gz
   

   The archive contains a single directory: yapper-X.Y.Z.
3. cd to the yapper-X.Y.Z directory you just extracted from the archive:

   cd yapper-X.Y.Z
   

Configuration

1. Copy your Discord bot's authentication token from Creating a Discord bot and paste it into secrets/discord-authentication-token
2. Populate secrets/channel-to-notify with the name of the channel in your discord server that you want the bot to message.

Run

In the yapper-X.Y.Z directory, start the application with either Docker compose or podman-compose:

# Docker
docker compose up

# podman
podman-compose up