Gaymer's Pronouns

#------------------------------------------------------------------#
#
#      Welcome to the GaymersPronouns configuration file.
#
#      Thank you for making your server more inclusive.
#
#------------------------------------------------------------------#
# I've tried my best to explain everything as you go, using these comments.
# (Can be used with PlaceholderAPI: %GaymersPronouns_pronouns% and others. Get more info with /gp papi.)

#
# Which language you want to use. Currently available: EN (english) or DA (danish)
# Keep in mind, you can also modify the messages.yml yourself.
# It may seem large, but only the top half is necessary. The bottom half is only visible to admins and the console (which you probably don't need since you can read this).
#
# Note: You may want to reset the pronouns.yml and messages.yml and generate new ones in the new language.
# This can be done by deleting or renaming the files and reloading the plugin or restarting the server.
# You can also reset them by changing languages in-game using /gp set language [locale].
#
locale: EN

#
# You can disable in-game configuration with the admin command by setting this to true.
# It's still possible to use to command to reload the plugin and assigning pronouns.
#
# All config changes are logged in the config.
#
# Note: Experimental Mode must be enabled for in-game configuration.
#
disable-in-game-configuration: false

#
# Whether you want to log pronoun changes in the console.
#
log-pronoun-changes: false

#
# These is the default pronoun set ID. You can see IDs in-game with "/gp pronouns" or in the pronouns.yml file.
# They will ONLY be used when absolutely needed, and when the player doesn't have pronouns set.
#
# By default (in English):
# They/They is 3
# She/Her is 2
# He/Him is 1
#
# Check pronouns.yml for more info.
#
default-pronouns: 3

#
# Whether placeholders should randomly pick which preferred pronoun set to use (true) or always use the top priority (false).
#
# Note: This can be mildly funky at times when using a pronoun and a verb at the same time. (e.g. %GaymersPronouns_Objective% %GaymersPronouns_verb%)
# I've done my best to make them match in most cases, but in rare cases with the right timing, they may not match. (e.g. "He are" instead of "He is")
#
random-priority-in-placeholders: false

#
# This is the inclusive maximum of pronouns a player can have when picking multiple. Set to 0 for no maximum (not recommended).
#
max-pronouns: 3

#
# Here, you can enable whether the pronoun selection menu should pop up immediately the first time someone joins the server.
#
prompt-on-first-join: false

#
# Whether you want to remind your players to pick their pronouns if they aren't set every time they log in. (Can be disabled in-game per player as well, this is just the default)
# True if you want reminders, false if you do not.
#
default-no-pronouns-reminder: true

#
# Whether you want to show the book with general info about pronouns in the pronoun menu for people who might not know.
#
show-tutorial-item: true

#
# Items shown in the menu
#
# Note: Further configuration can be done in messages.yml
#
gui:
  items:
    group1: NAME_TAG
    group2: RABBIT_FOOT
    selected: EMERALD_BLOCK
    reminder-enabled: LIME_DYE
    reminder-disabled: GRAY_DYE
    tutorial: BOOK
    glass-row:
      cancel: GRAY_STAINED_GLASS_PANE
      multiple-start: CYAN_STAINED_GLASS_PANE
      multiple-zero-selected: RED_STAINED_GLASS_PANE
      multiple-single-selected: YELLOW_STAINED_GLASS_PANE
      multiple-save: LIME_STAINED_GLASS_PANE

#
# This is where the pronouns will be displayed. Remove the hashtag in front of the ones you want.
# The format of how they're shown is edited further down, don't worry.
#
# Here's an explanation for them all:
# - chatformat: just shown in chat alongside someone's name, as a prefix, suffix, or whatever else.
# - chathover: shown when you hover over someone's name with your mouse after they send chat messages.
# - tablist: shows alongside someone's name as a prefix/suffix in the tab list.
#
# All of these require a restart to work.
#
display:
  #- chatformat
  #- chathover
  #- tablist

display-format:

  #
  # This is how chat messages will look ONLY if chatformat is enabled above.
  #
  # Good to know:
  # - Write "{PRONOUNS}" for it to be replaced with the player's pronouns.
  # - Write "{DISPLAYNAME}" for it to be replaced with the player's display name.
  # - Write "{USERNAME}" for it to be replaced with the player's username.
  # - Supports PlaceholderAPI.
  #
  # IMPORTANT:
  # - Write "{MESSAGE}" for it to be replaced with the message.
  #
  chat-format: "&7[{PRONOUNS}&7] &f<{DISPLAYNAME}&f> {MESSAGE}"

  #
  # This is how the little box will look when you hover over someone's name ONLY if chathover is enabled above.
  #
  # Good to know:
  # - Write "{PRONOUNS}" for it to be replaced with the player's pronouns.
  # - Write "{DISPLAYNAME}" for it to be replaced with the player's display name.
  # - Write "{USERNAME}" for it to be replaced with the player's username.
  # - Supports PlaceholderAPI.
  #
  # This is written as a list to make room for multiple lines.
  #
  chat-hover: ["&7This player's pronouns are &f{PRONOUNS}&7."]

  #
  # This is how someone's name will look in the tab list ONLY if tablist is enabled above.
  #
  # IMPORTANT:
  # - Write "{PRONOUNS}" for it to be replaced with the player's pronouns.
  # - Write "{DISPLAYNAME}" for it to be replaced with the player's display name.
  # - Write "{USERNAME}" for it to be replaced with the player's username.
  # - Supports PlaceholderAPI.
  #
  tab-list: "&7[{PRONOUNS}&7] &f{USERNAME}"

  #
  # Whether you want to update the tablist names every x seconds.
  # It will update on pronoun changes regardless. This is just for if you
  # use PlaceholderAPI and have placeholders that need updating. If you don't
  # have any placeholders, just leave this off and ignore it.
  #
  update-tablist-periodically: false
  tablist-update-delay: 60


#
# Whether you want to use pronoun-specific colors. When enabling, remember to edit your pronouns.yml to assign the colors as they are all white by default.
# Colors are assigned by setting 'color' to a color code, e.g. &f or &c. You can see the default pronoun (3 by default) as it's the only one with an assigned color out of the box.
#
use-individual-colors: false

#
# When using individual colors, what color should the slash separating the pronouns be? Ignored if use-individual-colors is false. Leave empty ("") to let
# the pronoun color itself continue into the separator.
#
# Note: This is not used when only one pronoun is selected (e.g. He/Him) but will only be used when combining multiple sets (e.g. He/They).
#
individual-separator-color: "&7"

#
# In case you want to use an SQL database. I won't provide much information for this one since if you want to use this, you probably know what you're doing.
#
# NOTICE: In order to accommodate any multi-language situations, the pronouns.yml remain local, so if you want identical pronouns everywhere, you must copy it for now.
# I will most likely allow for having the pronoun sets in the database, just not in this update. So, ignore the "local-pronouns" setting as it is completely unused as of
# right now but will likely be utilized in the future. It is only there so you don't have to update the config in the future.
#
# If you don't know what this is, just ignore all of this and keep "use" as "false".
#
database:
  use: false
  local-pronouns: false # Unused. Read above.
  url: "jdbc:mysql://localhost/DatabaseName"
  user: "root"
  password: ""

#
# Do NOT change this or you may lose your config.
#
version: 3

#
# Enable experimental features?
#
developer-mode: false

#
# This is what will be displayed when someone has not set their pronouns.
#
undefined-pronouns: "Not set"

# ---------------------------------------- #
#
# How do I add more pronouns?
#
# You can add more pronouns simply by doing some copy pasting or editing the existing ones.
#
# You can also easily make new ones in-game using the "/gp pronouns" command if you find this overwhelming.
#
#
#
# Here's the format:
#                               This is the pronoun ID. It's not visible to players in-game and is only used for saving purposes. This also
#                               means that if you were to edit or swap around these numbers below, that players with those pronouns would get
#  1:                       <-- different pronouns assigned to them, so don't do that. Note that the pronouns are shown in the order of
#                               their IDs from low to high. Positive numbers are shown on the left side of the pronoun picker, and negative
#                               numbers on the right side. Do not use 0 as it is reserved.
#
#   hidden: false           <-- Whether you want to hide it from the picker menu for some reason. It can still be manually assigned by admins.
#
#   color: "&f"             <-- The color used when "use-individual-colors" is true in the config. Defaults to "&f" or the one you set for your
#                               default pronoun (3 by default) if not set. Remember to use quotes to avoid issues.
#
#   display: "They/Them"    <-- This is how it's displayed when it's the only picked pronouns of a player. This is the only required attribute.
#
#   dominant: "They"        <-- This is the dominant pronoun used when it's in a set of multiple pronouns (e.g. She/They). If not specified, the first
#                               part of the display attribute will be used (in this case, "They", which would make this redundant, hence its rare use).
#
#   subjective: "They"      <-- The subjective pronoun. (e.g. He, She, They)
#   objective: "Them"       <-- The objective pronoun. (e.g. Him, Her, Them)
#   possessive: "Their"     <-- The possessive pronoun. (e.g. His, Her, Their)
#   reflexive: "Themselves" <-- The reflexive pronoun. (e.g. Himself, Herself, Themselves)
#
#   verb: "Are"             <-- The verb associated with the pronoun (e.g. "Is", "Are" to be used in placeholders like "He *is*", "They *are*").
#
#
#
#   This seems like a lot. But if you don't use PlaceholderAPI (which most probably don't), you only really need the ID and the display.
#   In some cases the 'dominant' is also useful when the first pronoun in the x/y format isn't the one you want displayed when multiple sets are shown together.
#   Hiding pronouns may be useful if a set of pronouns is being abused somehow (can still be assigned with /gp assign).
#
# ---------------------------------------- #

pronouns:

  #
  # Negative numbers will be shown separately from 1 and above (on the right side of the menu).
  #
  -1:
    display: "Any"
  -2:
    display: "Ask"
  -3:
    display: "None"
    subjective: "This player"
    objective: "That player"
    possessive: "This player's"
    reflexive: "The player"
    verb: "Is"
    hidden: true

  #
  #  These will be shown on the left side of the menu.
  #
  1:
    display: "He/Him"
    subjective: "He"
    objective: "Him"
    possessive: "His"
    reflexive: "Himself"
    verb: "Is"
  2:
    display: "She/Her"
    subjective: "She"
    objective: "Her"
    possessive: "Her"
    reflexive: "Herself"
    verb: "Is"
  3:
    color: "&f"
    display: "They/Them"
    subjective: "They"
    objective: "Them"
    possessive: "Their"
    reflexive: "Themselves"
    verb: "Are"
  4:
    display: "It/Its"
    subjective: "It"
    objective: "It"
    possessive: "Its"
    reflexive: "Itself"
    verb: "Is"

  # There's not any deep reason for skipping 5 here. It's just because some languages have more pronouns so you can change between them without messing up your players' saved pronouns or having a weird order of displaying them in.

  6:
    display: "Xe/Xem"
    subjective: "Xe"
    objective: "Xem"
    possessive: "Xyr"
    reflexive: "Xemself"
    verb: "Is"
  7:
    display: "Ze/Zir"
    subjective: "Ze"
    objective: "Zir"
    possessive: "Zirs"
    reflexive: "Zirself"
    verb: "Is"
  8:
    display: "Ey/Em"
    subjective: "Ey"
    objective: "Em"
    possessive: "Eirs"
    reflexive: "Emself"
    verb: "Is"