API tools faq
paste
Advertisement
Guest User

TreeRanks config.yml v0.2.0

a guest
Aug 11th, 2018
126
0
Never
Add comment
Not a member of Pastebin yet? Sign Up, it unlocks many cool features!
JavaScript 9.46 KB | None | 0 0
raw download clone embed print report
  1. #v0.2.0
  2. #author: BlockyBorzan
  3. #compatible with MC 1.13
  4.  
  5. #DISCLAIMER:
  6. #THIS IS NOT A PERMISSION PROVIDER, MERELY A PLUGIN TO HELP WITH RANKING UP PLAYERS ALONG PREDEFINED
  7. #RANK PATH. IT REQUIRES VAULT, AN ECONOMY AND A PERMISSION PROVIDER TO WORK!
  8.  
  9. # supported are 'yml', 'mysql' and 'sqlite'. mysql is recommended.
  10. # use 'none' to not store any player rank data. Storing user rank
  11. # data can reduce lag on the server, however if another plugin
  12. # changes user ranks, this might pose problems.
  13. storage-type: 'none'
  14.  
  15. # mysql connection data (only relevant if storage-type is 'mysql')
  16. # (the database has to exist beforehand in order to use mysql storage
  17. # however all tables are created automatically)
  18. mysql:
  19.   host: 'host'
  20.   database: 'database'
  21.   port: 'port'
  22.   user: 'user'
  23.   password: 'password'
  24.   table_prefix: 'ranks_'
  25.  
  26.  
  27. # DEFINE MESSAGES SENT TO PLAYERS HERE
  28.  
  29. # you can use {rank} to represent the name of the new rank. The name is derived from the rank tree and
  30. # converted into a CamelCase String with spaces (e.g. god_emperor becomes God Emperor).
  31. # you can also use chat color codes in combination with the ampersand character ('&').
  32. # Leave the options empty ('') in order to not send any messages.
  33. # supported placeholders are {player}, {nickname} and {rank}. More will probably be added in the future.
  34. messages:
  35.   # Sent only to the player on rankup
  36.   player-rankup: '&3Congratulations! You just ascended to the rank of &6{rank}&3!'
  37.  
  38.   # Broadcast to the whole server. If player-rankup is defined (not empty or missing),
  39.   # the player who just ranked up will not receive this message because they already
  40.   # receive the player-rankup message.
  41.   rankup-broadcast: '&3Congratulations to &6{nickname}&3 for ranking up to &6{rank}&3!'
  42.  
  43.   # Message sent to players who reached a rank that can not rank up any higher
  44.   # (Last rank on any branch that has no successors)
  45.   highest-rank-reached-err: '&5 As &6{rank}&5, you have already reached the highest rank and can not rank up any further. Congratulations!'
  46.  
  47.   # Error message sent to players when they try to rankup, but their new rank could not be saved
  48.   # using the specified storage-type. The rankup is not successful in this case (rankup-unsuccessful will also be sent)!
  49.   saving-rank-err: '&4Something went wrong and your new rank was not saved.'
  50.  
  51.   # Sent to players who try to rankup, but do not have a rank on the rank tree.
  52.   # NO PLACEHOLDERS ARE SUPPORTED ON THIS MESSAGE!
  53.   no-rank-on-tree-err: '&cUnfortunately you do not have any ranks that match the rank tree. Please contact a staff member if you think this is a mistake.'
  54.  
  55.   # Error message sent to players when they try to rankup, but an error in the code of any
  56.   # unexpected kind happens. The rankup is not successful in this case (rankup-unsuccessful will also be sent)!
  57.   # NO PLACEHOLDERS ARE SUPPORTED ON THIS MESSAGE!
  58.   exception-err: '&4An error has occured, please try again or contact staff about it if the problem persists.'
  59.  
  60.   # Message sent to players when their rankup was unsuccessful.
  61.   # NO PLACEHOLDERS ARE SUPPORTED ON THIS MESSAGE!
  62.   rankup-unsuccessful: '&cUnable to rank up.'
  63.  
  64.  
  65. #
  66. # DEFINE YOUR RANK TREE HERE
  67. #
  68.  
  69. # This is the default rank each player on your server should have when they join.
  70. # This rank is considered the root of the rank tree (see below)
  71. # This rank has no predecessors, rankup requirements or rankup messages (see below)
  72. default-rank: 'default'
  73.  
  74. # The default rank is the beginning of the first branch. You can name this branch so the ranks gui
  75. # shows the branch name instead of the rank name as the title of the navigation item.
  76. default-rank-branch-name: 'Aristocracy'
  77.  
  78. # A few things to pay attention to and consider:
  79. # - specify your tree by listing all ranks in it
  80. # - a player is only allowed to have one rank on this tree at one time.
  81. #     (If you grant a player more than one rank on this tree via for example commands, the rankup will look for the
  82. #     highest rank (deepest in the tree) the player has, or choose one at random if two ranks are on an equal level)
  83. # - multiple predecessors to ranks are supported, simply list them all inside []
  84. # - only one rank tree is supported and only 5 rank predecessors/successors are allowed per rank
  85. #     (this limitation is due to the gui, I plan to change this in the future but for now it is what it is, sorry.)
  86. # - only 36 ranks are allowed per branch. (this limitation is also due to the gui and probably won't change in the future...)
  87. #   ***NOTE: a branch is defined as a series of ranks that each have one and only one successor/predecessor.
  88. #              the start of a branch is either the default rank, or the first rank in the series with more than one predecessors
  89. #              the end of a branch is either the last rank in the series, or the first rank with more than one successors
  90. #              this definition of branch holds true wether you name it or not.
  91. # - if the no predecessors are specified, the predecessor is automatically chosen as the
  92. #     previous rank in the list.
  93. # - all mentioned predecessors must be specified in the list (or be the default rank) before setting them as predecessors
  94. # - at least one rank in the tree has to specify the default-rank as its predecessor. If none do, the tree will only consist of
  95. #     the default-rank as no other ranks are descendants.
  96. # - you can specify a 'rankup-message' that will be displayed on the rankup ui when ranking up to that rank.
  97. # - you can specify a 'branch-name' at the start of a new branch (usually only when you specify predecessors).
  98. #     this will be displayed when players use the /ranks command to list all ranks. This is only relevant when one
  99. #     rank branches out into more than one other rank in terms of inheritance.
  100. # - you can specify a 'gui-material' for each that corresponds to one of the org.bukkit.Material enumerators found
  101. #     here: https://hub.spigotmc.org/javadocs/bukkit/org/bukkit/Material.html. Supported Materials include all of the following:
  102. #     concrete, concrete powder, stained glass, stained glass panes, wool. The character case is not important.
  103. #     By default and if no other material or any unsupported material is specified,
  104. #     the material chosen is a colored concrete block chosen at random.
  105. # - you can specify 'rank-perks' which explain which perks the particular rank has. Note that this does not provide
  106. #     the perks themselves. It merely displays information you choose to disclose to your players.
  107. # Rankup criteria:
  108. # - the money-cost requirement is the amount of money a player has to pay to rankup (0 to disregard)
  109. # - the xp-cost requirement is the amount of xp (in levels) a player has to pay to rankup (0 to disregard)
  110. # - the min-play-time requirement is the amount of time a player has to spend playing on the server (0 to disregard)
  111. #     it supports shorthand notation:
  112. #     y... years (really? like... really?)
  113. #     w... weeks
  114. #     d... days
  115. #     h... hours
  116. #     m... minutes
  117. #     s... seconds
  118. #     for example, 1d6h2m40s would equal to 1 day, 6 hours, 2 minutes and 40seconds. 600s would equal to 600 seconds or 10 minutes.
  119. #     (just entering a number is fine as well, they are interpreted in seconds. e.g. 604800 is equal to 7d (7 days))
  120. # - leaving out any of the criteria will default it to 0 and therefor it will be disregarded for that rank
  121. # - the min-mcmmo requirement is the amount of McMMO levels a player must have to rankup (none will be deducted, 0 to disregard)
  122.  
  123.  
  124. # THIS IS AN EXAMPLE RANK TREE:
  125.  
  126. #ranks:
  127. #  knight:
  128. #    money-cost: 100
  129. #    xp-cost: 10
  130. #    min-play-time: 10m
  131. #    min-mcmmo: 0
  132. #    predecessors: ['default']
  133. #    gui-material: 'light_gray_concrete'
  134. #    rank-perks:
  135. #      - Perk 1
  136. #      - Perk 2
  137. #      - Perk 3
  138. #  earl:
  139. #    money-cost: 0
  140. #    xp-cost: 0
  141. #   min-play-time: 0
  142. #   min-mcmmo: 0
  143. #   gui-material: 'gray_concrete'
  144. #   rank-perks:
  145. #     - Perk 1
  146. #     - Perk 2
  147. #     - Perk 3
  148. # king:
  149. #   money-cost: 0
  150. #   xp-cost: 0
  151. #   min-play-time: 0
  152. #   min-mcmmo: 0
  153. #   gui-material: 'light_gray_concrete'
  154. #   rank-perks:
  155. #     - Perk 1
  156. #     - Perk 2
  157. #     - Perk 3  
  158.  
  159. # #empire branch
  160. # emperor:
  161. #   money-cost: 0
  162. #   xp-cost: 0
  163. #   min-play-time: 0
  164. #   min-mcmmo: 0
  165. #   predecessors: ['king']
  166. #   branch-name: 'Empire'
  167. #   gui-material: 'lime_concrete'
  168. #   rank-perks:
  169. #     - Perk 1
  170. #     - Perk 2
  171. #     - Perk 3
  172. # god_emperor:
  173. #   money-cost: 0
  174. #   xp-cost: 0
  175. #   min-play-time: 0
  176. #   min-mcmmo: 0
  177. #   gui-material: 'green_concrete'
  178. #   rank-perks:
  179. #     - Perk 1
  180. #     - Perk 2
  181. #     - Perk 3
  182.  
  183. # #angelic branch
  184. # angel:
  185. #   money-cost: 0
  186. #   xp-cost: 0
  187. #   min-play-time: 0
  188. #   min-mcmmo: 0
  189. #   predecessors: ['king']
  190. #   branch-name: 'Angelic'
  191. #   gui-material: 'light_blue_concrete'
  192. #   rank-perks:
  193. #     - Perk 1
  194. #     - Perk 2
  195. #     - Perk 3
  196. # archangel:
  197. #   money-cost: 0
  198. #   xp-cost: 0
  199. #   min-play-time: 0
  200. #   min-mcmmo: 0
  201. #   gui-material: 'blue_concrete'
  202. #   rank-perks:
  203. #     - Perk 1
  204. #     - Perk 2
  205. #     - Perk 3
  206. #  
  207. #
  208. # #divine branch
  209. # demigod:
  210. #   money-cost: 0
  211. #   xp-cost: 0
  212. #   min-play-time: 0
  213. #   min-mcmmo: 0
  214. #   predecessors: ['archangel', 'god_emperor']
  215. #   branch-name: 'Divine'
  216. #   gui-material: 'yellow_concrete'
  217. #   rank-perks:
  218. #     - Perk 1
  219. #     - Perk 2
  220. #     - Perk 3
  221. # god:
  222. #   money-cost: 0
  223. #   xp-cost: 0
  224. #   min-play-time: 0
  225. #   min-mcmmo: 0
  226. #   gui-material: 'orange_concrete'
  227. #   rank-perks:
  228. #     - Perk 1
  229. #     - Perk 2
  230. #     - Perk 3
Advertisement
Add Comment
Please, Sign In to add comment
Advertisement
Public Pastes
Advertisement
We use cookies for various purposes including analytics. By continuing to use Pastebin, you agree to our use of cookies as described in the Cookies Policy.  OK, I Understand
Not a member of Pastebin yet?
Sign Up, it unlocks many cool features!