metadata.yml

name: "🏆 Achievements"
cost: ~5 GraphQL request
category: github
index: 17
supports:
  - user
  - organization
inputs:

  # Enable or disable plugin
  plugin_achievements:
    description: Display achievements
    type: boolean
    default: no

  # Minimal rank to display
  plugin_achievements_threshold:
    description: Display rank minimal threshold
    type: string
    default: C
    values:
      - S
      - A
      - B
      - C
      - X   # Not unlocked

  # Display secrets achievements unlocked
  plugin_achievements_secrets:
    description: Display unlocked secrets achievements
    type: boolean
    default: yes

  # Achievements display style
  plugin_achievements_display:
    description: Achievements display style
    type: string
    default: detailed
    values:
      - detailed  # Detailed display
      - compact   # Compact display (only icon, name and value are displayed)

  # Number of achievements events to display
  # Set to 0 to disable limitations
  plugin_achievements_limit:
    description: Maximum number of achievements to display
    type: number
    default: 0
    min: 0

  # List of unlocked achievements to hide
  # Names must be given in lower case, without rank adjective
  plugin_achievements_ignored:
    description: Unlocked achievements to hide
    type: array
    format: comma-separated
    default: ""
    example: octonaut, automater, explorer

  # List of unlocked achievements to display
  # Names must be given in lower case, without rank adjective
  # Using this option is equivalent of using "plugin_achievements_ignored" with all existing achievements but the ones listed
  plugin_achievements_only:
    description: Unlocked achievements to display
    type: array
    format: comma-separated
    default: ""
    example: octonaut, automater, explorer