General Guide

Main Configuration (config.yml)

The main configuration file contains several key sections:

Basic Settings


# Whether to assign a rank when player joins
rank_on_join: true

Discord Integration

Configure Discord webhook notifications for rank-up events:


discord:
  enabled: true
  avatar_url: 'https://minotar.net/helm/%player%/64.png'
  username: '%player%'
  webhook: 'https://discord.com/api/webhooks/YOUR_WEBHOOK_URL'

The menu system is highly customizable with several components:

GUI Structure

Define the layout and flow of the rank menu:


menu:
  gui:
    # Flow pattern for rank display (SNAKE, HORIZONTAL, VERTICAL)
    flow: SNAKE
    
    # Menu layout using symbols
    structure:
      - "# # # # * # # # #"
      - ". . . . . . . . ."
      - ". . . . . . . . ."
      - "# # # < X > # # #"

Recipe Configuration

Customize each element in the GUI:


    recipe:
      # Player head slot
      "*":
        icon: PLAYER_HEAD
        icon_amount: 1
        icon_model_data: 3
        display_name: '&7%player%'
        lore:
          - "Current rank %rank%"
          - "..."
      
      # Fill empty space
      ".": BLACK_STAINED_GLASS_PANE
      
      # Border decoration
      "#": BLACK_STAINED_GLASS_PANE
      
      # Navigation buttons
      "<":
        icon: RED_STAINED_GLASS_PANE
        icon_model_data: 10
      ">":
        icon: LIME_STAINED_GLASS_PANE
        icon_model_data: 0

Rank Status Display

Configure how different rank states appear:


  status:
    completed:
      display_name: '%rank% &7- &a&lCOMPLETED'
      icon: AIR
      icon_amount: 1
      display_lore: true
      prepend_lore:
        - " "
      append_lore:
        - " "
        - "&aYou have completed this rank!"
    
    current:
      display_name: '%rank% &7- &2&lCURRENT RANK'
      icon: AIR
      icon_amount: 1
      display_lore: true
      prepend_lore:
        - " "
      append_lore:
        - " "
        - "&aClick to rank up if all requirements are satisfied"
    
    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!"

Best Practices

Use color codes with & symbol for text formatting
Test configurations on a development server
Backup configuration files before making changes

Troubleshooting

Verify YAML syntax is correct
Check console for configuration errors
Ensure all referenced items and materials exist
Test commands with console first
Verify permissions are set correctly