PronounsMC
PronounsMC is a Minecraft Spigot plugin that allows players to set and display their pronouns. It supports multiple database types (
MySQL and
SQLite) and provides customizable messages via language files.
Notes
- PlaceholderAPI is required for placeholders.
- We reccomend using a plugin like ChatInjector for use with plugins that don't support PlaceholderAPI like EssentialsX Chat.
Features
- Players can set and display their pronouns using simple commands.
- Pronouns are color-coded and configurable via config.yml.
- Supports MySQL or SQLite for data storage.
- Fully customizable messages via language files (e.g., lang/en_US.yml).
- Reload settings and messages without restarting the server.
Installation
- Download the plugin jar file and place it in your server's plugins/ folder.
- Start your server to generate the default configuration files.
- Edit config.yml to configure:
- Database type: Choose between mysql or sqlite.
- Available pronouns: Customize the list of pronouns and their color-coded formats.
- Language file: Specify the language file (default: en_US).
- Restart your server or use /pronouns reload to apply changes.
Placeholders
%pronouns% - Displays users pronouns. Works with PAPI
Configuration
config.yml
Colour formatting can be used in pronouns as shown below, this is optional.
Code (YAML):
langFile
:
"en_US"
database:
type
: sqlite
# Use either 'mysql' or 'sqlite'
host
: localhost
port
: 3306
name
: minecraft
user
: root
password
: password
availablePronouns:
he/him
:
"&3(&bHe&3/&bHim&3)&r"
she/her
:
"&5(&dShe&5/&dHer&5)&r"
they/them
:
"&2(&aThey&2/&aThem&2)&r"
it/its
:
"&8(&7It&8/&7Its&8)&r"
he/they
:
"&3(&bHe&3/&bThey&3)&r"
she/they
:
"&4(&cShe&4/&cThey&4)&r"
xe/xem
:
"&8(&7Xe&8/&7Xem&8)&r"
ze/zir
:
"&8(&7Ze&8/&7Zir&8)&r"
lang/en_US.yml
All user-facing messages are customizable in the language file. Example:
Code (YAML):
messages:
usageMain
:
"&cUsage: /pronouns <command>"
usageGet
:
"&cUsage: /pronouns get <username>"
noPermission
:
"&cYou don't have permission for that."
playerNotFound
:
"&cPlayer not found!"
invalidPronoun
:
"&cInvalid pronoun. Use /pronouns list to see available options."
noPronounsConfigured
:
"&cNo pronouns configured."
pluginReloaded
:
"&aPronounsMC config reloaded."
pronounSet
:
"&aYour pronouns have been set to: &r{pronouns}"
availablePronounsHeader
:
"&aAvailable pronouns:"
playerPronounFormat
:
"&a{player}'s pronouns: &r{pronouns}"
onlyPlayers
:
"&cOnly players can set pronouns."
Commands
/pronouns <pronoun> - Sets your pronouns to the specified key.
/pronouns get <name> - Displays the pronouns of another player.
/pronouns list - Lists all available pronouns.
/pronouns reload - Reloads the configuration and language.
Permissions
pronouns.get - Allows retrieving another player's pronouns.
pronouns.reload - Allows reloading the configuration and language.
Database Support
MySQL
To use MySQL:
- Set database.type: mysql in config.yml.
- Configure host, port, name, user, and password.
SQLite
To use SQLite:
- Set database.type: sqlite in config.yml.
- The plugin will create a pronouns.db file in the plugin folder.
License
This project is licensed under the
Apache License 2.0.
Contribution
Contributions are welcome! To contribute:
- Fork the repository.
- Create a new feature branch.
- Submit a pull request explaining your changes.
Thanks for using PronounsMC