Categorygithub.com/zaptross/reactroles
module
1.0.0
Repository: https://github.com/zaptross/reactroles.git
Documentation: pkg.go.dev

# README

React Roles

React Roles is a simple discord bot for allowing self-managing user roles in discord.

Role message with roles

Usage

To add a role to yourself as a user you simply click one of the reactions on the message, and to remove yourself from that role you click again to remove your reaction on the message.

If a user has the roles (as configured below) that gives the permission to use role management commands:

  • !role <add/remove> <role name> <emoji> [colour]

Usage examples:

  • !role add valorant :gun: #d34454
  • !role add valorant :gun:
  • !role remove valorant

When a command is successful, the bot will remove the your message containing the command and update the roles selector accordingly.

If unsuccessful, the bot will reply with an error message and usage then delete your message containing the command.

Setup

Before deploying your own, you will need to make a discord bot, and add it to your server.

Docker

  1. Clone the repo to your machine
  2. Duplicate ./example.env and rename it to .env
  3. Fill out the env variables
  4. In a terminal in the repo root, run docker-compose up -d

Kubernetes

  1. Clone the repo to your machine
  2. Duplicate ./cmd/reactroles/kube/deployment.yaml and rename it to deployment.prod.yaml
  3. Fill out the data variables in the config map
  4. In a terminal in the repo root, run kubectl apply -f ./cmd/reactroles/kube/deployment.prod.yaml

# Packages

No description provided by the author