https://github.com/randomairborne/ephemerole

Ephemeral role granting for Discord
https://github.com/randomairborne/ephemerole

Last synced: 20 days ago
JSON representation

Ephemeral role granting for Discord

• Host: GitHub
• URL: https://github.com/randomairborne/ephemerole
• Owner: randomairborne
• Created: 2024-05-30T21:42:04.000Z (6 months ago)
• Default Branch: main
• Last Pushed: 2024-10-15T17:10:43.000Z (about 1 month ago)
• Last Synced: 2024-10-16T23:49:43.039Z (about 1 month ago)
• Language: Rust
• Homepage:
• Size: 202 KB
• Stars: 1
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Funding: .github/FUNDING.yml

Awesome Lists containing this project

README

        
# Ephemerole

Ephemerole is a discord role-per-activity bot designed to be as simple and performant as possible.

## Why?

I have

a... [very](https://github.com/randomairborne/hypersonic) [bad](https://github.com/randomairborne/minixpd) [habit](https://github.com/randomairborne/tinylevel)

of writing discord bots in the hopes that they would be considered for use in the Minecraft discord. None of them ever

actually have been used, but I hold out hope. This bot stores ALL of its leveling data in memory, unless persistence is

explicitly enabled.

This is better than our current solution because (redacted, contact me over discord for a full explanation if you're a

mod or AM in the discord).

## Ok, how do I use it?

Ephemerole is a single docker container, published as `ghcr.io/randomairborne/ephemerole:latest`. It supports arm64 and

x86. It takes just three environment variables:

- `DISCORD_TOKEN`: The Discord app API key from the [developer dashboard](https://discord.com/developers/applications)

- `DISCORD_GUILD`: The ID of the guild you wish to use the bot in

- `DISCORD_ROLE`: The ID of the role you wish to grant after `MESSAGE_REQUIREMENT` is met.

Once you've set these up, probably using Docker Compose, start up the bot, and voilá! Users should be granted the role

automatically.

Do note that you will need to ensure the bot actually has permissions to add the `DISCORD_ROLE` it has been informed

about. Its highest role must be located above this role, and it must have the `MANAGE_ROLES` permission.

## Requirement configuration

If you want to have a little more control, you can also change the message cooldown with the below environment

variables.

- `MESSAGE_REQUIREMENT`: Message count before the user is granted the role. (default 60)

- `MESSAGE_COOLDOWN`: Amount of time, in seconds, required between messages for them to be counted. (default 60)