Skip to content

Configuration (Language)

StrangeOne101 edited this page Jun 12, 2022 · 1 revision

This is the configuration for all language and translatable stuff in BendingGUI. This can be found in the language.yml file.

Lots of these config values contain placeholders. These Placeholders can be found at the bottom of this page.

All lore values support the use of \n to add new lines, and use of color codes is welcomed.

Sections

The config is divided into different sections for simplicity

Chat

Contains all chat messages that will be sent to players

Chat:
  Edit:
    Remove:
      Self: '&eYour {elementcolor}{element}{bending}&e has been removed!'
      Admin: '&e{player} is no longer {a} {elementcolor}{element}{bender}&e!'
# ...and so on

Abilities

The descriptions of each ability used in BendingGUI. Combo abilities are additionally prefixed with Combo-, so combos that have the same name as abilities can still have different descriptions.

Abilities:
  Flight: Allows the user to fly freely in the sky
# ...and so on

You do not need to add new lines into these descriptions as they are trimmed automatically based on length. This length is configurable in config.yml

Display

This is the section for all translatable strings inside menus

  • Main: All things within the main bending menu, such as toggles, slots, abilities, etc
  • Choose: All things within the choose menu. Such as descriptions of elements, the name used to display each element, etc
  • Edit: All things within the edit element menu. Such as "You already have this element!" etc
  • Players: All things within the player overview menu
  • Presets: All things within the preset menu
  • Common: All things within elements used in multiple menus. This is mostly just pages for now.
  • Errors: All error messages sent to players when something goes really wrong
Display:
  Main: 
    Slot:
      Empty:
        Lore: '&7Nothing is currently bound to this slot!\n\n&7Click a move and click a slot to bind!'
        Title: '&cSlot {slot} &7(Empty)'
      Full:
        Lore: '&7Currently bound: {abilitycolor}{ability}\n\n&7To bind a new move, click a move then click\n&7the slot you want to bind it to.'
        Title: '{abilitycolor}Slot {slot} &7({abilitycolor}{ability}&7)'
# ...and so on

Item

Contains the name and lore of the item given to players to configure their bending. Supports color codes, and changing these will update all existing items in the world as well.

Item:
  Title: '&aConfigure Bending'
  Lore: '&7Right click to configure your bending!'

Staff

The localizations for ProjectKorra staff roles. These are shown on the overview icon or in the players menu when a developer is on the server.

Staff:
  Mist: '&4ProjectKorra Founder'
  Contributor: '&5ProjectKorra Contributor'
  Admin: '&4ProjectKorra Administrator'
  Developer: '&5ProjectKorra Developer'

Generic

This is a miscellaneous section containing things used to help make BendingGUI grammatically correct.

Generic:
  NoElementBending: ' element'
  List1: '{item}'
  List2: '{item} and {item}'
  List3: '{item}, {item} and {item}'
  List4: '{item}, {item}, {item} and {item}'
  An: an
  Their: their
  Yourself: yourself
  Your: your
  A: a
  They: they
  You: you

NoElementBending is what suffix to attach to elements that don't match grammatically in the form of "your firebending ...". E.g. Light Spirit. "your Light Spiritbending has been taken" is wrong, and so is "Light Spiritbender", so this defaults to " element" to change it to "your Light Spirit element has been taken"

The lists are used when listing things, such as subelements on the overview icon lore. "- Airbender (Can Fly and Spiritually Project)". If you have a lot of addon subelements and pass the limit of 4, just add another list element for however many you need.

Placeholders

These placeholders are replaced with the corresponding value when the string is used. See the table bellow

Placeholder Description Example
{element} The element currently being talked about Fire
{ELEMENT} The same as above, but in full caps FIRE
{elementcolor} The color of the current element §c
{bender} The "bender" suffix used for this element {element}{bender} as Fire -> Firebender
{element}{bender} as Chi -> Chiblocker
{bending} The "bending" suffix used for this element {element}{bending} as Fire -> Firebending
{element}{bending} as Chi -> Chiblocking
{bend} The "bend" suffix used for this element {element}{bend} as Fire -> Firebend
{element}{bend} as Chi -> Chiblock
{ability} The name of the ability FireJet
{abilitycolor} The color of the ability §c
{slot} The current slot number Slot {slot}: {abilitycolor}{ability} -> Slot 3: §cFireBlast
{current} The current page in the menu Page {current} of {max} -> Page 1 of 3
{max} The max amount of pages in the menu Page {current} of {max} -> Page 1 of 3
{preset} The name of a preset FirePvP
{presetcolor} The color of a preset §c
{slot[1-9]} The ability in the provided slot in the preset 1: {slot1} 2: {slot2} -> 1: Torrent 2: (Empty)
{time} The amount of time remaining for the change cooldown 14h 36m
{player} The name of the player StrangeOne101
{player|your} The name of the player OR "your" if the player viewing is the same player as the target {player|your} bending as you -> Your bending
{player|your} bending viewing someone else -> StrangeOne101's bending
{player|yourself} The name of the player OR "yourself" if the player viewing is the same player as the target You gave {player|yourself} fire as you -> You gave yourself fire
You gave {player|yourself} fire viewing someone else -> You gave StrangeOne101 fire
{player|you} The name of the player OR "you" if the player viewing is the same player as the target {player|you} can bend {element} as you -> You can bend Fire
{player|you} can bend {element} viewing someone else -> StrangeOne101 can bend Fire
{they|you} "They" OR "you" depending on the same conditions above {they|you} can bend {element} as you -> You can bend Fire
{they|you} can bend {element} viewing someone else -> They can bend Fire
{their|your} "They" OR "you" depending on the same conditions above {their|your} {element}{bending} as you -> Your Firebending
{their|your} {element}{bending} viewing someone else -> Their Firebending
{a} Makes "a" into "an" when the target word is a vowel {a} {element}{bender} as Fire -> A Firebender
{a} {element}{bender} as Air -> An Airbender
{s} Adds an "s" if the target word doesn't end in an "s" already {player}'{s} bending -> StrangeOne101's bending
{list} A list of objects, formatted based on Generic.List1, etc - {element}{bender} ({list}) -> - Airbender (Can Fly and Spiritually Project)
{version} The version of BendingGUI 1.4.5
{pkversion} The version of ProjectKorra recommended 1.9.3
Clone this wiki locally