Plugin that allows users to pick their favourite pronouns and use them with PlaceholderAPI in chats, lists, ...
Go to file
Beatrice DellacĂ  ee11359f96
All checks were successful
continuous-integration/drone/push Build is passing
Update README.md with useful info
2022-10-24 23:36:29 +02:00
src/main Remove "todos" as they have been moved to repo issues 2022-10-24 23:21:53 +02:00
.drone.yml Add DroneCI support 2022-10-21 12:48:18 +02:00
.gitignore Implement basic Spigot plugin structure 2022-10-21 12:57:41 +02:00
LICENSE Initial commit 2022-10-21 12:42:34 +02:00
pom.xml Update PlaceholderAPI version 2022-10-22 00:41:19 +02:00
README.md Update README.md with useful info 2022-10-24 23:36:29 +02:00

NounsPicker

This plugin allows users to pick their own preferred pronouns, that are then passed as PlaceholderAPI arguments to use wherever you want to. The pronouns are picked from a predefined list that only administrators can modify.

Basic info

Commands

  • /nouns create <pronoun> <format>: add a new pronoun to the database.
  • /nouns update <pronoun> <format>: change an existing pronoun's format.
  • /nouns delete <pronoun>: delete a pronoun, and remove it from all users.
  • /nouns set <main> <secondary>: choose your two most preferred pronouns.
  • /nouns list: list all available pronouns.

Permissions

  • nouns.base: the main permission for this plugin. Every user needs this, or they won't be able to use any command.

Base permissions

  • nouns.cmd.set: allow setting personal pronouns.
  • nouns.cmd.list: allow seeing the list of pronouns.

Administrative permissions

  • nouns.cmd.create: allow creating new pronouns.
  • nouns.cmd.delete: allow deleting existing pronouns, and removing them from all users.
  • nouns.cmd.update: allow changing an existing pronoun's format.

PlaceholderAPI tags

  • nouns_main_pronoun: the user's preferred main pronoun. Blank if unset.
  • nouns_secondary_pronouns: the user's preferred secondary pronoun. Blank if unset.
  • nouns_full_tag: a nicely formatted tag that shows both pronouns.

Note: "nouns" is the PAPI module name. The tags themselves are what follow the module name.

Guides

Adding new pronouns

After installing the plugin, the first thing you need to do is add new pronouns. Use /nouns create <pronoun> <format> to add a new pronoun to the database. <pronoun> is a simple, lowercase value that users will have to type when choosing it, while <format> is how it appears in chat, when formatted (colored, capitalized, ...).

Setting pronouns

After adding enough pronouns, you can pick your most preferred ones with /nouns set <main> <secondary>. You need to pick them from the ones you added previously with the create subcommand, and you can read a complete list using /nouns list.