Config

Most of the config options are explained in their file. Please read those explanations there instead.
There are some useful methods you can use in the config files.

• Setting a message option to ~ or null will not send that message, if you set it to "" it'll still send an empty line.
• You can use \n line break to break lines for messages.
• All the Minecraft materials can be found here.
• All the Minecraft sounds can be found here. Minecraft volumes start from 0.0 to 1.0 Any number higher than that will just increase the radius the player can hear the sound from, normal is 1.0. Pitch starts from 0.5 to 2.0 normal is 1.0 You can also test this by using the /k admin testSound command.
• Surprisingly one thing that some people don't know, is that you can use Ctrl + F to search for something in a file. This is useful for searching for config options or language entries. If you didn't know this, Google Ctrl + Z and Ctrl + R as well.
• All the config options in the config that represent a time, support time suffixes. The default time suffix is seconds. Some time suffixes:
  • s, sec, secs, second, seconds
  • m, min, mins, minutes, minutes
  • h, hr, hrs, hour, hours
  • d, day, days
  • Example: time-limit: 10days

Math Equations

• All the math equations support all the math operators such as +, -, /, *, %, (), ^ etc...
• Placeholder support.
• You can test your math equations with the /k admin evaluate command.
• They support integers, decimals and hexadecimal.
• They also support all the Java Math functions (other than the functions with exact in their name which are useless anyway). Ignore the header description, just scroll down to read the method names. You'll see somethings like int, long, float and double next to the parameter names, they're all basically representing a number. int and long are numbers without decimals, float and double are number with and without decimals.
• Special Functions:
  • random(min, max) Get a random decimal number between the given minimum and the maximum numbers.
  • randint(min, max) Get a random integer number between the given minimum and the maximum numbers.
  • whatPercentOf(x, y) Finds X is What % of Y which is equivalent to (x / 100) * y
  • percentOf(x, y) Gets X percent of Y which is equivalent to (x / y) * 100
• They support Bitwise Operations too. This is a more simplified version specifically for Java. However, some of them use a different operator since the operator system in the math evaluator works per a character. They might conflict if used in conditional GUIs.
  • & Bitwise AND operator
  • | Bitwise OR operator
  • ! Bitwise XOR operator ^
  • ~ Bitwise Compliment Operator
  • > Bitwise Binary Right Shift Operator >>
  • < Bitwise Binary Left Shift Operator <<
  • $ Bitwise Shift Right Zero Fill Operator >>>

1.16 Hex Colors

You can use the new 1.16 custom hex colors. The format to do this is &#<hex> the <hex> is a hex 6-character code for RGB colors. You can pick one from here
Example: &2The &#6bffa5quick &#754646&lbrown &#c48d20&ofox &#549c1a&mjumped &#658b9e&nover &r&#531b52the &#62231alazy &#404040&kdog

Complex Messages (Hover Messages)

The feature that doesn't work on Bukkit servers (it works on Spigot, Paper and etc...)
To use a message as a complex message, add COMPLEX: at the beginning of that message.
Now you can use hover:{} anywhere in the message. The default format for hover is hover:{chat message; hover (lore) message; action} they all support color codes and placeholders inside.

• Chat Message: The message shown in the chat like the normal messages.
• Hover Message: The message shown when you hover on Chat Message in the chat using your cursor.
• Action: The action performed when you click on Chat Message in the chat.
  • Commands: Execute a command or send a message in chat. Not using a / slash will send a chat message instead.
  • Suggestions: Put a text in player's chat box. Instead of / you have to use |
  • URL: Open an URL in player's browser. Instead of / you have to use url:

Example: COMPLEX:&2Hey hello hover:{&cthis;&2Jeff;Hello Jeff!} &2is my name.\nCome hover:{&emeet;&2Click To Meet\nmaybe not.;/tp Jeff} &2me here. hover:{&lphone number;&2Click to copy;|911} &2my hover:{&9website;&cClick To Open;url:https://www.nasa.gov/}

You can test all the chat features using the /k admin test command.

Main

Plugin configuration files are split into separate files to organize options. The main config is config.yml for sure.
All the config files are automatically reloaded, please read here.
Config files are not translatable but the language file and all the GUIs are.
Config files don't automatically add new options for outdated configs, they use the default option if an option is missing.

Language File

The default language file is en.yml which is not saved in the plugin, it's generated automatically.
Language files automatically add new entries to their list, however they don't remove any old ones. If a translated language file is missing an entry, it'll copy one from the original (English) version into the file instead. Language entries don't have any explanation, they're mostly easy to understand. If you couldn't find the usage for an entry, you can always ask.

The language entry format for all the commands are commands -> [groups...] -> <name> where [groups...] are the main command names of that command and <name> is the main command name of that command. The group and names are explained in the permissions section.

All the language entries support:

• Chat Colors
• Line Breaks \n (It also keeps the color for the next line.)
• Complex Messages
• Internal & External Placeholders
• Complete Removal (by setting it to an empty text string '' or "")

All community translations are welcomed. You can also improve existing translations. You can translate the language file and all the GUIs located in the guis folder, but plugin configs are not translatable.
Here are some rules when translating the plugin. These rules apply to GUI translations as well.

• Obviously don't just drop them in Google Translate and paste them back to the file. Translate them manually.
• You shouldn't change how the sentences are phrased and add or remove a part of the description unless it makes it easier to understand in that particular language.
• You can change the colors, but do not use 1.16 hex color codes.
• You shouldn't change the plugin prefix. Anywhere that the name Kingdoms is used that is referring to the plugin and not the name itself, shouldn't be translated.
• Make sure to validate your files.
• You can change the GUI design as long as it has all the functional options used.
• You can give credits, but only at the beginning of the file. No IPs are allowed unless you have a domain that redirects to an appropriate website with SSL certificate (HTTPS).
• You can add explanations anywhere in the file if you want.

After translating your language file, place your translated file in the plugin's folder. The file's name should be the same as the option below without the .yml file extension. Some of these language files are outdated. Standard way of naming this is to follow IETF language tags from IETF use ISO-639-1 codes. If you can't find it, or don't feel like it, don't bother.
All the language files are made by the community, they're not guaranteed to be 100% accurate and complete. If you translated the plugin, you can contact me and I'll add it to the plugin.

GUIs

Each GUI uses an entire YAML file to parse its settings from the guis -> <lang> folder.
Unlike language files, they don't automatically add new options since their 100% customizable.
If your conditional GUI options are not changing that means your Java version is JRE instead of JDK.

Main Options

• title: The title of the GUI.
• rows: The rows of the GUI, it can be from 1 to 9
• type: If no rows is specified, a type will be used. You can see all the types here.
• sound: Sound when the GUI opens. Format is sound: <type>, [volume], [pitch]
• message: Message when the GUI opens.
• commands: Commands executed when the GUI opens.
• interactable: Interactable slots of this GUI. If it only contains one slot and that number is lower than zero, then the list will act as a blacklist.
• disallow-creative: true or false. Whether this GUI can be opened in creative mode or not.

Item Options

These options are used under the item names which are under options entry of GUIs. Option names are really important for some GUIs. They define what an option does from the code. If an option name doesn't have any actions attached to it, it'll not do anything when clicked on. This is where conditional GUIs come to use.
All the text options in items support color codes and placeholders.
Some people might find the following information hard to understand. If you have a quetion for any options below, ask me.

• name: The name of the item.
• lore: The lore of the item. You can use this differently. Either by using yaml lists or using strings and \n. You can also use \n if you're using a list.
• material: The material of the item.
• amount: The item amount.
• damage: The item's damage (durability).
• skull: The item's skull texture. This can be a player's name, UUID, a textures.minecraft.com link or a Base64. The recommended value is always Base64 as it doesn't require encoding and connections. A good website to get skull textures from that also supports Base64 is minecraft-heads.com. The value preference for this option from best to worst is as follows: base64 -> textures link -> UUID -> Name Note that you need to set the material to PLAYER_HEAD for this to work.
• unbreakable: true or false. Whether this item should have an unbreakable attribute.
• model-data: The 1.14 custom data models feature.
• enchants: Item's enchantments. It's a yaml entry with the entry keys as the enchantment name and the entry values as the enchantment level. Example:

enchants:
  ARROW_FIRE: 2
  DURABILITY: 3

• flags: The item flags. Item flags in Minecraft are badly named, so it might not do the exact thing you're looking for. In this case, you might want to try other flags. Example:

flags: [HIDE_ATTRIBUTES, HIDE_POTION_EFFECTS]

• attributes: Item attributes are the numbers shown in the bottom of the item's description under the item's lore. You can hide these with item flags but you can also change them with attributes.
  Format:

attributes:
  Attribute: https://hub.spigotmc.org/javadocs/spigot/org/bukkit/attribute/Attribute.html
    name: https://minecraft.gamepedia.com/Attribute
    amount: The modifier's number.
    operation: https://hub.spigotmc.org/javadocs/spigot/org/bukkit/attribute/AttributeModifier.Operation.html
    slot: HEAD - CHEST - LEGS - FEET` - HAND - OFF_HAND

• sound: The sound played when this item is clicked.
• commands: The commands executed when this item is clicked.
• message: The message sent to the player when this item is clicked.
• can-take: true or false. If this item can be taken out of the GUI by the player.
• slots/posx,posy/slot: The position(s) of the item. When using slot, you need to count the slots of the GUI from top to bottom and left to right and then subtract that number by one. When using posx and posy You just need to know the exact position in the GUI. When using slots it's the same as slot, but you can put the item in multiple slots with the same properties and actions. slots: [34, 35, 36, 37]
• patterns: Only works if the item is a banner. It's a section list with format: Pattern as the key and Dye Color as the value.
• color RGB color used for leather armor colors. Format: r, g, b
• spawner Entity type used for spawner blocks.
• projectiles A list of items for charged projectiles of a crossbow. The serialization for these items follow the same rules as these.
• effects The effects used for suspicious stew. A config list.
• color and pattern-color Dye Color used for tropical fish and pattern used for the pattern.
• power The power of a firework.
• firework
  • flicker true or false of the firework should have flicker.
  • trial true or false of the firework should have trial.
  • colors The RGB colors that this firework can have.
  • fade-colors The fading colors of this firework.
  • type The firework type.

Conditional

GUI items use a JavaScript engine to evaluate conditions. That's why the plugin needs JDK instead of JRE. You can change the entire item property by using condition option and putting each under a custom condition name. You can also use conditions for sounds, slots and messages. Example:

options:
  hello:
    activated:
      condition: "%kingdoms_members% > 10"
      name: "&2Activated"
      material: GREEN_WOOL
    else:
      # We use true here because if the previous condition wasn't met,
      # there is no need for us to use "%kingdoms_members% <= 10" here.
      condition: true
      name: "&4Disabled"
      material: RED_WOOL
      sound:
        "%kingdoms_members% <= 5": BLOCK_ANVIL_FALL
        "true": BLOCK_ANVIL_BREAK