GroupeZ Docs
Configurations

Placeholders

All available placeholders in zQuests

zQuests provides PlaceholderAPI placeholders to display quest information anywhere on your server. These placeholders can be used in scoreboards, holograms, chat formats, and of course in zMenu inventories.

Requirements

To use zQuests placeholders outside of zMenu, you need:

Quest Placeholders

Basic Quest Information

PlaceholderDescriptionExample Output
%zquests_name_<quest>%Quest display nameStone Breaker
%zquests_description_<quest>%Quest descriptionBreak 500 stone blocks
%zquests_thumbnail_<quest>%Quest thumbnail materialSTONE
%zquests_type_<quest>%Quest typeBLOCK_BREAK
%zquests_objective_<quest>%Quest goal amount500

Replace <quest> with the quest's unique name value.

Example:

%zquests_name_stone-breaker-1%

Quest Progress

PlaceholderDescriptionExample Output
%zquests_progress_<quest>%Current progress250
%zquests_progress_bar_<quest>%Visual progress bar`
%zquests_lore_line_<quest>%Formatted progress line`
%zquests_is_active_<quest>%Quest is activetrue or false
%zquests_is_completed_<quest>%Quest is completedtrue or false

Group Placeholders

PlaceholderDescriptionExample Output
%zquests_group_name_<group>%Group display nameMining Quests
%zquests_group_count_<group>%Total quests in group10
%zquests_group_finish_<group>%Completed quests in group5
%zquests_group_percent_<group>%Completion percentage50
%zquests_group_total_percent_<group>%Total progress percentage67.5

Replace <group> with the group identifier from config.yml.

Favorite Quests

PlaceholderDescription
%zquests_favorite_quests%Formatted list of favorite quests

Progress Bar Configuration

Configure the progress bar appearance in config.yml:

progress-bar:
  # Character for completed progress
  icon: '|'
  # Character for remaining progress
  not-completed-icon: '|'
  # Color for completed portion
  progress-color: "#0ff216"
  # Color for remaining portion
  color: "#828282"
  # Total bar length
  size: 30

Result:

||||||||||||||||||||||||||||||  (green: completed, gray: remaining)

Lore Line Configuration

Configure the lore line format in config.yml:

lore-line-placeholder:
  # Format for active quests
  active: "%progress-bar% &8- &6%progress%&8/&f%goal% &c✘"
  # Format for completed quests
  complete: "%progress-bar% &8- &6%progress%&8/&f%goal% &a✔"

Available variables:

  • %progress-bar% - The progress bar
  • %progress% - Current progress number
  • %goal% - Quest goal number

Favorite Quests Placeholder

Configure the favorite quests display in config.yml:

placeholder-favorite:
  # Maximum quests to show
  limit: 3
  # Message when no favorites
  empty: "&cNo favorite quests"
  # Format for each quest
  result: "&f%quest-description%\n&8%quest-display-name%\n#fcd600%quest-progress%&8/&f%quest-objective%"
  # Separator between quests
  between: "\n\n"

Available variables in result:

  • %quest-name% - Quest internal name
  • %quest-display-name% - Quest display name
  • %quest-description% - Quest description
  • %quest-thumbnail% - Quest thumbnail material
  • %quest-type% - Quest type
  • %quest-objective% - Quest goal
  • %quest-lore-line% - Formatted progress line
  • %quest-progress-bar% - Progress bar
  • %quest-percent% - Completion percentage
  • %quest-progress% - Current progress
  • %quest-global-group-name% - Quest group name

Quest Groups

Define quest groups in config.yml to use group placeholders:

quests-groups:
  mining:
    display-name: "Mining Quests"
    quests:
      - "stone-breaker-1"
      - "stone-breaker-2"
      - "ore-miner-1"
      - "ore-miner-2"

  farming:
    display-name: "Farming Quests"
    quests:
      - "wheat-farmer-1"
      - "crop-master-1"

# Default group name for ungrouped quests
global-group-display-name: "General"

Usage:

Mining Progress: %zquests_group_percent_mining%%

Usage Examples

In Scoreboard

# Example scoreboard configuration
lines:
  - "&6&lQUESTS"
  - ""
  - "&fActive: &e%zquests_is_active_daily-mining%"
  - "&fProgress: &a%zquests_progress_daily-mining%&7/&f%zquests_objective_daily-mining%"
  - "%zquests_progress_bar_daily-mining%"

In zMenu Inventory

items:
  quest-info:
    slot: 13
    item:
      material: "%zquests_thumbnail_stone-breaker%"
      name: "&6%zquests_name_stone-breaker%"
      lore:
        - "&7%zquests_description_stone-breaker%"
        - ""
        - "%zquests_lore_line_stone-breaker%"
        - ""
        - "&7Status: %zquests_is_completed_stone-breaker%"

In Chat Format

[Quest: %zquests_name_current-quest%] %player_name%: %message%

In Hologram

# zEssentials hologram
lines:
  - "&6&lDAILY QUEST"
  - "&f%zquests_name_daily-quest%"
  - ""
  - "%zquests_progress_bar_daily-quest%"
  - "&7%zquests_progress_daily-quest%&8/&f%zquests_objective_daily-quest%"

Placeholder Testing

Test placeholders with PlaceholderAPI:

/papi parse me %zquests_name_stone-breaker%
/papi parse me %zquests_progress_stone-breaker%
/papi parse me %zquests_is_active_stone-breaker%

Troubleshooting

Placeholder Shows "Unknown"

  • Verify the quest name is correct (case-sensitive)
  • Check that the quest exists in your configuration
  • Reload the plugin: /zquests reload

Progress Bar Not Showing

  • Make sure progress-bar is configured in config.yml
  • Check for YAML syntax errors

Group Placeholder Returns 0

  • Verify the group ID matches exactly
  • Check that quests are listed in the group configuration
  • Ensure the quest names match their name values

Next Steps

Rewards

Configure rewards for quest completion in zQuests

Commands & Permissions

All commands and permissions available in zQuests

On this page

RequirementsQuest PlaceholdersBasic Quest InformationQuest ProgressGroup PlaceholdersFavorite QuestsProgress Bar ConfigurationLore Line ConfigurationFavorite Quests PlaceholderQuest GroupsUsage ExamplesIn ScoreboardIn zMenu InventoryIn Chat FormatIn HologramPlaceholder TestingTroubleshootingPlaceholder Shows "Unknown"Progress Bar Not ShowingGroup Placeholder Returns 0Next Steps
GroupeZ MCP

Documentation in your AI

MCP lets your AI search GroupeZ documentation and read current examples to help you configure your plugins.

Read-only · No documentation API key needed

1. Copy the server URL

Transport: HTTP (Streamable HTTP). Authentication: none. Your tool uses its own model and subscription limits.

  1. Open Plugins in ChatGPT on the web, then + → Add custom MCP server.
  2. Name it ‘GroupeZ Documentation’, paste the URL above and choose ‘No authentication’. Create and install the plugin.
  3. In a conversation, type @ and select the plugin before asking. If needed, enable search, get_page and list_pages in its settings.
Official setup guide

3. Ask a question

Use GroupeZ MCP to help me create a zMenu inventory. Search relevant pages, read the examples and cite your sources.
Other clients and troubleshooting

For clients using mcpServers, adapt this example to their format:

{
  "mcpServers": {
    "groupez-docs": {
      "url": ""
    }
  }
}

Available tools are search, get_page and list_pages. Refresh the connector’s tools after updates. If your AI cannot access them, check that the connector is enabled in the conversation and your account allows custom MCP servers. Opening the URL in a browser is not an MCP test.