PronounsMC

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

1. Download the plugin jar file and place it in your server's plugins/ folder.
2. Start your server to generate the default configuration files.
3. 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).
4. Restart your server or use /pronouns reload to apply changes. (Does not work for database changes)

---

Placeholders

Placeholder	Description
%pronouns_user%	Displays users pronouns. Works with PlaceholderAPI

---

Configuration

config.yml

Colour formatting can be used in pronouns as shown below, this is optional.

langFile: "en_US"

database:
   type: sqlite # Use either 'mysql' or 'sqlite'
   host: localhost
   port: 3306
   name: minecraft
   user: root
   password: "password"

userSuppliedPronouns: false # This setting can be abused by players.
defaultProunounTemplate: "&7(%s)&r"

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:

messages:
   usageMain: "&cUsage: /pronouns <command>"
   usageSet: "&cUsage: /pronouns set <pronoun>"
   usageGet: "&cUsage: /pronouns get <username>"
   noPermission: "&cYou don't have permission to use this command."
   playerNotFound: "&cPlayer not found!"
   invalidPronoun: "&cInvalid pronoun. Use /pronouns list to see available options."
   notSet: "&7Not set"
   pluginReloaded: "&aPronounsMC config reloaded."
   pronounSet: "&aYour pronouns have been set to: &r{pronouns}"
   availablePronounsHeader: "&aAvailable pronouns:"
   playerPronounFormat: "&a{player}'s pronouns: &r{pronouns}"
   playerPronounNone: "&a{player}'s pronouns: &bNot set" # Used for /pronouns get <username>
   onlyPlayers: "&cOnly players can set pronouns."
   availablePronounsFooter: "&9You can also set your own pronouns using /pronouns set <pronoun>"
   pronounResetTarget: "&aReset pronouns for {player}."

---

Commands

Command	Description	Permission
/pronouns set <pronoun>	Sets your pronouns to the specified pronoun.	None
/pronouns reset	Resets previously set pronouns by user	None
/pronouns reset <user>	Resets other users pronouns	pronouns.admin
/pronouns get <user>	Displays the pronouns of another player.	pronouns.get
/pronouns list	Lists all available pronouns.	None
/pronouns reload	Reloads the configuration and language.	pronouns.reload

---

Permissions

Permission	Description	Default
pronouns.get	Allows retrieving another player's pronouns.	OP
pronouns.reload	Allows reloading the configuration and language.	OP
pronouns.admin	Allows resetting other users pronouns.	OP

---

Database Support

MySQL

To use MySQL:

1. Set database.type: mysql in config.yml.
2. Configure host, port, name, user, and password.

SQLite

To use SQLite:

1. Set database.type: sqlite in config.yml.
2. 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:

1. Fork the repository.
2. Create a new feature branch.
3. Submit a pull request explaining your changes.

---

Thanks for using PronounsMC