Skip to content

feylinara/PronounBot

Repository files navigation

PronounBot

Since Discord doesn't have an easy way for users to show their pronouns, many servers use pronoun roles so that their users aren't misgendered. Unfortunately creating roles for any pronoun a user might have can be time-consuming, and only creating them when needed means the users have to ask the server moderators for pronouns. PronounBot aims to automate this while still preventing users from giving themselves anything as a role.

Features

  • Add and remove approved pronouns
  • Create pronoun roles as needed
  • Add pronouns in different languages

Usage

User Options

  • Add a pronoun role to your roles. Use as ^pronouns add <pronoun> [language:<language>], for example ^pronouns add or pronouns add hen language:German
  • Delete a pronoun role from your roles. Use as ^pronouns delete <pronoun> [language:<language>], for example ^pronouns delete vi/ver or pronoun delete x language:German
  • List the pronouns we know for a language. Use as ^pronouns list [language:<language>], for example ^pronouns list language:Dutch
  • List what languages we know how many pronouns for. Use as ^pronouns languages
  • Show a help screen. Use as ^pronouns help

Config Options

Options to configure how PronounBot acts in your server. Can only be used by users with Manage Server permissions

  • Set a server prefix. Use as ^pronouns prefix <prefix>, for example ^pronouns prefix !
  • Set the server's primary language. Use as ^pronouns language <language>, for example ^pronouns language German

Setting Up

Prerequisites

PronounBot needs a version of nodejs that supports async/await and postgresql. You'll also need a discord API key which you can get from here

Installation

  1. Clone this repository
  2. Run ./scripts/set-up.js and insert the postgres access data and the discord secret key when prompted
  3. Run npm start postgrator -- -u <postgre username> -d <postgre database> -p <postgre password>
  4. Launch PronounBot with npm start

About

A bot to handle discord pronoun roles

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published