> For the complete documentation index, see [llms.txt](https://wiki.helpch.at/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://wiki.helpch.at/helpchat-plugins/deluxetags.md).

# DeluxeTags

Allow players to select chat tags that can be awarded by permission!

## Description

**DeluxeTags** gives players an extra tag that can be displayed in chat, tab lists, scoreboards, and any other plugin that supports PlaceholderAPI. Tags are permission based, so a player can unlock multiple tags and select the one they want from a configurable GUI.

## Features

* Create an unlimited number of permission-based tags.
* Organize tags into configurable categories.
* Automatically skip the category selector when a player can only see tags in one category.
* Configure the display name, lore, material, and data value of every tag item.
* Use legacy color codes, hex colors, or MiniMessage formatting.
* Customize the GUI layout, navigation buttons, and modern item model data.
* Grant tags as selectable, visible-only, forced, or default tags.
* Use built-in PlaceholderAPI placeholders with almost any chat plugin.
* Receive update notifications sourced from Modrinth.
* Use DeluxeTags' own chat formatter when no separate chat plugin is installed.

## Documentation

{% content-ref url="/pages/EvcBZrrC7eE04cdh6HSk" %}
[Categories & GUI](/helpchat-plugins/deluxetags/categories-and-gui.md)
{% endcontent-ref %}

{% content-ref url="/pages/ASYzCRgag3fzK5NMK15Y" %}
[Formatting](/helpchat-plugins/deluxetags/formatting.md)
{% endcontent-ref %}

{% content-ref url="/pages/-LmHwyfmXIaXm2I4pUoU" %}
[Commands & Permissions](/helpchat-plugins/deluxetags/commands-and-permissions.md)
{% endcontent-ref %}

{% content-ref url="/pages/-LnTrj\_per-VasQJaQYN" %}
[Placeholders](/helpchat-plugins/deluxetags/placeholders.md)
{% endcontent-ref %}

{% content-ref url="/pages/-LmHwyfnxQRdHtFt29Cu" %}
[Plugin's files](/helpchat-plugins/deluxetags/files.md)
{% endcontent-ref %}

## Setup

### Chat plugins with PlaceholderAPI support

1. Stop the server.
2. Place the DeluxeTags JAR in the server's `plugins` folder.
3. Start the server once to generate the configuration files.
4. Edit `/plugins/DeluxeTags/config.yml` and `/plugins/DeluxeTags/messages.yml`.
5. Set `papi_chat: true` in `config.yml`.
6. Add the required [DeluxeTags placeholders](/helpchat-plugins/deluxetags/placeholders.md) to the chat plugin's format.
7. Restart the server.
8. Grant players `deluxetags.tag.<identifier>` for each tag they may select.
9. Players can now open `/tags` and select a tag.

### DeluxeTags' built-in chat formatter

1. Place the DeluxeTags JAR in the server's `plugins` folder and start the server once.
2. Set `papi_chat: false` in `config.yml`.
3. Set `format_chat.enabled: true`.
4. Customize `format_chat.format`. The default is `{deluxetags_tag} <%1$s> %2$s`.
5. Make sure another plugin is not also changing the chat format.
6. Restart the server.

{% hint style="warning" %}
Back up `config.yml` before upgrading. DeluxeTags 1.9 automatically migrates existing tag GUI settings to the new per-tag format and places uncategorized tags in the `general` category.
{% endhint %}


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation by asking a question.

Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:

```
GET https://wiki.helpch.at/helpchat-plugins/deluxetags.md?ask=<question>&goal=<user_goal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.