A more enjoyable en.yml.

Author: flurbudurbur

src/main/resources/locale/en.yml

@@ -1,38 +1,49 @@
-# the messages in this section can be customised for each rankup in rankups.yml.
+# The messages in this section can be customised for each rankup in rankups.yml.
 rankup:
   requirements-not-met: "&cYou need {{rank.requirement('money').total | money}} money to rankup."
-  no-rankup: "&eYou are at the highest rank."
-  # set to an empty string, ie: success-public: ""
+
+  # Set to an empty string, ie: success-public: ""
   # to hide that message.
   success-public: "&a{{player}} &ehas ranked up to: &d{{next.rank}}"
   success-private: "&aYou have ranked up to: &d{{next.rank}}"
+
+  must-prestige: "&cYou must prestige to /rankup further!"
+  no-rankup: "&eYou are at the highest rank."
+
   # used for the text confirmation
   confirmation: |-
     &eAre you sure you want to rankup to &a{{next.rank}}&e?
     &eType &c/rankup &eagain to confirm.
-  must-prestige: "&cYou must prestige to /rankup further!"
 
   gui:
     rows: 1
     title: "Rankup to {{next.rank}}"
     rankup:
-      material: EMERALD_BLOCK
-      # index can be separated by spaces to show in multiple groups
-      # for example: 0-3 9-12 18-21
-      # you can also just use a single number instead of a range.
+
+      # ===[ IMPORTANT PRE-FLATTENING INFO ]===
+      # If you are using a 1.8-1.12 and you want to change this
+      # you can use MATERIAL:data, for example STAINED_GLASS_PANE:8
+      # this works for both the rankup, cancel and fill blocks as well.
+
+      material: GREEN_STAINED_GLASS_PANE
+
+      # Index can be separated by spaces to show in multiple groups.
+      # -> For example: 0-3 9-12 18-21
+      #    But the "rows" must have enough space.
+      # You can also just use a single number instead of a range.
+
       index: 0-3
-      name: '&a&lConfirm'
-      # lore is optional
-      lore: '&6Rankup to &b{{next.rank}}'
+      name: "&a&lConfirm"
+
+      # Lore is optional
+      lore: "&6Rankup to &b{{next.rank}}"
     cancel:
-      material: REDSTONE_BLOCK
+      material: RED_STAINED_GLASS_PANE
       index: 5-8
-      name: '&c&lCancel'
+      name: "&c&lCancel"
+      lore: "&4Stay at &c{{rank.rank}}"
     fill:
       name: ' '
-      # if you are using a 1.8-1.12 and you want to change this
-      # you can use MATERIAL:data, for example STAINED_GLASS_PANE:8
-      # this works for both the rankup and cancel blocks as well
       material: BLACK_STAINED_GLASS_PANE
 
   ranksgui:
@@ -42,39 +53,34 @@ rankup:
     width: 7
     complete:
       material: GREEN_STAINED_GLASS_PANE
-      name: "&aRank &7{{next.rank}} &a(completed)"
+      name: "&aRank &7{{next.rank}}"
+      # Lore is optional.
+      lore: "&aCompleted"
     current:
       material: ORANGE_STAINED_GLASS_PANE
       name: "&dRankup to &7{{next.rank}}"
+      lore: "&cClick me to /rankup!"
     incomplete:
       material: RED_STAINED_GLASS_PANE
-      name: "&cRank &7{{next.rank}} &c(requires rankup)"
+      name: "&cRank &7{{next.rank}}"
+      lore: "&cRequires rankup"
     fill:
       material: BLACK_STAINED_GLASS_PANE
       name: ' '
 
-
-  # you can (and probably should) you override these in rankups.yml
-  # to show the specific requirements for each rank.
-  # however if you are just using money or don't need to change the message per rank, you can use any combination of:
-  # {{rank.requirement('money').total | simple}} {MONEY_NEEDED} {PERCENT_DONE <requirement>} {PERCENT_LEFT <requirement>} {AMOUNT <requirement>} {AMOUNT_NEEDED <requirement>}
-  # {{rank.requirement('money').total | simple}} and {MONEY_NEEDED} are different from {AMOUNT money} and {AMOUNT_NEEDED money} in that they use a different format.
-  # here is an example of showing the requirements for just money:
-  #list:
-  #  complete: "&7{{rank.rank}} &8\xbb &7{{next.rank}} &efor &7${{rank.requirement('money').total | simple}}"
-  #  current: "&c{{rank.rank}} &e\xbb &c{{next.rank}} &efor &a${{rank.requirement('money').total | simple}} &e{PERCENT_DONE money}%"
-  #  incomplete: "&r{{rank.rank}} &e\xbb &r{{next.rank}} &efor &a${{rank.requirement('money').total | simple}}"
   list:
     complete: "&7{{rank.rank}} &8\xbb &7{{next.rank}}"
     current: "&c{{rank.rank}} &e\xbb &c{{next.rank}}"
     incomplete: "&r{{rank.rank}} &e\xbb &r{{next.rank}}"
-    # an empty string disables the header/footer
+    # An empty string disables the header/footer.
     header: ""
     footer: ""
-  # sent when a player tries to rankup when they are on cooldown
+
+  # Sent when a player tries to rankup when they are on cooldown
   cooldown:
     singular: "&cYou must wait {{seconds_left}} more second to rankup again."
     plural: "&cYou must wait {{seconds_left}} more seconds to rankup again."
+
 # prestige messages can also be customised
 prestige:
   requirements-not-met: "&cYou need {{rank.requirement('money').total | money}} money to prestige."
@@ -89,20 +95,23 @@ prestige:
 
   gui:
     title: "Prestige to {{next.rank}}"
+
+    # ===[ IMPORTANT PRE-FLATTENING INFO ]===
+    # If you are using a 1.8-1.12 and you want to change this
+    # you can use MATERIAL:data, for example STAINED_GLASS_PANE:8
+    # this works for both the rankup, cancel and fill blocks as well.
+
     rankup:
-      material: GOLD_BLOCK
+      material: BLUE_STAINED_GLASS_PANE
       index: 0-3
       name: '&a&lConfirm'
       lore: '&6Prestige to &b{{next.rank}}'
     cancel:
-      material: REDSTONE_BLOCK
+      material: RED_STAINED_GLASS_PANE
       index: 5-8
       name: '&c&lCancel'
     fill:
       name: ' '
-      # if you are using a 1.8-1.12 and you want to change this
-      # you can use MATERIAL:data, for example STAINED_GLASS_PANE:8
-      # this works for both the rankup and cancel blocks as well
       material: BLACK_STAINED_GLASS_PANE
 
   list:
@@ -115,5 +124,6 @@ prestige:
     singular: "&cYou must wait {{seconds_left}} second to prestige again."
     plural: "&cYou must wait {{seconds_left}} more seconds to prestige again."
 
+# Other strings
 not-high-enough: "&cYou cannot prestige at your rank!"
 not-in-ladder: "&cSorry, but we could not find any rankups for the group(s) you are in. Use /ranks to list the rankups."