VanguardRanks ⭕ Unlimited Ranks ✅ GUI Based ✨ PAPI Support

VanguardRanks ⭕ Unlimited Ranks ✅ GUI Based ✨ PAPI Support -----

Easy to use ranking plugin with PAPI and GUI support.

Dynamic set of structure (BREAKING CHANGE)

Now you can define the characters (1 letters) and function of the gui structure, this enables adding more decorative blocks to the gui.

Remember to update the config.yml

Code (YAML):

structure :
- "B A B A * A B A B"
- ". . . . . . . . ."
- ". . . . . . . . ."
- "B B B < X > B B B"
recipe:
"*":
icon : PLAYER_HEAD
icon_amount : 1
icon_model_data : 3
function : PLAYER
display_name : '&7 %player%'
lore :
- "Current rank %rank%"
- "..."
- "..."
# Fill the empty space with a material
".":
icon : AIR
function : RANK
# You can use as a material
"A":
icon : BLACK_STAINED_GLASS_PANE
function : DECORATIVE
# You can also not define a function, default will be DECORATIVE
"B" : WHITE_STAINED_GLASS_PANE
"X":
icon : REDSTONE
function : CLOSE
# You can use as an item with model data
"<":
icon : RED_STAINED_GLASS_PANE
icon_model_data : 10
function : BACK
">":
icon : LIME_STAINED_GLASS_PANE
icon_model_data : 0
function : FORWARD

----------, Jun 8, 2025

MYSQL Support

In this version
- Fixed the requirements message appearing different on /rank gui and /rank up
- Added support to mysql to store the save of players

Code (YAML):

storage:
adapter : yaml # yaml | mysql

prefix : vanguard_ranks
address : localhost:3306
database : minecraft
username : root
password : ''

----------, May 24, 2025

When having a command in a rank to send message to discord but the discord integration is disabled it would throw an error.

----------, Apr 10, 2025

Rank Checker and updater of locale file

This version adds a rank checker that from time to time check for rank requirements and ranks up the player when possible. Add to config.yml

Code (YAML):

rank_checker : 300 # in seconds -1 to disable

Also adds an updater of locale.yml file to prevent from throwing error when adding new messages like in this version.

----------, Apr 5, 2025

Created a doc website

I created a doc website for the plugin giving an overview of how things work. If you find improvements let me know in our discord server:

https://docs.zerun.com.br/
https://discord.gg/2yb4vSaCdS

----------, Mar 30, 2025

New internal and PAPI placeholders

Added new placeholders to get information for the next and previous ranks.

- next_name
- previous_name
- next_prefix
- previous_prefix
- next_order
- previous_order
- next_rank
- previous_rank
- next_display_name
- previous_display_name

----------, Jan 27, 2025

Conditional Commands

This patch adds a feature that allows you to conditionally execute commands based on player permissions. You can now specify permissions for each rank’s "commands" section and run a command only if the player has the required permissions.

SYNTAX

Use perm_<permission>: <command> to run a command if the player has the specified permission.

You can check for multiple permissions:

perm_<permission1>,<permission2>: <command> - Executes if the player has all listed permissions (AND condition).
perm_<permission1>;<permission2>: <command> - Executes if the player has at least one of the listed permissions (OR condition).

EXAMPLE

Code (YAML):

- 'perm_rank.vip1;rank.vip2 : eco give %player% 1000'
- 'perm_rank.vip1,rank.vip2 : eco give %player% 1000'

The first command checks if the player has both rank.vip1 and rank.vip2 permissions before executing the command.
The second command checks if the player has either rank.vip1 or rank.vip2 permission before executing the comma

----------, Jan 20, 2025

Success Other Message

- Added a configurable locale for when an admin set the rank to another player

Code (YAML):

set_success_other : "&7Your rank has been set to &6%rank%&7."

----------, Jan 6, 2025

Update snake and vertical flow

- Fixed vertical flow acting as horizontal
- Fixed snake flow not knowing where to start

----------, Oct 19, 2024

Player icon

- Added a icon to show information about the player

Code (YAML):

structure :
- "# # # # * # # # #"
- ". . . . . . . . ."
- ". . . . . . . . ."
- "# # # < X > # # #"
recipe:
"*":
icon : PLAYER_HEAD
icon_amount : 1
icon_model_data : 3
display_name : '&7 %player%'
lore :
- "Current rank %rank%"

----------, Oct 18, 2024

Fix missing placeholder message

- Fixes a missing placeholder message when running any command

----------, Sep 19, 2024

Filler material

- Added a filler material for "." recipe
- Fixed issue when running "/rank up" on last rank
- Added bstats charts

----------, Sep 17, 2024

Filler material

- Added a filler material for "." recipe

- Fixed an error when running "/rank up" on last rank

----------, Sep 17, 2024

Fixed invalid placeholder checker

On version 1.6.9 we added a checker for when a placeholder was not installed or simply invalid. The verification for that was inverted... So this version fix this verification.

----------, Aug 2, 2024

GUI Rewrite

- Internally all the inventory interaction was rewritten, making it possible to decide how the ranks are displayed. Being HORIZONTAL, VERTICAL, and SNAKE the current supported flows.

- As I removed the dependency that I was using for the GUI, now the plugin is WAY smaller

Code (YAML):

menu:
gui:
flow : SNAKE # SNAKE, HORIZONTAL, VERTICAL
structure :
- ". . . . . . . . ."
- ". . . . . . . . ."
- ". . . . . . . . ."
- "# # # < # > # # #"

----------, Jul 25, 2024

Handle invalid placeholders and fix deny message listing

- Now when found an unrecognized PAPI placeholder it logs a message in the console instead of throwing an error to the player

- Fixed listing deny message when a player tries to rank up but there are a few requirements still in progress

----------, Jul 25, 2024

Added close button

- Added a button to close the inventory. Just like back, and forward buttons, it accepts an icon and a model data.

For now it requires you to manually update config.yml and locale.yml

con config.yml add "X:..."

Code (YAML):

menu:
gui:
structure :
- ". . . . . . . . ."
- ". . . . . . . . ."
- ". . . . . . . . ."
- "# # # < X > # # #"
recipe :
# You can use as a material
"#" : BLACK_STAINED_GLASS_PANE
"X" : REDSTONE
# or
"X":
icon : REDSTONE
icon_amount : 1

on locale.yml add "gui_close: ..."

Code (YAML):

gui_close : "&7Close"

----------, Jul 20, 2024

Fixed on 1.21

- Fixed a problem when running on spigot server
- Fixed a problem with custom model data
- Removed unnecessary dependency (so smaller bundle)

----------, Jul 20, 2024

Choose to display lore by rank status

- Added support for choosing in which status the rank's lore will be displayed.

Code (Text):

in_progress:
display_name: '%rank% &7- &e&lIN PROGRESS'
icon: AIR
icon_amount: 1
display_lore: true
prepend_lore: [ ]
append_lore:
- " "
- "&6You are currently working on this rank!"
locked:
display_name: '%rank% &7- &c&lLOCKED'
icon: AIR
icon_amount: 1
display_lore: false
prepend_lore: [ ]
append_lore:
- " "
- "&cYou need to complete the previous rank!"

----------, Jul 19, 2024

Injecting current and required placeholders

- Added support to injecting requirement placeholders into papi placeholders. It makes formatting "current" and "required" placeholders from gui-message and deny-message possible.

Example using https://api.extendedclip.com/expansions/formatter/

Code (YAML):

requirements :
' %vault_eco_balance%':
type : NUMBER
eval : GREATER
value : 100
gui_message : '&7Money &a %formatter_number_shorten_{current}%&7/&e%formatter_number_shorten_{required}% &r%status%'
deny_message : '&7You need to have more money than &c$ %formatter_number_shorten_{required}%'

----------, Jul 18, 2024

Heads on GUI Structure

- Fixed a problem when using heads on the GUI structure. It works just like in ranks.

----------, Jul 17, 2024

Improved configuration of structure

- Added a config to change the border, back, and forward items accepting custom model data.

Code (YAML):

menu:
gui:
structure :
- ". . . . . . . . ."
- ". . . . . . . . ."
- ". . . . . . . . ."
- "# # # < # > # # #"
recipe :
# You can use as a material
"#" : BLACK_STAINED_GLASS_PANE
# You can use as an item with model data
"<":
icon : RED_STAINED_GLASS_PANE
icon_model_data : 10
">":
icon : LIME_STAINED_GLASS_PANE
icon_model_data : 0

- Fixed the back and forward button

----------, Jul 17, 2024

Fix title command

Fixed an issue where not setting a subtitle would throw an error and no title would appear on the player screen.

----------, Jul 15, 2024

Improved placeholder handling

Placeholders that return a blank string " " are handled differently depending on the requirement type (NUMBER or BOOLEAN). For NUMBER, is assigned the value 0, and for BOOLEAN the value is false.

----------, Jul 14, 2024

Duplicated prefix

- Fixed prefix + separator being duplicated
- Fixed /rank help header being duplicated

Thanks ApoCalipsiS

----------, Jul 14, 2024

Title Command

- Added a title command that works with hexadecimal colors.
A palliative measure for hex colors not working with general commands

----------, Jul 14, 2024

Text formatting

- Fixed issue with text formatting on GUI

- Added support to hexadecimal colors &#f2f2f2 (doesn't work on commands for now)

----------, Jul 14, 2024

Version 1.2 - Some breaking changes

- Removed %vanguardranks_icon% and %vanguardranks_icon_amount% placeholders

- Changed STRING, FLOAT, DOUBLE, LONG requirement type to TEXT, NUMBER and BOOLEAN
- Changed LESS and LESS_EQUAL to LESSER and LESSER_EQUAL