add option to disable /ranks, make config clearer

src/main/resources/config.yml

@@ -1,6 +1,11 @@
 # this is used for letting you know that you need to update/change your config file
 version: 0
 
+# whether /ranks should be enabled (true) or disabled (false)
+# /rankup3 reload will not do anything if this is changed,
+# you will have to restart your server.
+ranks: true
+
 # how people should confirm ranking up
 # options are: gui, text or none
 confirmation-type: 'gui'

src/main/resources/messages.yml

@@ -15,13 +15,15 @@ rankup:
   # used for the GUI confirmation
   title: "Rankup to {RANK}"
 
-  # It is HIGHLY RECOMMENDED you override these in rankups.yml
+  # 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, you can use {MONEY} or {MONEY_NEEDED} or {PERCENT_DONE} or {PERCENT_LEFT}
-  # for example:
+  # however if you are just using money or don't need to change the message per rank, you can use any combination of:
+  # {MONEY} {MONEY_NEEDED} {PERCENT_DONE <requirement>} {PERCENT_LEFT <requirement>} {AMOUNT <requirement>} {AMOUNT_NEEDED <requirement>}
+  # {MONEY} 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:
   #ranks:
   #  complete: "&7{OLD_RANK} &8\xbb &7{RANK} &efor &7${MONEY}"
-  #  current: "&c{OLD_RANK} &e\xbb &c{RANK} &efor &a${MONEY} &e{PERCENT_DONE}%"
+  #  current: "&c{OLD_RANK} &e\xbb &c{RANK} &efor &a${MONEY} &e{PERCENT_DONE mon ey}%"
   #  incomplete: "&r{OLD_RANK} &e\xbb &r{RANK} &efor &a${MONEY}"
   ranks:
     complete: "&7{OLD_RANK} &8\xbb &7{RANK}"

src/main/resources/plugin.yml

@@ -1,5 +1,5 @@
 name: Rankup
-version: 3.0-alpha.10
+version: 3.0-alpha.12
 main: sh.okx.rankup.Rankup
 author: Okx
 depend: [Vault]
@@ -27,6 +27,7 @@ permissions:
             rankup.ranks: true
             rankup.reload: true
             rankup.ranks: true
+            rankup.sign: true
     rankup.info:
         default: true
     rankup.rankup:
@@ -38,4 +39,6 @@ permissions:
     rankup.reload:
         default: op
     rankup.ranks:
-        default: true
+        default: true
+    rankup.sign:
+        default: op

src/main/resources/rankups.yml

@@ -4,7 +4,7 @@ Aexample:
   # the next rank a player can rank up to.
   # this must be the name of the configuration section.
   # for example, the name of this configuration section is "Aexample".
-  # this is not required.
+  # if this is the last rank, you don't need this.
   next: 'Bexample'
   # List of requirements to go to the next rank
   # (ie, this example will charge 1000 money to rankup from A to B)
@@ -37,7 +37,7 @@ Cexample:
   requirements:
       money: 5000
       xp-level: 2
-  # you can have a custom messages too.
+  # you can have a custom messages for each rank
   # you can use this to list the requirements needed.
   rankup:
     requirements-not-met: '&cYou need 5000 money and 2 levels of XP to rankup to D.'