OpenRP Descriptions Configuration

# OpenRP Descriptions.
# Made by Darwin Jonathan, 2020.

# Placeholder list:
# &(any color code) - 0-9, a-f.
# {player$user} - Username of a player. e.g. untoldpotential.
# {player$displayName} - Display name of a player. e.g. [prefix]~Darwin[suffix]

# You can use the following in any PlaceholderAPI-supporting plugin: %orpdesc_(value)%
# You may also take any PlaceholderAPI value & use it here.

# Every field you add must be under "fields".
fields:
  # I have made two very useful examples. You can add as may as you want.
  charname:

    # command: How a player can change this variable. In this example: /char name set (x)
    # If the command repeats in multiple places, the first field found is taken.
    command:
    - name

    # changeable: Set this to true if you want to prohibit the player from changing this field via a command.
    # Set to false or remove completely to ignore.
    unchangeable: false

    # allowed: set up what you can type in this field.
    allowed:
       # type: if 0 or less, it will only allow the values IN your list. e.g. for letters only: "abcdefghijklmnopqrstuvwxyz"
       # if type is 1, it will disable ONLY the values in your list. e.g. to disable numbers: "0123456789"
       # if type is 2 or higher, it will allow only specific strings in the list, e.g. ["Male", "Female"]
       type: 0
       # caps: if your list contains "a", should it also check for A? If yes, set to 'ignore'.
       # if you want the caps to be case-sensitive,
       caps: false
       # values: the values you want to check. Simply remove if you do not want any.
       values: 'abcdefghijklmnopqrstuvwxyz''".,'

    # default-value: If a player hasn't set this value yet, what should it be replaced with?
    # If you set MORE than one value in the list, then it'll pick a random one.
    default-value:
    - '<Unknown>'

    # prohibit-spaces: Set to true if you want the input to be a one-liner.
    # Set to false or remove completely to ignore.
    prohibit-spaces: false

    # min-length: How long, in characters, can a player's input be. In this example: 3.
    # Set to a number smaller than 0 or remove entirely to have no minimum limit.
    min-length: 3

    # max-length: How long, in characters, can a player's input be. In this example: 16.
    # Set to a number smaller than 0 or remove entirely to have no maximum limit.
    max-length: 16

    # length-checks-for-color-codes: Set to true if you want to make max-length to take color codes as characters.
    # Set to false or remove entirely to ignore.
    length-checks-for-color-codes: false

    # color-code-perm: The permission needed for a player to use color codes in this field.
    color-code-perm: 'orpdesc.color.charname'

    # randomizer: If the value stored happens to be a number, if this is enabled, it will add/subtract this value from it.
    # Each player has their own random value.
    # Set to null, 0, or remove entirely to ignore.
    randomizer: 0

    # ignore-randomizer-perm: If the player has this permission set, the randomizer number is ignored.
    # This is very useful if you want it to be ignored for a player that has some special role.
    ignore-randomizer-perm: 'orpdesc.ignorerand.charname'

    # set-delay-in-seconds: how often is a player allowed to set this value.
    # Set to 0 or lower, or remove entirely to ignore.
    set-delay-in-seconds: 10

    # set-bypass-perm: a permission to bypass the set cooldown.
    # This might be useful for a donator rank.
    set-delay-bypass-perm: 'orpdesc.set.bypass.charname'

  chardesc:
    command:
    - desc
    - description
    allowed:
      type: 1
      caps: false
    default-value:
    - 'No description set.'
    color-code-perm: 'orpdesc.color.chardesc'
    set-delay-in-seconds: 10
    set-delay-bypass-perm: 'orpdesc.set.bypass.chardesc'

  chargender:
    command:
    - gender
    allowed:
      type: 2
      caps: false
      values:
      - "Male"
      - "Female"
    default-value:
    - "Other"
    color-code-perm: 'orpdesc.color.chargender'
    set-delay-in-seconds: 10
    set-delay-bypass-perm: 'orpdesc.set.bypass.charname'

  charage:
     command:
     - age
     allowed:
       type: 1
       caps: false
       values: '0123456789'
     min-length: 2
     max-length: 2
     prohibit-spaces: true
     default-value:
     - "20"
     color-code-perm: 'orpdesc.color.charage'
     set-delay-in-seconds: 900
     set-delay-bypass-perm: 'orpdesc.set.bypass.charage'



# Set this to true, if you want players to be right-clickable to see their character card.
is-player-info-viewable: true

# Set this to true, if you want player to have to CROUCH while right-clicking to view the card.
can-view-only-if-crouching: true

# This will let you do /char (field) override (user), and forcefully set the field to anything, regardless of settings.
perm-to-override-values: 'orpdesc.override'

# This will let you /char card (user), to forcefully display the character card of a player.
perm-to-view-card-with-command: 'orpdesc.cardadmin'

# This will delay how often you can right-click a player to view their card.
character-card-delay-in-seconds: 3

# This is what is shown to a player if you right-click on them.
on-right-click:
- '&bPlayer Name: &e{player$user}'
- '&aCharacter Name: &7%orpdesc_charname%'
- '&aCharacter Gender: &7%orpdesc_chargender%'
- '&aCharacter Age: &7%orpdesc_charage%'
- '&aCharacter Description:'
- '&f&o%orpdesc_chardesc%'