From ee11359f96d9e10d30ef376e4b53ad240e4bc69d Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Beatrice=20Dellac=C3=A0?= Date: Mon, 24 Oct 2022 23:36:29 +0200 Subject: [PATCH] Update README.md with useful info --- README.md | 40 ++++++++++++++++++++++++++++++++++++++++ 1 file changed, 40 insertions(+) diff --git a/README.md b/README.md index c0ab511..c270973 100644 --- a/README.md +++ b/README.md @@ -1,2 +1,42 @@ # 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 `: add a new pronoun to the database. +- `/nouns update `: change an existing pronoun's format. +- `/nouns delete `: delete a pronoun, and remove it from all users. +- `/nouns set
`: 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 ` +to add a new pronoun to the database. `` is a simple, lowercase value that users will have to type when +choosing it, while `` 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
`. 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`. \ No newline at end of file