GUI Guide

VanguardRanks provides an intuitive graphical user interface (GUI) for managing ranks. This guide explains how to use and customize the GUI system.

Accessing the GUI

• Use /rank gui to open your own rank management interface
• Use /rank gui [player] to view another player’s interface (requires permission)

GUI Layout

The rank management GUI displays:

• Available ranks in order of progression
• Current rank status and requirements
• Cost and requirements for each rank
• Visual indicators for locked/unlocked ranks

Flow Patterns

VanguardRanks supports three flow patterns that determine how items are arranged in the GUI:

HORIZONTAL Flow

Items are arranged from left to right, row by row:

[1][2][3][4][5]
[6][7][8][9][10]

Ideal for linear progression systems where ranks follow a straightforward path.

Configuration example:

gui:
  flow: HORIZONTAL
  structure:
    - "#########"
    - "#RRRRRRR#"
    - "#########"

VERTICAL Flow

Items are arranged from top to bottom, column by column:

[1][4][7]
[2][5][8]
[3][6][9]

Useful for hierarchical rank systems or when you want to group related ranks vertically.

Configuration example:

gui:
  flow: VERTICAL
  structure:
    - "#########"
    - "#RRRRRRR#"
    - "#########"

SNAKE Flow

Items follow a snake-like pattern, alternating between left-to-right and right-to-left:

[1][2][3][4][5]
[10][9][8][7][6]
[11][12][13][14][15]

Great for creating an engaging visual flow, especially in larger GUIs.

Configuration example:

gui:
  flow: SNAKE
  structure:
    - "#########"
    - "#RRRRRRR#"
    - "#########"

Structure Configuration

The GUI structure uses a character-based layout system:

• #: Border/decoration items
• R: Rank display slots
• : Empty space (air)

Example structure:

gui:
  structure:
    - "#########"
    - "#RRRRRRR#"
    - "#########"

Item Customization

Customize how ranks appear in the GUI:

ranks:
  vip:
    display: "&aVIP"    # Display name in GUI
    icon: DIAMOND        # GUI icon material
    description:         # Item lore
      - "&7Unlock VIP features"
      - "&7Cost: &6$5000"
    glow: true          # Add enchantment glow

Display States

Ranks in the GUI can appear in different states:

• Available: Ranks that can be purchased
• Locked: Ranks that require prerequisites
• Completed: Already obtained ranks
• Current: The player’s active rank

Each state can have unique visual indicators:

gui:
  states:
    available:
      overlay: GREEN_STAINED_GLASS_PANE
    locked:
      overlay: RED_STAINED_GLASS_PANE
    completed:
      glow: true
    current:
      overlay: YELLOW_STAINED_GLASS_PANE