> For the complete documentation index, see [llms.txt](https://lethium.gitbook.io/lethium-docs/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://lethium.gitbook.io/lethium-docs/server-setup/tab.md).

# TAB: tab list, name tags and scoreboard

The tab list, name tags, below-name line, Bedrock scoreboard, and how rank badges are built.

Files: `plugins/TAB/config.yml`, `groups.yml`, `animations.yml`, `messages.yml`. Apply changes with **`/tab reload`**.

{% hint style="success" %}
**Quick start**

* Reload: `/tab reload`.
* Change rank badges: `groups.yml` (one block per LuckPerms group, in capitals).
* Change the IP text: the `ip` animation in `animations.yml`.
* Change sorting: `scoreboard-teams.sorting-types`.
  {% endhint %}

{% hint style="info" %}
The TAB jar is not in the `Clicker.zip` package. Install the TAB plugin yourself (it is free) and keep the files above.
{% endhint %}

### What players see

| Place                                | What is shown                                                                     |
| ------------------------------------ | --------------------------------------------------------------------------------- |
| **Tab list header**                  | The server logo image (`%img_clickemsimulator%`) and `Online: <count>`.           |
| **Tab list footer**                  | Animated lines (`%animation:tab1%` ...) and the server IP animation.              |
| **Tab list name**                    | `[star <clan tag>] <rank badge> <player name>`                                    |
| **Name tag above the head**          | The same as the tab list name.                                                    |
| **Below the name**                   | `[Power] [Gold] [hours played]`, for example `Power 1.5K` `Gold 25K` `12h`.       |
| **Player list number** (Bedrock tab) | The player's Power (`%clickem_stat_damage%`).                                     |
| **Scoreboard**                       | Shown to **Bedrock players only**. Java players use the BetterHud screen instead. |

### Sorting

```yaml
scoreboard-teams:
  sorting-types:
    - "GROUPS:owner,developer,manager,sradmin,admin,srmod,mod,srhelper,helper,legend,supreme,elite,mvp,vip,default"
    - "PLACEHOLDER_HIGH_TO_LOW:%clickem_stat_damage%"
    - "PLACEHOLDER_A_TO_Z:%player%"
```

Players are ordered by rank first, then by **Power (highest first)**, then by name. To change the order, edit the group list. A group missing from the list sorts last.

### Rank badges (`groups.yml`)

Each LuckPerms group has a block named in capitals:

```yaml
VIP:
  tabprefix: "<shadow:#222426:1>&8[&f%img_star_emoji% <shadow:#222426:1>&#FFCC00%clickem_clan_tag%&8] <shadow:#222426:1>&f%img_clickem_rank_vip%&#D79431"
  tagprefix: "... same, for the name tag ..."
  customtabname: " &#D79431%player%"
```

| Key                      | Meaning                                         |
| ------------------------ | ----------------------------------------------- |
| `tabprefix`              | Text before the name in the tab list.           |
| `tagprefix`              | Text before the name above the head.            |
| `customtabname`          | How the name itself is written in the tab list. |
| `tabsuffix`, `tagsuffix` | Text after.                                     |

`_DEFAULT_` is used by players in `default`. `%img_clickem_rank_vip%` is the rank **icon** from the resource pack and `%clickem_clan_tag%` is their clan tag. See [ClickEm placeholders](/lethium-docs/placeholders.md).

#### Add a badge for a new rank

1. Create the LuckPerms group (see [LuckPerms](/lethium-docs/server-setup/luckperms.md)).
2. Add a block to `groups.yml` with the same name in capitals.
3. Add the group to the `GROUPS:` sorting list.
4. Add the icon to ItemsAdder (`clickem_emojies`) if you want a new picture.
5. `/tab reload`.

### Animations (`animations.yml`)

Animated text is referenced as `%animation:<name>%`. Provided: `dots`, `tab1` to `tab4`, `ip`, and `barcolors`.

{% hint style="danger" %}
The `ip` animation still says **`play.yourserver.net`**. Replace it with your real IP in `animations.yml` (every line of `texts:`), then `/tab reload`.
{% endhint %}

### The Bedrock scoreboard

Only players where `%floodgate_isbedrock%=true` see it. It shows rank, Profile Level and progress, Rebirth and progress, Gold, Essence, Gems, Power, Fury, current zone and progress, the player's element, and the enemy's element with the matchup multiplier.

Edit `scoreboard.scoreboards.bedrock.lines` to add or remove lines. Players can toggle it with `/sb`.

### Useful settings

| Setting                                                  | Meaning                                                              |
| -------------------------------------------------------- | -------------------------------------------------------------------- |
| `header-footer.designs.default`                          | Header and footer text.                                              |
| `belowname-objective.fancy-value`                        | The line below the name.                                             |
| `playerlist-objective`                                   | The number next to names on Bedrock.                                 |
| `scoreboard-teams.enable-collision`                      | Whether players push each other.                                     |
| `placeholder-refresh-intervals.default-refresh-interval` | 500 ms. Lower is faster and heavier.                                 |
| `bossbar`                                                | Off by default.                                                      |
| `layout`                                                 | Fancy 80-slot tab layout. Off.                                       |
| `proxy-support`                                          | On for a network, using RedisBungee. Leave alone on a single server. |

### Troubleshooting

* **Placeholders show as text:** PlaceholderAPI is missing, or the expansion is not installed. Run `/papi parse me %clickem_profile_level%` and `/papi ecloud` only if needed. The expansions used here are already in `plugins/PlaceholderAPI/expansions/`.
* **Badge shows as squares:** the resource pack did not load for that player.
* **Order wrong:** check the group names in the `GROUPS:` list match LuckPerms exactly (lower case).


---

# 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://lethium.gitbook.io/lethium-docs/server-setup/tab.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.