5.0.6

[Bukkit] Fix error
[Fabric] Update to 25w06a
2026-11-13 12:42:06 -05:00 · 2025-02-06 17:54:47 +01:00 · 2025-02-06 17:27:46 +01:00 · 2025-02-05 20:15:43 +01:00 · 2025-02-05 19:13:56 +01:00 · 2025-02-05 18:33:49 +01:00
679 changed files with 45448 additions and 89207 deletions
@@ -0,0 +1,7 @@
+* text=auto
+
+*.sh text eol=lf
+gradlew text eol=lf
+*.bat text eol=crlf
+
+*.jar binary
@@ -1,28 +0,0 @@
---
-name: Bug report
-about: Report a bug
-title: ''
-labels: ''
-assignees: ''
-
---
-
-**Server version**
-
-
-**Plugin version** ("latest" is not a version)
-
-
-**Describe the bug**
-
-
-**How to reproduce**
-
-
-**Expected behavior**
-
-
-**Actual behavior**
-
-
-**Additional info** (errors, screenshots, ...)
@@ -0,0 +1,73 @@
+name: Bug Report
+description: Plugin does not work as described.
+labels: ["Type: Bug"]
+body:
+  - type: input
+    attributes:
+      label: Server version
+      description: Version and type of used server software where TAB is installed.
+      placeholder: Spigot 1.18.1
+    validations:
+      required: true
+
+  - type: input
+    attributes:
+      label: TAB version
+      description: Full version in numbers, "latest" is not a version.
+      placeholder: 3.0.2
+    validations:
+      required: true
+
+  - type: textarea
+    attributes:
+      label: Plugin list
+      description: Full list of plugins (output of /plugins)
+      placeholder: ...
+    validations:
+      required: true
+
+  - type: textarea
+    attributes:
+      label: Describe the bug
+      description: How the plugin behaves
+    validations:
+      required: true
+
+  - type: textarea
+    attributes:
+      label: Expected behavior
+      description: How the plugin is supposed to behave instead with your configuration.
+    validations:
+      required: true
+
+  - type: textarea
+    attributes:
+      label: Steps to reproduce
+      description: What to do in order to reproduce this issue
+      placeholder: |
+        Step 1: ..
+        Step 2: ..
+    validations:
+      required: true
+
+  - type: textarea
+    attributes:
+      label: Additional info
+      description: Anything else you want to provide that will help in resolving the issue faster, such as screenshots or videos.
+    validations:
+      required: false
+  - type: checkboxes
+    attributes:
+      label: Checklist
+      description: Let's make sure this report is valid
+      options:
+        - label: I am running latest version of the plugin
+          required: true
+        - label: I have read the wiki to make sure it's not an issue with configuration
+          required: true
+        - label: I ticked all of the boxes without actually reading them
+          required: false
+        - label: I have read the Compatibility wiki page and am not trying to run the plugin on an unsupported server version / platform
+          required: true
+        - label: I am willing to cooperate to get this issue resolved faster, including providing any additional information requested or testing new builds
+          required: true
@@ -0,0 +1,38 @@
+name: Compatibility issue
+description: A compatibility issue with another plugin/mod or a specific version of a platform marked as supported
+labels: ["Type: Compatibility issue"]
+body:
+  - type: input
+    attributes:
+      label: TAB version
+      description: Full version in numbers, "latest" is not a version.
+      placeholder: 4.0.0
+    validations:
+      required: true
+
+  - type: textarea
+    attributes:
+      label: Software causing compatibility issue
+      description: plugin/mod/platform version causing the issue
+    validations:
+      required: true
+
+  - type: textarea
+    attributes:
+      label: Additional info
+      description: Anything else you want to provide that will help in resolving the issue faster.
+    validations:
+      required: false
+  - type: checkboxes
+    attributes:
+      label: Checklist
+      description: Let's make sure this report is valid
+      options:
+        - label: I am running latest version of the plugin
+          required: true
+        - label: I ticked all of the boxes without actually reading them
+          required: false
+        - label: The compatibility wiki page does not mention this incompatibility
+          required: true
+        - label: I am willing to cooperate to get this issue resolved faster, including providing any additional information requested or testing new builds
+          required: true
@@ -0,0 +1,5 @@
+blank_issues_enabled: false
+contact_links:
+  - name: Support
+    url: https://discord.gg/YPqXt63YQj
+    about: Fresh new community discord providing support with all plugins, including TAB
@@ -0,0 +1,57 @@
+name: Error
+description: Error message with a stack trace in console or error file.
+labels: ["Type: Error"]
+body:
+  - type: input
+    attributes:
+      label: Server version
+      description: Version and type of used server software where TAB is installed.
+      placeholder: Spigot 1.18.1
+    validations:
+      required: true
+
+  - type: input
+    attributes:
+      label: TAB version
+      description: Full version in numbers, "latest" is not a version.
+      placeholder: 3.0.2
+    validations:
+      required: true
+
+  - type: textarea
+    attributes:
+      label: Stack trace
+      description: The error message and stack trace you received in console or errors.log file.
+    validations:
+      required: true
+
+  - type: textarea
+    attributes:
+      label: Steps to reproduce (if known)
+      description: What to do in order to reproduce this issue
+      placeholder: |
+        Step 1: ..
+        Step 2: ..
+    validations:
+      required: false
+
+  - type: textarea
+    attributes:
+      label: Additional info
+      description: Any other info you want to provide.
+    validations:
+      required: false
+
+  - type: checkboxes
+    attributes:
+      label: Checklist
+      description: Let's make sure this report is valid
+      options:
+        - label: I am running latest version of the plugin
+          required: true
+        - label: I have included a paste of the error
+          required: true
+        - label: I ticked all of the boxes without actually reading them
+          required: false
+        - label: I have read the Compatibility wiki page and am not trying to run the plugin on an unsupported server version / platform
+          required: true
@@ -0,0 +1,56 @@
+name: Memory leak
+description: Memory leak caused by TAB.
+labels: ["Type: Memory leak"]
+body:
+  - type: input
+    attributes:
+      label: Server version
+      description: Version and type of used server software where TAB is installed.
+      placeholder: Spigot 1.18.1
+    validations:
+      required: true
+
+  - type: input
+    attributes:
+      label: TAB version
+      description: Full version in numbers, "latest" is not a version.
+      placeholder: 3.0.2
+    validations:
+      required: true
+
+  - type: textarea
+    attributes:
+      label: Heap dump
+      description: Link to uploaded memory dump which I can look into.
+    validations:
+      required: true
+
+  - type: textarea
+    attributes:
+      label: Uncleared object(s)
+      description: Objects you believe should have been removed from the memory but are not
+      placeholder: |
+        There is only 1 player online, but heap dump has 100 instances of TabPlayer
+    validations:
+      required: false
+
+  - type: textarea
+    attributes:
+      label: Additional info
+      description: Any other info you want to provide.
+    validations:
+      required: false
+
+  - type: checkboxes
+    attributes:
+      label: Checklist
+      description: Let's make sure this report is valid
+      options:
+        - label: I am running latest version of the plugin
+          required: true
+        - label: I have included download link of my heap dump
+          required: true
+        - label: I ticked all of the boxes without actually reading them
+          required: false
+        - label: I have explained what I believe is wrong with the heap dump
+          required: true
@@ -0,0 +1,55 @@
+name: Performance issue
+description: Performance issue in TAB or in server caused by TAB
+labels: ["Type: Performance"]
+body:
+  - type: input
+    attributes:
+      label: Server version
+      description: Version and type of used server software where TAB is installed.
+      placeholder: Spigot 1.18.1
+    validations:
+      required: true
+
+  - type: input
+    attributes:
+      label: TAB version
+      description: Full version in numbers, "latest" is not a version.
+      placeholder: 3.0.2
+    validations:
+      required: true
+
+  - type: textarea
+    attributes:
+      label: Evidence
+      description: Any evidence proving the performance issue, such as output of /tab cpu or timings.
+    validations:
+      required: true
+
+  - type: textarea
+    attributes:
+      label: Steps to reproduce (if known)
+      description: What to do in order to reproduce this issue
+      placeholder: |
+        Step 1: ..
+        Step 2: ..
+    validations:
+      required: false
+
+  - type: textarea
+    attributes:
+      label: Additional info
+      description: Any other info you want to provide.
+    validations:
+      required: false
+
+  - type: checkboxes
+    attributes:
+      label: Checklist
+      description: Let's make sure this report is valid
+      options:
+        - label: I am running latest version of the plugin
+          required: true
+        - label: I have included sufficient evidence of the issue
+          required: true
+        - label: I ticked all of the boxes without actually reading them
+          required: false
@@ -0,0 +1,29 @@
+name: Wiki change
+description: Change to text on a wiki page or adding a new section.
+labels: ["Type: Wiki change"]
+body:
+  - type: input
+    attributes:
+      label: Page link
+      description: Link to the page that should receive the change.
+      placeholder: https://github.com/NEZNAMY/TAB/wiki/Installation
+    validations:
+      required: true
+
+  - type: textarea
+    attributes:
+      label: Current text (if applicable)
+      description: Current version of the text (if modifying), ignore in case of new section.
+      placeholder: |
+        Installation on Bukkit/Spigot/Paper is as simple as it can be. Just put the plugin into plugins folder and restart the server. You can also run `/plugman load tab` to load the plugin while server is running.
+    validations:
+      required: false
+
+  - type: textarea
+    attributes:
+      label: New text
+      description: What the text should be changed to / how should new section look
+      placeholder: |
+        Put the plugin into plugins folder and restart the server. In case you don't want to restart your server, loading with plugins like PlugMan is supported.
+    validations:
+      required: true
@@ -0,0 +1,14 @@
+# About
+This folder contains the plugin's description as advertised on various marketplaces which use various syntaxes
+(bbcode, markdown).  
+  
+While this is not an accurate folder to have this stored in (`.github`),
+it is the closest if we don't want to create a folder for this in the root.  
+  
+The file structure of this folder is as following:  
+
+| File name               | Description                                                                                                                                                                                 |
+|-------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
+| images                  | Folder containing all images used in the descriptions and wiki for advertising. Used not only as a backup, but for hosting them as well, so we do not need to rely on third party websites. |
+| description_markdown.md | Plugin description written in **markdown** syntax. Used by **Modrinth**.                                                                                                                    |
+| description_bbcode.txt  | Plugin description written in **bbcode** syntax. Used by **SpigotMC** and **BuiltByBit**.                                                                                                   |
@@ -0,0 +1,178 @@
+[IMG]https://raw.githubusercontent.com/NEZNAMY/TAB/master/.github/description/images/Section_About.png[/IMG]
+TAB is an all-in-one plugin for displaying information in various places, which aims to outperform all similar plugins in terms of features, compatibility and performance.
+The compact configuration allows you to get the plugin to work the way you want regardless of how simple or complex you want it to be or how experienced you are. The default configuration already contains useful values and examples to give you a better understanding and get you started quickly with instant results. The extensive [URL='https://github.com/NEZNAMY/TAB/wiki']wiki[/URL] answers any of your questions.
+
+[IMG]https://img.shields.io/badge/Release-5.0.5-blue.svg[/IMG]
+[IMG]https://img.shields.io/badge/Minecraft-1.5%20--%201.21.4-blue.svg[/IMG]
+[IMG]https://img.shields.io/badge/Java-8+-blue.svg[/IMG]
+[URL='https://github.com/NEZNAMY/TAB'][IMG]https://img.shields.io/badge/GitHub-Source%20code-yellow.svg[/IMG][/URL]
+[URL='https://github.com/NEZNAMY/TAB/issues'][IMG]https://img.shields.io/github/issues/neznamy/tab?label=Issues[/IMG][/URL]
+[URL='https://github.com/NEZNAMY/TAB/wiki'][IMG]https://img.shields.io/badge/Documentation-Wiki-yellow.svg[/IMG][/URL]
+[CENTER][B][SIZE=7]Discord?[/SIZE][/B][/CENTER]
+Official support by me is no longer provided to free users due to limited time and extreme inefficiency (see [URL='https://github.com/NEZNAMY/TAB?tab=readme-ov-file#provided-services']provided services[/URL] for more info).
+However, you can join this [URL='https://discord.gg/YPqXt63YQj']fresh new community discord[/URL] made by a nice person who promises to help everyone with all plugins, including TAB.
+
+Before you consider requiring assistance, check out the [URL='https://github.com/NEZNAMY/TAB/wiki']wiki[/URL] first. It will answer any questions you may have and is also constantly getting improved.
+
+[CENTER][IMG]https://raw.githubusercontent.com/NEZNAMY/TAB/master/.github/description/images/Section_Features.png[/IMG]
+[IMG]https://raw.githubusercontent.com/NEZNAMY/TAB/master/.github/description/images/Section_HeaderFooter.png[/IMG]
+[IMG]https://raw.githubusercontent.com/NEZNAMY/TAB/master/.github/description/images/Example_HeaderFooter.png[/IMG][/CENTER]
+[LIST]
+[*]Per-world / per-server support
+[*]Per-group / per-player support
+[*]Disable if a specified condition is met
+[/LIST]
+[CENTER][IMG]https://raw.githubusercontent.com/NEZNAMY/TAB/master/.github/description/images/Section_NameTags.png[/IMG]
+[IMG]https://raw.githubusercontent.com/NEZNAMY/TAB/master/.github/description/images/Example_NameTags.png[/IMG][/CENTER]
+[LIST]
+[*]Configurable prefix and suffix
+[*]Per-world / per-server support
+[*]Per-group / per-player support
+[*]Disable if a specified condition is met
+[*]Make nametags completely invisible
+[*]Control collision rule
+[*]Automatic compensation for 1.8.x client sided bug making nametags of invisible players still visible
+[*]Anti-override to prevent other plugins from overriding this one
+[/LIST]
+[IMG]https://raw.githubusercontent.com/NEZNAMY/TAB/master/.github/description/images/Section_Sorting.png[/IMG]
+[CENTER][IMG]https://raw.githubusercontent.com/NEZNAMY/TAB/master/.github/description/images/Example_Sorting.png[/IMG][/CENTER]
+[LIST]
+[*]Sorting by primary permission group
+[*]Sorting by permission nodes
+[*]Sorting by a numeric placeholder from lowest to highest or highest to lowest
+[*]Alphabetically by a placeholder (A-Z or Z-A)
+[*]Sorting by pre-defined placeholder values
+[*]Combination of multiple sorting types
+[*]Enable / disable case-sensitive sorting
+[/LIST]
+[CENTER][IMG]https://raw.githubusercontent.com/NEZNAMY/TAB/master/.github/description/images/Section_TablistFormatting.png[/IMG]
+[IMG]https://raw.githubusercontent.com/NEZNAMY/TAB/master/.github/description/images/Example_TablistFormatting.png[/IMG][/CENTER]
+[LIST]
+[*]Configurable prefix, name and suffix
+[*]Per-world / per-server support
+[*]Per-group / per-player support
+[*]Disable if a specified condition is met
+[*]Anti-override to prevent other plugins from overriding this one
+[/LIST]
+[CENTER][IMG]https://raw.githubusercontent.com/NEZNAMY/TAB/master/.github/description/images/Section_PlayerlistObjective.png[/IMG]
+[IMG]https://raw.githubusercontent.com/NEZNAMY/TAB/master/.github/description/images/Example_PlayerlistObjectiveNumber.png[/IMG]
+[IMG]https://raw.githubusercontent.com/NEZNAMY/TAB/master/.github/description/images/Example_PlayerlistObjectiveHealth.png[/IMG]
+[IMG]https://raw.githubusercontent.com/NEZNAMY/TAB/master/.github/description/images/Example_PlayerlistObjectiveFancy.png[/IMG][/CENTER]
+[LIST]
+[*]Display value of any numeric placeholder or hearts
+[*]Display any text on 1.20.3+
+[*]Disable if a specified condition is met
+[/LIST]
+[CENTER][IMG]https://raw.githubusercontent.com/NEZNAMY/TAB/master/.github/description/images/Section_Belowname.png[/IMG]
+[IMG]https://raw.githubusercontent.com/NEZNAMY/TAB/master/.github/description/images/Example_BelownameComparison.png[/IMG][/CENTER]
+[LIST]
+[*]Display value of any numeric placeholder (<1.20.3) or any text (1.20.3+)
+[*]Configurable text
+[*]Disable if a specified condition is met
+[/LIST]
+[CENTER][IMG]https://raw.githubusercontent.com/NEZNAMY/TAB/master/.github/description/images/Section_Bossbar.png[/IMG]
+[IMG]https://raw.githubusercontent.com/NEZNAMY/TAB/master/.github/description/images/Example_BossBar.png[/IMG][/CENTER]
+[LIST]
+[*]Configurable text, progress, color and style
+[*]Define display condition to see a bossbar
+[*]Announce defined bossbar for specified amount of time
+[*]Configurable toggle command and message
+[*]Option to remember toggle choice between logins
+[/LIST]
+[CENTER][IMG]https://raw.githubusercontent.com/NEZNAMY/TAB/master/.github/description/images/Section_GlobalPlayerlist.png[/IMG][/CENTER]
+[LIST]
+[*]Display players from all servers on a proxy network in tablist
+[*]Configurable server groups to share playerlist instead of with all servers
+[*]Ability to create isolated servers
+[*]Servers where people will see everyone
+[*]Compatible with vanish plugins
+[*]Option to display players from other servers as spectators
+[/LIST]
+[CENTER][IMG]https://raw.githubusercontent.com/NEZNAMY/TAB/master/.github/description/images/Section_Layout.png[/IMG]
+[IMG]https://raw.githubusercontent.com/NEZNAMY/TAB/master/.github/description/images/Example_Layout.png[/IMG][/CENTER]
+[LIST]
+[*]Customize all 80 tablist slots
+[*]Create static slots with any text and skin
+[*]Create player groups based on conditions
+[*]Multiple layouts based on conditions
+[/LIST]
+[CENTER][IMG]https://raw.githubusercontent.com/NEZNAMY/TAB/master/.github/description/images/Section_Scoreboard.png[/IMG]
+[IMG]https://raw.githubusercontent.com/NEZNAMY/TAB/master/.github/description/images/Example_ScoreboardComparison.png[/IMG][/CENTER]
+[LIST]
+[*]Display up to 15 lines
+[*]Option to show 0 (or any other static number) in every line instead of 1-15
+[*]Fully configurable text on right side of lines on 1.20.3+
+[*]Displaying different scoreboards based on conditions (output of placeholder, permissions)
+[*]Up to 64 characters per line for <1.13, unlimited for 1.13+ clients
+[*]Customizable toggle command and message
+[*]Option to remember toggle choice between logins
+[*]Automatic detection of scoreboards from other plugins to hide own and show it again once other plugin hides its scoreboard
+[/LIST]
+[CENTER][IMG]https://raw.githubusercontent.com/NEZNAMY/TAB/master/.github/description/images/Section_PerWorldPlayerlist.png[/IMG][/CENTER]
+[LIST]
+[*]Only display players from current world in tablist
+[*]Group worlds which should share players
+[*]Worlds where players see everyone
+[*]Option to see all players in all worlds for players with permission
+[/LIST]
+[CENTER][IMG]https://raw.githubusercontent.com/NEZNAMY/TAB/master/.github/description/images/Section_API.png[/IMG][/CENTER]
+[LIST]
+[*]Change player prefix/name/suffix in tablist
+[*]Change header/footer
+[*]Change nametag prefix / suffix
+[*]Change player collision rule and nametag visibility
+[*]Change sorting priority
+[*]Create custom scoreboards, show different scoreboard, toggle scoreboard
+[*]Create custom placeholders
+[*]Create custom boss bars, toggle bossbar visibility, announce bossbar
+[*]... and more!
+[/LIST]
+[LIST]
+[*]Placeholder support
+[LIST]
+[*]Internal placeholders with customizable output
+[*]Create and use custom animations
+[*]All placeholders and animations are supported in all features
+[*]Full PlaceholderAPI support including relational placeholders
+[*]PlaceholderAPI support on BungeeCord
+[/LIST]
+[*]Placeholder output replacements
+[LIST]
+[*]Modify output of any placeholder, including PlaceholderAPI placeholders
+[*]Replace exact text with another text
+[*]Change output if it's in a number interval
+[*]Set value if none of the above is met
+[*]Use original placeholder's output in new one
+[*]Support for nested placeholders
+[*]Can be used in other plugins as well
+[/LIST]
+[*]RGB Support
+[LIST]
+[*]5 supported RGB patterns
+[*]4 supported gradient patterns
+[*]Automatically display closest color to legacy clients
+[*]Configurable color for legacy clients
+[*]Supported in all features [B]where possible[/B]
+[/LIST]
+[*]Conditional placeholders
+[LIST]
+[*]Conditions based on placeholder output (comparing numeric value, exact output)
+[*]Conditions based on permission node
+[*]Combine conditions with AND or OR
+[*]Configurable output of both cases when condition is and isn't met
+[*]Placeholder support in condition output
+[/LIST]
+[*]High performance
+[LIST]
+[*]Full control of CPU usage by optimizing configuration and disabling unwanted features
+[*]Fully asynchronous - no impact on TPS
+[*]Check plugin's CPU usage using /tab cpu
+[/LIST]
+[*]RedisBungee support
+[*]MySQL support
+[*]Fully client-sided, server-side stays unaffected (scoreboards with their teams and objectives, bossbar entities, armor stands)
+[*]Disable vanilla feature making players in spectator gamemode appear on the bottom of tablist
+[*]Possible errors moved into a separate file to not spam your console
+[*]Yaml error assistant for more user-friendly messages and fix suggestions
+[*]Many misconfiguration checks to help solve issues much faster
+[/LIST]
@@ -0,0 +1,165 @@
+![](https://raw.githubusercontent.com/NEZNAMY/TAB/master/.github/description/images/Section_About.png)
+TAB is an all-in-one plugin for displaying information in various places, which aims to outperform all similar plugins in terms of features, compatibility and performance.
+The compact configuration allows you to get the plugin to work the way you want regardless of how simple or complex you want it to be or how experienced you are.
+The default configuration already contains useful values and examples to give you a better understanding and get you started quickly with instant results.
+The extensive [wiki](https://github.com/NEZNAMY/TAB/wiki) answers any of your questions.
+
+![https://img.shields.io/badge/Release-5.0.5-blue.svg](https://img.shields.io/badge/Release-5.0.5-blue.svg)  
+![https://img.shields.io/badge/Minecraft-1.5%20--%201.21.4-blue.svg](https://img.shields.io/badge/Minecraft-1.5%20--%201.21.4-blue.svg)  
+![https://img.shields.io/badge/Java-8+-blue.svg](https://img.shields.io/badge/Java-8+-blue.svg)  
+[![https://img.shields.io/badge/GitHub-Source%20code-yellow.svg](https://img.shields.io/badge/GitHub-Source%20code-yellow.svg)](https://github.com/NEZNAMY/TAB)  
+[![https://img.shields.io/github/issues/neznamy/tab?label=Issues](https://img.shields.io/github/issues/neznamy/tab?label=Issues)](https://github.com/NEZNAMY/TAB/issues)  
+[![https://img.shields.io/badge/Documentation-Wiki-yellow.svg](https://img.shields.io/badge/Documentation-Wiki-yellow.svg)](https://github.com/NEZNAMY/TAB/wiki)
+
+# Discord?
+Official support by me is no longer provided to free users due to limited time and extreme inefficiency (see [provided services]([https://github.com/NEZNAMY/TAB?tab=readme-ov-file#provided-services](https://github.com/NEZNAMY/TAB?tab=readme-ov-file#provided-services)) for more info).
+However, you can join this [fresh new community discord]([https://discord.gg/YPqXt63YQj](https://discord.gg/YPqXt63YQj)) made by a nice person who promises to help everyone with all plugins, including TAB.
+
+Before you consider requiring assistance, check out the [wiki](https://github.com/NEZNAMY/TAB/wiki) first. It will answer any questions you may have and is also constantly getting improved.
+
+![](https://raw.githubusercontent.com/NEZNAMY/TAB/master/.github/description/images/Section_Features.png)
+![](https://raw.githubusercontent.com/NEZNAMY/TAB/master/.github/description/images/Section_HeaderFooter.png)  
+![](https://raw.githubusercontent.com/NEZNAMY/TAB/master/.github/description/images/Example_HeaderFooter.png)
+* Per-world / per-server support
+* Per-group / per-player support
+* Disable if a specified condition is met
+
+![](https://raw.githubusercontent.com/NEZNAMY/TAB/master/.github/description/images/Section_NameTags.png)
+![](https://raw.githubusercontent.com/NEZNAMY/TAB/master/.github/description/images/Example_NameTags.png)
+* Configurable prefix and suffix
+* Per-world / per-server support
+* Per-group / per-player support
+* Disable if a specified condition is met
+* Make nametags completely invisible
+* Control collision rule
+* Automatic compensation for 1.8.x client sided bug making nametags of invisible players still visible
+* Anti-override to prevent other plugins from overriding this one
+
+![](https://raw.githubusercontent.com/NEZNAMY/TAB/master/.github/description/images/Section_Sorting.png)
+![](https://raw.githubusercontent.com/NEZNAMY/TAB/master/.github/description/images/Example_Sorting.png)
+* Sorting by primary permission group
+* Sorting by permission nodes
+* Sorting by a numeric placeholder from lowest to highest or highest to lowest
+* Alphabetically by a placeholder (A-Z or Z-A)
+* Sorting by pre-defined placeholder values
+* Combination of multiple sorting types
+* Enable / disable case-sensitive sorting
+
+![](https://raw.githubusercontent.com/NEZNAMY/TAB/master/.github/description/images/Section_TablistFormatting.png)  
+![](https://raw.githubusercontent.com/NEZNAMY/TAB/master/.github/description/images/Example_TablistFormatting.png)
+* Configurable prefix, name and suffix
+* Per-world / per-server support
+* Per-group / per-player support
+* Disable if a specified condition is met
+* Anti-override to prevent other plugins from overriding this one
+
+![](https://raw.githubusercontent.com/NEZNAMY/TAB/master/.github/description/images/Section_PlayerlistObjective.png)  
+![](https://raw.githubusercontent.com/NEZNAMY/TAB/master/.github/description/images/Example_PlayerlistObjectiveNumber.png)  
+![](https://raw.githubusercontent.com/NEZNAMY/TAB/master/.github/description/images/Example_PlayerlistObjectiveHealth.png)  
+![](https://raw.githubusercontent.com/NEZNAMY/TAB/master/.github/description/images/Example_PlayerlistObjectiveFancy.png)
+* Display value of any numeric placeholder or hearts
+* Display any text on 1.20.3+
+* Disable if a specified condition is met
+
+![](https://raw.githubusercontent.com/NEZNAMY/TAB/master/.github/description/images/Section_Belowname.png)
+![](https://raw.githubusercontent.com/NEZNAMY/TAB/master/.github/description/images/Example_BelownameComparison.png)
+* Display value of any numeric placeholder (<1.20.3) or any text (1.20.3+)
+* Configurable text
+* Disable if a specified condition is met
+
+![](https://raw.githubusercontent.com/NEZNAMY/TAB/master/.github/description/images/Section_Bossbar.png)  
+![](https://raw.githubusercontent.com/NEZNAMY/TAB/master/.github/description/images/Example_BossBar.png)
+* Configurable text, progress, color and style
+* Define display condition to see a bossbar
+* Announce defined bossbar for specified amount of time
+* Configurable toggle command and message
+* Option to remember toggle choice between logins
+
+![](https://raw.githubusercontent.com/NEZNAMY/TAB/master/.github/description/images/Section_GlobalPlayerlist.png)
+* Display players from all servers on a proxy network in tablist
+* Configurable server groups to share playerlist instead of with all servers
+* Ability to create isolated servers
+* Servers where people will see everyone
+* Compatible with vanish plugins
+* Option to display players from other servers as spectators
+
+![](https://raw.githubusercontent.com/NEZNAMY/TAB/master/.github/description/images/Section_Layout.png)  
+![](https://raw.githubusercontent.com/NEZNAMY/TAB/master/.github/description/images/Example_Layout.png)
+* Customize all 80 tablist slots
+* Create static slots with any text and skin
+* Create player groups based on conditions
+* Multiple layouts based on conditions
+
+![](https://raw.githubusercontent.com/NEZNAMY/TAB/master/.github/description/images/Section_Scoreboard.png)  
+![](https://raw.githubusercontent.com/NEZNAMY/TAB/master/.github/description/images/Example_ScoreboardComparison.png)
+* Display up to 15 lines
+* Option to show 0 (or any other static number) in every line instead of 1-15
+* Fully configurable text on the right side of lines on 1.20.3+
+* Displaying different scoreboards based on conditions (output of placeholder, permissions)
+* Up to 64 characters per line for <1.13, unlimited for 1.13+ clients
+* Customizable toggle command and message
+* Option to remember toggle choice between logins
+* Automatic detection of scoreboards from other plugins to hide own and show it again once the other plugin hides its scoreboard
+
+![](https://raw.githubusercontent.com/NEZNAMY/TAB/master/.github/description/images/Section_PerWorldPlayerlist.png)
+* Only display players from the same world in tablist
+* Group worlds which should share players
+* Worlds where players see everyone
+* Option to see all players in all worlds for players with permission
+
+![](https://raw.githubusercontent.com/NEZNAMY/TAB/master/.github/description/images/Section_API.png)
+* Change player prefix/name/suffix in tablist
+* Change header/footer
+* Change nametag prefix / suffix
+* Change player collision rule and nametag visibility
+* Change sorting priority
+* Create custom scoreboards, show different scoreboard, toggle scoreboard
+* Create custom placeholders
+* Create custom boss bars, toggle bossbar visibility, announce bossbar
+* ... and more!
+
+.  
+.  
+.  
+.  
+.  
+Placeholder support
+* Internal placeholders with customizable output
+* Create and use custom animations
+* All placeholders and animations are supported in all features
+* Full [PlaceholderAPI]('https://www.spigotmc.org/resources/placeholderapi.6245/') support including [relational placeholders]('https://www.spigotmc.org/resources/placeholderapi.6245/update?update=167267')
+* PlaceholderAPI support on BungeeCord / Velocity
+
+Placeholder output replacements
+* Modify output of any placeholder, including PlaceholderAPI placeholders
+* Replace exact text with another text
+* Change output if it's in a number interval
+* Set value if none of the above is met
+* Use original placeholder's output in new one
+* Support for nested placeholders
+* Can be used in other plugins as well
+
+RGB Support
+* 5 supported RGB patterns
+* 3 supported gradient patterns
+* Supported in all features **where possible**
+
+Conditional placeholders
+* Conditions based on placeholder output (comparing numeric value, exact output)
+* Conditions based on permission node
+* Combine conditions with `AND` or `OR`
+* Configurable output of both cases when condition is and isn't met
+* Placeholder support in conditions
+
+High performance
+* Full control of CPU usage by optimizing configuration and disabling unwanted features
+* Fully asynchronous - no impact on TPS
+* Check plugin's CPU usage using /tab cpu
+
+RedisBungee support  
+MySQL support  
+Fully client-sided, server-side stays unaffected  
+Disable vanilla feature making players in spectator gamemode appear on the bottom of tablist  
+Possible errors moved into a separate file to not spam your console  
+Yaml error assistant for more user-friendly messages and fix suggestions    
+Many misconfiguration checks to help solve issues much faster  
@@ -0,0 +1,11 @@
+# About
+This is a backup of the wiki in case anything happened to the repository, so the wiki will not get lost forever. 
+The "Clone this wiki locally" option on GitHub wiki does not actually work (the downloaded file is malformed) and cannot be used to import data from the file (?).
+Since GitHub wiki does not support reading the wiki from source code, every change
+to the wiki must be copied here as well. The wiki is being updated on an almost daily basis for many reasons, including, but not limited to 
+updating compatibility page (especially when new MC versions come out), adding more examples, improving descriptions, fixing mistakes or 
+adding information that was previously missing. This synchronization will be done periodically once a month.
+
+# Hyperlinks
+All hyperlinks used inside the wiki link to other wiki pages using full URLs. As a result, they will all be broken when browsing here.
+This is expected and will not be resolved.
@@ -0,0 +1,46 @@
+## Getting started
+* [Why TAB?](https://github.com/NEZNAMY/TAB/wiki/Why-TAB%3F)
+* [Installation](https://github.com/NEZNAMY/TAB/wiki/Installation)
+* [Commands & Permissions](https://github.com/NEZNAMY/TAB/wiki/Commands-&-Permissions)
+* [Frequently Asked Questions](https://github.com/NEZNAMY/TAB/wiki/Frequently-Asked-Questions)
+* [Compatibility](https://github.com/NEZNAMY/TAB/wiki/Compatibility)
+* [How to assign players into groups](https://github.com/NEZNAMY/TAB/wiki/How-to-assign-players-into-groups)
+* [Known issues](https://github.com/NEZNAMY/TAB/wiki/Known-issues)
+* [TAB-Bridge plugin](https://github.com/NEZNAMY/TAB/wiki/TAB-Bridge)
+
+## Core features
+* [Belowname](https://github.com/NEZNAMY/TAB/wiki/Feature-guide:-Belowname)
+* [Bossbar](https://github.com/NEZNAMY/TAB/wiki/Feature-guide:-Bossbar)
+* [Global playerlist](https://github.com/NEZNAMY/TAB/wiki/Feature-guide:-Global-playerlist)
+* [Header/Footer](https://github.com/NEZNAMY/TAB/wiki/Feature-guide:-Header-&-Footer)
+* [Layout](https://github.com/NEZNAMY/TAB/wiki/Feature-guide:-Layout)
+* [Nametags](https://github.com/NEZNAMY/TAB/wiki/Feature-guide:-Nametags)
+* [Per world playerlist](https://github.com/NEZNAMY/TAB/wiki/Feature-guide:-Per-world-playerlist)
+* [Ping spoof](https://github.com/NEZNAMY/TAB/wiki/Feature-guide:-Ping-Spoof)
+* [Playerlist objective](https://github.com/NEZNAMY/TAB/wiki/Feature-guide:-Playerlist-Objective)
+* [RedisBungee support](https://github.com/NEZNAMY/TAB/wiki/Feature-info:-RedisBungee-support)
+* [Scoreboard](https://github.com/NEZNAMY/TAB/wiki/Feature-guide:-Scoreboard)
+* [Sorting in tablist](https://github.com/NEZNAMY/TAB/wiki/Feature-guide:-Sorting-players-in-tablist)
+* [Spectator fix](https://github.com/NEZNAMY/TAB/wiki/Feature-guide:-Spectator-fix)
+* [Tablist name formatting](https://github.com/NEZNAMY/TAB/wiki/Feature-guide:-Tablist-name-formatting)
+
+## Functions
+* [Animations](https://github.com/NEZNAMY/TAB/wiki/Animations)
+* [Conditional placeholders](https://github.com/NEZNAMY/TAB/wiki/Feature-guide:-Conditional-placeholders)
+* [Error logging](https://github.com/NEZNAMY/TAB/wiki/Error-logging)
+* [MySQL](https://github.com/NEZNAMY/TAB/wiki/MySQL)
+* [Placeholder output replacements](https://github.com/NEZNAMY/TAB/wiki/Feature-guide:-Placeholder-output-replacements)
+* [Placeholders](https://github.com/NEZNAMY/TAB/wiki/Placeholders)
+* [RGB/font usage](https://github.com/NEZNAMY/TAB/wiki/How-to-use-RGB-color-codes)
+
+## Other
+* [Additional information](https://github.com/NEZNAMY/TAB/wiki/Additional-information)
+* [Bedrock compatibility](https://github.com/NEZNAMY/TAB/wiki/Bedrock-compatibility)
+* [Client-sided mechanics](https://github.com/NEZNAMY/TAB/wiki/Client%E2%80%90sided-mechanics)
+* [Developer API](https://github.com/NEZNAMY/TAB/wiki/Developer-API)
+* [How to display name from nickname plugins](https://github.com/NEZNAMY/TAB/wiki/How-to-display-name-from-nickname-plugins)
+* [How to save config in UTF-8 encoding](https://github.com/NEZNAMY/TAB/wiki/How-to-save-the-config-in-UTF8-encoding)
+* [How to set up compatibility with glow plugins](https://github.com/NEZNAMY/TAB/wiki/How-to-make-TAB-compatible-with-glow-plugins)
+* [Mini guides collection](https://github.com/NEZNAMY/TAB/wiki/Mini-guides-collection)
+* [Optimizing plugin's CPU usage](https://github.com/NEZNAMY/TAB/wiki/Optimizing-the-plugin)
+* [Quick PlaceholderAPI startup guide](https://github.com/NEZNAMY/TAB/wiki/Quick-PlaceholderAPI-startup-guide)  
@@ -0,0 +1,107 @@
+# About
+This is a collection of random information about the plugin not necessarily limited to a single feature or function.
+
+# Content
+* [Vanish detection](#vanish-detection)
+* [Async player loading](#async-player-loading)
+* [Scoreboard objective and team naming](#scoreboard-objective-and-team-naming)
+* [Per-version experience](#per-version-experience)
+  * [Detection](#detection)
+  * [Differences](#differences)
+* [Debug config option](#debug-config-option)
+
+# Vanish detection
+Although TAB does not manage vanishing players in any way,
+it checks vanish status for features to be properly compatible.
+At the moment, vanishing detection is used for:
+* `%vanished%` placeholder (used for internal functionality, but can be used to display vanish status if one wants to)
+* `%online%`, `%serveronline%`, `%worldonline%` and `%staffonline%` will not count vanished players
+* [Global playerlist](https://github.com/NEZNAMY/TAB/wiki/Feature-guide:-Global-playerlist) makes vanish plugins unable to remove players on other servers from tablist, vanish check will make TAB remove vanished players.
+* Hide vanished players from [Layout](https://github.com/NEZNAMY/TAB/wiki/Feature-guide:-Layout).
+* Unregister teams of vanished players to players who cannot see them to prevent third party client exploits from seeing vanished players.
+
+Permission `tab.seevanished` allows players to:
+* See vanished players in [Global playerlist](https://github.com/NEZNAMY/TAB/wiki/Feature-guide:-Global-playerlist).
+* See vanished players in [Layout](https://github.com/NEZNAMY/TAB/wiki/Feature-guide:-Layout).
+* Not have teams of vanished players unregistered, which would make them not appear sorted properly and have no nametag prefix/suffix.
+
+For a player to be detected, player has to have `vanished` metadata flag set to `true`.
+Most, (if not all) vanish plugins do this, including, but not limited to CMI,
+Essentials, SuperVanish, PremiumVanish and probably more.
+If TAB is installed on BungeeCord,
+[Bridge](https://github.com/NEZNAMY/TAB/wiki/TAB-Bridge) must be installed on backend servers
+to forward vanish status to the proxy.
+
+Additionally, if PremiumVanish is installed and vanish status of a player changes,
+it is asked if the vanished player can be seen by each player.
+Players who are marked as being able to see that vanished player by PV do not require `tab.seevaninished` permission.
+
+# Async player loading
+To not slow down the server, TAB loads players asynchronously on join.
+As a casual user, this does not impact you, but there are some cases where you'll feel it:
+* Players will not be accessible in the [API](https://github.com/NEZNAMY/TAB/wiki/Developer-API) during PlayerJoinEvent
+* [TAB's PlaceholderAPI expansion](https://github.com/NEZNAMY/TAB/wiki/Placeholders#placeholderapi) will not be accessible during the join process, such as when trying to use it in plugins editing join messages (the exception is `replace_` placeholder, which doesn't directly use any TAB code).
+
+# Scoreboard objective and team naming
+There's a well-known BungeeCord bug that kicks players if a duplicate team or objective is registered.
+This message also shows the name of the objective/team.
+Before reporting this, make sure it actually comes from TAB.
+
+TAB's objective and team naming:
+* Objectives ("Objective ... already exists in this scoreboard")
+  * `TAB-BelowName` for [Belowname](https://github.com/NEZNAMY/TAB/wiki/Feature-guide:-Belowname)
+  * `TAB-Scoreboard` for [Scoreboard](https://github.com/NEZNAMY/TAB/wiki/Feature-guide:-Scoreboard)
+  * `TAB-PlayerList` for [Playerlist objective](https://github.com/NEZNAMY/TAB/wiki/Feature-guide:-Playerlist-Objective)
+* Teams ("Team ... already exists in this scoreboard")
+  * For sidebar scoreboard: `TAB-Sidebar-x` where `x` is a number from 1 to 15+ (for each line)
+  * For players: This is more complicated to use the 16-character limit to the max and heavily depends on configuration. If you are sorting by player names, part of player name will be there. It also often contains random non-alphanumeric symbols. The most reliable way is the team name (almost) always ending with `A` (or `B`, `C` etc. if you tried to sort several players into the same slot).
+
+# Per-version experience
+Minecraft has changed over the years.
+It had some limits removed, some added, some bugs fixed, but also some bugs added.
+TAB adapts code based on player's version for the best possible experience on each minecraft version.
+
+## Detection
+When TAB is installed on a proxy, the proxy's API is used to get player's version.  
+When TAB is installed on a backend server, ViaVersion's API is used to get player's version (as it's the only plugin allowing multiple versions, ProtocolSupport is abandoned).
+
+You can check what version the plugin thinks player has by using any of the following:
+* `/tab parse <player> %player-version%` - Shows version name, if multiple versions share the same protocol, the newer one is returned
+* `/tab parse <player> %player-version-id%` - Returns network id of player's version
+* Set `debug: true` in config and check console messages on player join, it will send a message containing game version ViaVersion API has returned
+
+Player game version detection may fail. Here are a few possible scenarios why:
+* ViaVersion is installed on BungeeCord
+  * And TAB on BungeeCord as well - ViaVersion makes BungeeCord API return version of the backend server player is connected to instead of player's actual version
+  * And TAB is on backend servers - There is no ViaVersion to hook into, therefore, there is no suspicion of player not using server's version and not having a way to verify it
+* ViaVersion API returns `-1` - There is currently no known cause when or why this happens. However, when this happens, TAB prints a console warn notifying this has happened. Plugin will assume player is using the same version as the server in such cases.
+
+When a player's game version is not detected correctly, player's experience will be very limited, see below.
+
+## Differences
+To ensure the best possible experience, TAB is currently checking for player's version to alter its logic in some way.
+If a player's version is not detected correctly, a side effect might occur instead, making the situation worse.
+You will not experience all of these, only those that affect the version difference between the server and client.
+
+| Change of logic                                                                                                                                                                                                                                                                                                               | Negative side effect if version is not detected correctly                                                                                                                                                 |
+|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
+| Disabling [Layout](https://github.com/NEZNAMY/TAB/wiki/Feature-guide:-Layout) for 1.7 players                                                                                                                                                                                                                                 | [Layout](https://github.com/NEZNAMY/TAB/wiki/Feature-guide:-Layout) entries being sent into the tablist of the player, breaking it as the layout is not designed support 1.7                              |
+| use alternate way of sorting [Layout](https://github.com/NEZNAMY/TAB/wiki/Feature-guide:-Layout) entries for 1.19.3 - 1.21.1 as the optimal sorting way cannot be used                                                                                                                                                        | [Layout](https://github.com/NEZNAMY/TAB/wiki/Feature-guide:-Layout) entries being out of order for 1.19.3 - 1.21.1 <br />Layout entries appearing in chat complete for <1.19.3 even if they don't have to |
+| Show 1.9+ bossbar on 1.8 servers for 1.9+ players using ViaVersion API                                                                                                                                                                                                                                                        | No 1.9+ bossbar for 1.9+ players on 1.8 server                                                                                                                                                            |
+| Disabling [Tablist name formatting](https://github.com/NEZNAMY/TAB/wiki/Feature-guide:-Tablist-name-formatting) for 1.7 and lower due to a 16-character limit total to take advantage of the mechanic where nametags are displayed in tablist, which extends the limit to up to 48 characters (16 prefix, 16 name, 16 suffix) | Trying to fit the entire formatting into 16 characters, resulting in massive cutting and nametag feature not working                                                                                      |
+| Play around <1.13 limitations of [Scoreboard](https://github.com/NEZNAMY/TAB/wiki/Feature-guide:-Scoreboard)                                                                                                                                                                                                                  | Scoreboard lines limited to ~26 characters, even for 1.13+ clients <br />Scoreboard lines limited to 14 characters for < 1.13 clients                                                                     |
+| Cutting nametag prefix/suffix to 16 characters for <1.13, but keeping it full for 1.13+                                                                                                                                                                                                                                       | Nametag prefix/suffix being cut to 16 characters, even for 1.13+ clients                                                                                                                                  |
+
+# Debug config option
+You may have noticed `debug: false` in your config.
+Enabling it will unlock extra console messages beyond the usual misconfiguration / errors.
+They give deeper information about what's going on in the plugin in case a more complex issue comes up.
+Currently, it offers the following:
+* Makes plugin print thrown errors into console as well, instead of just errors.log file. They are printed into the console even if the error log reaches the 16MB limit.
+* Sends a message saying how long each feature + total it took to process player join/quit or plugin reload. High values may suggest something is not optimized correctly. Originally added for myself when optimizing, but adding/removing it each time would be too much of a hassle, so it remains as a debug message.
+* Sends a message when plugin detects player name change by a nick plugin. Since lots of things are bound to player names, having players change their name and plugin not detecting it would result in plugin not working correctly them. Therefore, every time a player changes their nickname (or resets it), a message should pop up.
+* Sends a message whenever another plugin sends a scoreboard (such as a mini-game plugin) and TAB hides its own. Then, when that other plugin removes its scoreboard, TAB sends its own back (and sends a console message).
+* Sends a message regarding the bedrock client status of players who join in using Floodgate API. This includes a message if floodgate is not enabled correctly (API instance is null), as well as true/false bedrock status of players.
+* Shows network id of protocol version of players who join when ViaVersion is installed. It should show the version players are actually using. If not, the plugin may not work correctly for those players. This is usually caused by having ViaVersion on proxy and backend.
+* Sends a message whenever a placeholder takes more than 50 milliseconds to retrieve value. If it only happens once, it may be a random hiccup and can be ignored. In case of consistent problems, this may cause plugin overload.
+* On proxy installation, shows how long did Bridge take to answer player join plugin message. This should be below 100ms. If it's continuously significantly higher, it suggests something bad is going on, either bridge being overloaded or the server itself.
@@ -0,0 +1,60 @@
+# Content
+* [Creating an animation](#creating-an-animation)
+* [Using an animation](#using-an-animation)
+* [Tips & Tricks](#tips--tricks)
+* [External tools](#external-tools)
+* [Additional info](#additional-info)
+  * [Additional note 1 - Frame synchronization](#additional-note-1---frame-synchronization)
+
+# Creating an animation
+Animations can be created in **animations.yml** file.  
+To begin, you can copy an already existing animation or directly modify already existing one.  
+Let's take a look at an example:
+```animations:  
+Welcome:  #this is name of the animation
+  change-interval: 400  #this is refresh interval of the animation in milliseconds
+  texts:  #the frames of animation
+    - "&7&lW_"  
+    - "&7&lW_"  
+    - "&7&lWe_"  
+    - "&7&lWel_"  
+    - "&7&lWelc_"  
+    - "&7&lWelco_"  
+    - "&7&lWelcom_"  
+    - "&7&lWelcome_"  
+    - "&7&lWelcome_"  
+    - "&7&lWelcome_"  
+    - "&7&lWelcome_"  
+    - "&7&lWelcom_"  
+    - "&7&lWelco_"  
+    - "&7&lWelc_"  
+    - "&7&lWel_"  
+    - "&7&lWe_"  
+    - "&7&lW_"  
+    - "&7&lW_"
+```
+This is an animation called `Welcome` with `change-interval` of `400` milliseconds, which is 2.5 refreshes per second. `Texts` are the actual frames of animation.
+
+# Using an animation
+To use an animation, use `%animation:<name>%` format.
+In the example above it's `%animation:Welcome%`.
+Animations are supported everywhere.
+That includes header/footer, prefix/suffix, belowname, playerlist objective, bossbar and more.
+
+# Tips & Tricks
+* Animations don't need to be fast. You can use them as a changing text in general.
+* Animations can also be used as a short alias to a long text. You can do this by creating an animation with one frame.
+
+# External tools
+If you want an animation too complicated to be done manually, you can check out these websites:
+* https://www.birdflop.com/resources/animtab/
+* https://starve-l.github.io/tab-animation.html
+* https://srnyx.com/gradient
+
+# Additional info
+## Additional note 1 - Frame synchronization
+All animations start at the same time, which is time of plugin being (re)loaded.
+Thanks to this, all animations with the same number of frames and the same change interval will be synchronized.  
+If you want to synchronize multiple animations with a different change interval and different number of frames,
+you need to make sure `(frame count)*(change interval)` is same for both animations,
+for example one animation with 10 frames and 1000ms and second animation with 2 frames and 5000ms.
@@ -0,0 +1,33 @@
+# Content
+* [Detection](#detection)
+* [Differences](#differences)
+* [Issues with `.` in name](#issues-with--in-name)
+
+# Detection
+For TAB to properly detect player as a bedrock player, floodgate and TAB must be installed on the same server instance.
+If TAB is installed on bukkit and floodgate is on both bungeecord and bukkit,
+make sure [they are connected](https://geysermc.org/wiki/floodgate/setup/?platform=proxy-servers).
+
+To make sure floodgate is configured correctly, you have two options:
+* Set `debug: true` in TAB config and check console output on join/reload. It should say `Floodgate returned bedrock status TRUE for player <player>`.
+* Run `/tab parse <player> %bedrock%`. It should return `true`.
+
+If any of them say `false` for an actual bedrock player, you didn't connect floodgate correctly.
+
+# Differences
+It is a job of plugin allowing bedrock clients to connect (probably Geyser) to correctly translate all packets.
+If you are experiencing an issue on bedrock but not java, it is most likely not an issue in TAB code.
+
+Currently, TAB does check for bedrock clients for:
+* Disabling [Layout](https://github.com/NEZNAMY/TAB/wiki/Feature-guide:-Layout) for bedrock players.
+
+This is the only known change required on the TAB's side.
+
+# Issues with `.` in name
+If you configured Geyser to prefix bedrock player names with `.`, it will mess up config loading,
+because `.` is used to split a section path.
+This means that using `/tab player <playername containing .> ...` will not work.  
+There are three solutions available:
+* Use player UUID if commands are executed via another plugin (`/tab player <uuid> ...`).
+* Use `playeruuid` type, which accepts player name and saves the online player's UUID (`/tab playeruuid <player name> ...`).
+* Use a different username prefix than `.`.
@@ -0,0 +1,20 @@
+# Content
+* [About](#about)
+* [Nametag format in tablist](#nametag-format-in-tablist)
+* [Tablist entry overlap](#tablist-entry-overlap)
+* [Tablist entry widths](#tablist-entry-widths)
+
+# About
+This is a collection of mechanics related to the plugin explaining how does the minecraft client process information from the server and what you can and what you cannot impact.
+
+# Nametag format in tablist
+When disabling [Tablist name formatting](https://github.com/NEZNAMY/TAB/wiki/Feature-guide:-Tablist-name-formatting), nametag prefix/suffix will be displayed in tablist instead. If you don't want any prefixes in tablist, keep the feature enabled but don't set any prefixes. Disabling this option is only useful to allow other plugins to use the feature or to intentionally display teams in tablist.
+
+# Tablist entry overlap
+When having enough online players for 3–4 columns (or using [Layout](https://github.com/NEZNAMY/TAB/wiki/Feature-guide:-Layout)) and their name formats are too long, they might overlap. This is caused by attempting to display text wider than the monitor can handle.  
+There isn't really any ideal solution for this. Here are a few tips that might help:
+* Decrease GUI scale in client options to make text smaller
+* Make tablist entries shorter, such as avoiding using bold text (&l) or using short aliases for ranks instead of their full names (such as `A` instead of `Admin`).
+
+# Tablist entry widths
+All tablist entries are rendered with the same width regardless of their content to match width of the longest text. This is done globally, not on a per-column basis. Therefore, one wide entry with make them all render wide, even if the content is empty. This can be a problem when using [Layout](https://github.com/NEZNAMY/TAB/wiki/Feature-guide:-Layout) to force all 80 slots. Just like in the point above, you need to make the longest entry shorter to have the tablist smaller.
@@ -0,0 +1,144 @@
+# About
+This page lists all the commands and permissions that are available with TAB.
+Commands have required permissions associated with them.
+
+**BungeeCord / Velocity users:**
+* If you have TAB installed **on the proxy**, use **/btab** instead of /tab. Permissions are the same.
+* Permission nodes are checked on the server where the plugin is installed (by default). This means that with TAB on BungeeCord, permission nodes are checked on BungeeCord, and therefore you'll need a permission plugin there as well. If you wish to take permission groups and checks from backend servers instead, set `use-bukkit-permissions-manager: true` in config.
+
+# Content
+* [Configuration](#configuration-commands)
+  * [/tab \<player/group/playeruuid\> \<name\> \<property\> [value] [options]](#tab-playergroupplayeruuid-name-property-value-options)
+  * [/tab \<player/group/playeruuid\> \<name\> remove](#tab-playergroupplayeruuid-name-remove)
+  * [/tab reload](#tab-reload)
+  * [/tab debug [player]](#tab-debug-player)
+  * [/tab group \<group\>](#tab-group-group)
+  * [/tab groups](#tab-groups)
+* [Bossbar](#bossbar)
+  * [/tab bossbar send \<name\> \[player\]](#tab-bossbar-show-name-player)
+  * [/tab bossbar [on/off/toggle] [player] [options]](#tab-bossbar-onofftoggle-player-options)
+  * [/tab bossbar announce \<name\> \<length\>](#tab-bossbar-announce-name-duration)
+* [Scoreboard](#scoreboard)
+  * [/tab scoreboard show \<name\> \[player\]](#tab-scoreboard-show-name-player)
+  * [/tab scoreboard [on/off/toggle] [player] [options]](#tab-scoreboard-onofftoggle-player-options)
+  * [/tab scoreboard announce \<name\> \<length\>](#tab-scoreboard-announce-name-duration)
+* [Nametags / Teams](#nametags--teams)
+  * [/tab nametag toggle](#tab-nametag-toggle)
+  * [/tab setcollision <player> <true/false>](#tab-setcollision-player-truefalse)
+* [MySQL](#mysql)
+  * [/tab mysql upload](#tab-mysql-upload)
+  * [/tab mysql download](#tab-mysql-download)
+* [Other](#other)
+  * [/tab cpu](#tab-cpu)
+  * [/tab parse \<player\> \<placeholder\>](#tab-parse-player-text)
+* [Additional permissions](#additional-permissions)
+
+# Configuration commands
+## /tab \<player/group/playeruuid\> \<name\> \<property\> [value] [options]
+* **Permission:** `tab.change.<property>`
+* **Description:** Changes a property of a group/player to the given value. No value argument will result in that property being deleted.
+
+#### Properties
+* For tablist: `tabprefix`, `customtabname`, and `tabsuffix`.
+* For nametag: `tagprefix` and `tagsuffix`.
+
+#### Options
+* `-s <server>` - Applying value only for a specific server
+* `-w <world>` - Applying value only for a specific world
+
+#### Names for each command type
+* player: Supports both player name and raw uuid. Player doesn't need to be online.
+* playeruuid: Requires name of an online player. Equal to using `player` with player's uuid.
+* group: Using group names from permission plugin. `_DEFAULT_` is used for default settings for all groups.
+
+## /tab \<player/group/playeruuid\> \<name\> remove
+* **Permission:** `tab.remove`
+* **Description:** Removes all direct data from the given player/group.
+
+#### Notes
+* The `playeruuid` argument requires the name of an **online player** to remove data from.
+
+## /tab reload
+* **Permission:** `tab.reload`
+* **Description:** Unloads the plugin, loads configuration files including changes and loads the plugin.
+
+## /tab debug [player]
+* **Permission:** `tab.debug`
+* **Description:** Shows the server version, plugin version, permission group choice logic, and sorting type. If player argument is filled, shows info about that player:
+  * On BungeeCord, shows whether player is connected to the backend server with [Bridge](https://github.com/NEZNAMY/TAB/wiki/TAB-Bridge) plugin or not.
+  * Sorting value & explanation, useful to see what went wrong if players are not sorted correctly.
+  * Primary group set using [How to assign players into groups](https://github.com/NEZNAMY/TAB/wiki/How-to-assign-players-into-groups)
+  * List of all configured properties, their values and source.
+
+## /tab group \<group\>
+* **Permission:** `tab.groupinfo`
+* **Description:** Shows all settings applied to the specified group, both global and per-world / per-server. Handy when plugin is connected to MySQL, where you have no other way to effectively check group settings.
+
+## /tab groups
+* **Permission:** `tab.grouplist`
+* **Description:** Shows a list of all groups that have anything assigned to them, either globally or per-world / per-server. Handy when plugin is connected to MySQL, where you have no other way to effectively check your groups.
+
+# Scoreboard
+## /tab scoreboard show \<name\> \[player\]
+* **Permission:** `tab.scoreboard.show` for showing to yourself, `tab.scoreboard.show.other` for showing to others.
+* **Description:** Shows the scoreboard with the given `name`, either to yourself if no `player` was given, or to the given `player`.
+
+## /tab scoreboard [on/off/toggle] [player] [options]
+* **Permission:** `tab.scoreboard.toggle` for toggling for yourself, `tab.scoreboard.toggle.other` for toggling for others.
+* **Description:** Shows / hides / toggles scoreboard of specified player. If no player was given, command affects the sender.
+* **Options:**
+  * `-s` for silent toggling (no chat message for affected player)
+
+## /tab scoreboard announce \<name\> \<duration\>
+* **Permission:** `tab.announce.scoreboard`
+* **Description:** Shows the scoreboard with the given `name` to every player on the server for the given `duration`, in seconds.
+
+# Bossbar
+## /tab bossbar show \<name\> \[player\]
+* **Permission:** `tab.bossbar.show` for showing to yourself, `tab.bossbar.show.other` for showing to others.
+* **Description:** Shows the bossbar with the given `name`, either to yourself if no `player` was given, or to the given `player`.
+
+## /tab bossbar [on/off/toggle] [player] [options]
+* **Permission:** `tab.bossbar.toggle` for toggling for yourself, `tab.bossbar.toggle.other` for toggling for others.
+* **Description:** Shows / hides / toggles bossbar of specified player. If no player was given, command affects the sender.
+* **Options:**
+  * `-s` for silent toggling (no chat message for affected player)
+
+## /tab bossbar announce \<name\> \<duration\>
+* **Permission:** `tab.announce.bar`
+* **Description:** Shows the bossbar with the given `name` to every player on the server for the given `duration`, in seconds.
+
+# Nametags / Teams
+## /tab nametag toggle
+* **Permission:** `tab.nametag.toggle`
+* **Description:** Toggles nametag visibility on all players for player who ran the command. Running the command again will make nametags visible again.
+
+## /tab setcollision \<player\> \<true|false\>
+* **Permission:** `tab.setcollision`
+* **Description:** Forces collision rule for specified player, overriding configuration.
+
+# MySQL
+## /tab mysql upload
+* **Permission:** `tab.mysql.upload`
+* **Description:** Uploads all data from users.yml and groups.yml to MySQL. MySQL must be enabled and connected for this command to work.
+
+## /tab mysql download
+* **Permission:** `tab.mysql.download`
+* **Description:** Downloads all data to users.yml and groups.yml from MySQL. MySQL must be enabled and connected for this command to work.
+
+# Other
+## /tab cpu
+* **Permission:** `tab.cpu`
+* **Description:** Shows approximate CPU usage of the plugin from the last 10 seconds. There are parts that are impossible to be measured, so this shows slightly less than the real value is. The content is self-explanatory. All major ways to decrease CPU usage can be found at [Optimizing the plugin](https://github.com/NEZNAMY/TAB/wiki/Optimizing-the-plugin).
+
+## /tab parse \<player\> \<text\>
+* **Permission:** `tab.parse`
+* **Description:** Replaces all placeholders (both the plugin's internal ones, and those from PlaceholderAPI if it is installed) in the given `text`. It can be used to verify if a placeholder works as expected.
+
+# Additional permissions
+* `tab.admin` - Allows the player to execute all commands.
+* `tab.bypass` - If the per-world player list is enabled as well as this permission, it allows the player to see everyone on the server, regardless of what the per-world player list settings allow. For example, if your per-world player list is set up to isolate worlds A and B, players with this permission will see all players from both A and B on their player list, whereas players that don't have the permission will only see either players from world A or players from world B, depending on what world they are in.
+* `tab.staff` - Allows the player to be counted in the `%staffonline%` placeholder.
+* `tab.spectatorbypass` - If enabling bypass permission in [Spectator fix](https://github.com/NEZNAMY/TAB/wiki/Feature-guide:-Spectator-fix), this is the permission.
+* `tab.tabcomplete` - Allows the player to auto-complete the `/tab` command.
+* `tab.seevanished` - Allows the player to see other vanished players on the [Global Playerlist](https://github.com/NEZNAMY/TAB/wiki/Feature-guide:-Global-playerlist) and [Layout](https://github.com/NEZNAMY/TAB/wiki/Feature-guide:-Layout).  
@@ -0,0 +1,144 @@
+# Content
+* [Requirements](#requirements)
+* [Supported server software and versions](#supported-server-software-and-versions)
+* [Supported features per platform](#supported-features-per-platform)
+* [Plugin hooks](#plugin-hooks)
+  * [All platforms](#all-platforms)
+  * [Bukkit](#bukkit)
+  * [BungeeCord](#bungeecord)
+  * [Fabric](#fabric)
+  * [Sponge](#sponge)
+  * [Velocity](#velocity)
+* [Compatibility issues](#compatibility-issues)
+
+# Requirements
+TAB does not depend on any other plugins.  
+It is compiled with Java 8 and therefore supports any version of 8 and above.
+
+# Supported server software and versions
+<table>
+    <thead>
+        <tr>
+            <th>Software type</th>
+            <th>Software name</th>
+            <th>Supported versions</th>
+        </tr>
+    </thead>
+    <tbody>
+        <tr>
+            <td rowspan=2>Vanilla</td>
+            <td rowspan=1><a href="https://getbukkit.org/">Bukkit</a> (+forge hybrids)</td>
+            <td>✔ (1.5 - 1.21.4)</td>
+        </tr>
+        <tr>
+            <td rowspan=1><a href="https://www.spongepowered.org/">Sponge</a></td>
+            <td>✔ (1.9<sup>1</sup> - 1.21.4)</td>
+        </tr>
+    </tbody>
+    <tbody>
+        <tr>
+            <td rowspan=2>Modded</td>
+            <td rowspan=1><a href="https://fabricmc.net">Fabric</a></td>
+            <td>✔ (1.14 - 1.21.4)</td>
+        </tr>
+        <tr>
+            <td rowspan=1><a href="https://minecraftforge.net">Forge</a></td>
+            <td>❌</td>
+        </tr>
+    </tbody>
+    <tbody>
+        <tr>
+            <td rowspan=2>Proxies</td>
+            <td rowspan=1><a href="https://ci.md-5.net/job/BungeeCord/">BungeeCord</a></td>
+            <td>✔ (latest only<sup>2</sup>)</td>
+        </tr>
+        <tr>
+            <td rowspan=1><a href="https://www.velocitypowered.com/">Velocity</a></td>
+            <td>✔ (latest only<sup>2</sup>)</td>
+        </tr>
+    </tbody>
+</table>
+<sup>1</sup> Due to a bug in Sponge 7, it cannot coexist in the same jar with classes compiled with Java higher than 8, which is required by some other platforms. To get the plugin to run on Sponge 7, you will need to do one of the following:  
+
+* Compile the plugin yourself and use the jar from `sponge7/build/libs`, which only contains sponge support instead of the universal jar from `jar/build/libs`.
+* Unzip the plugin jar, go to `me/neznamy/tab/platforms/` and delete everything except `sponge7`.
+
+<sup>2</sup> Latest only doesn't mean only the latest build will work,
+it means the plugin was made to be compatible with the latest version/build.
+Since breaking changes don't happen too often, it means a wide range of versions is usually supported.
+When a breaking change occurs, the plugin is updated to support the new version,
+automatically making old versions incompatible.
+Since proxies support all client versions, there is never a reason to stay outdated,
+so you can always safely update to new version/build of your proxy software if the plugin requires it.
+
+# Supported features per platform
+| Feature \ Platform | Bukkit / Hybrid | Sponge | Fabric | BungeeCord | Velocity |
+| ------------- | ------------- | ------------- | ------------- | ------------- | ------------- |
+| [Belowname](https://github.com/NEZNAMY/TAB/wiki/Feature-guide:-Belowname) | ✔ | ✔ | ✔ | ✔ | ✔ (via [VSAPI](https://github.com/NEZNAMY/VelocityScoreboardAPI/releases)) |
+| [BossBar](https://github.com/NEZNAMY/TAB/wiki/Feature-guide:-Bossbar) | ✔ | ✔ | ✔ | ✔ | ✔ |
+| [Global Playerlist](https://github.com/NEZNAMY/TAB/wiki/Feature-guide:-Global-playerlist) | ❌ | ❌ | ❌ | ✔ | ✔ |
+| [Header/Footer](https://github.com/NEZNAMY/TAB/wiki/Feature-guide:-Header-&-Footer) | ✔ | ✔ | ✔ | ✔ | ✔ |
+| [Layout](https://github.com/NEZNAMY/TAB/wiki/Feature-guide:-Layout) | ✔ | ✔ | ✔ | ✔ | ✔ |
+| [Nametags](https://github.com/NEZNAMY/TAB/wiki/Feature-guide:-Nametags) & [Sorting](https://github.com/NEZNAMY/TAB/wiki/Feature-guide:-Sorting-players-in-tablist) | ✔ |  ❗ | ✔ | ✔ | ✔ (via [VSAPI](https://github.com/NEZNAMY/VelocityScoreboardAPI/releases)) |
+| [Per world playerlist](https://github.com/NEZNAMY/TAB/wiki/Feature-guide:-Per-world-playerlist) | ✔ | ❌ | ❌ | ❌ | ❌ |
+| [Playerlist objective](https://github.com/NEZNAMY/TAB/wiki/Feature-guide:-Playerlist-Objective) | ✔ | ✔ | ✔ | ✔ | ✔ (via [VSAPI](https://github.com/NEZNAMY/VelocityScoreboardAPI/releases)) |
+| [Scoreboard](https://github.com/NEZNAMY/TAB/wiki/Feature-guide:-Scoreboard) | ✔ | ❗ | ✔ | ✔ | ✔ (via [VSAPI](https://github.com/NEZNAMY/VelocityScoreboardAPI/releases)) |
+| [Spectator fix](https://github.com/NEZNAMY/TAB/wiki/Feature-guide:-Spectator-fix) | ✔ | ✔ | ✔ | ✔ | ✔ |
+| [Tablist names](https://github.com/NEZNAMY/TAB/wiki/Feature-guide:-Tablist-name-formatting) | ✔ | ✔ | ✔ | ✔ | ✔ |
+
+✔ = Fully functional  
+ ❗ = NameTags: Anti-override missing, Scoreboard: [compatibility with other plugins](https://github.com/NEZNAMY/TAB/wiki/Feature-guide:-Scoreboard#compatibility-with-other-plugins) missing.  
+❌ = Completely missing
+
+# Plugin hooks
+To enhance user experience, TAB hooks into other plugins for better experience.
+This set of plugins is different for each platform based on their availability.
+Some are available on all platforms, some only in a few.
+## All platforms
+[**Floodgate**](https://github.com/GeyserMC/Floodgate) - For properly detecting bedrock players to adapt features for the best possible user experience.  
+[**LuckPerms**](https://github.com/LuckPerms/LuckPerms) - Detecting permission groups of players for per-group settings.  
+[**ViaVersion**](https://github.com/ViaVersion/ViaVersion) - For properly detecting player's version to adapt features for the best possible user experience.
+
+## Bukkit
+[**LibsDisguises**](https://github.com/libraryaddict/LibsDisguises) - Detecting disguised players to disable collision to avoid endless push by colliding with own copy created by LibsDisguises.  
+[**PlaceholderAPI**](https://github.com/PlaceholderAPI/PlaceholderAPI) - Allows users to use its placeholders inside TAB.  
+[**PremiumVanish**](https://www.spigotmc.org/resources/14404) - Supporting PremiumVanish's vanishing levels instead of using a basic compatibility system.  
+[**Vault**](https://github.com/milkbowl/Vault) - Detecting permission groups of players for per-group settings.
+
+## BungeeCord
+[**PremiumVanish**](https://www.spigotmc.org/resources/14404) -
+Supporting PremiumVanish's vanishing levels instead of using a basic compatibility system.  
+[**RedisBungee**](https://github.com/ProxioDev/RedisBungee) -
+Communicating with other proxies to properly display visuals on players on another proxy.
+
+## Fabric
+[**fabric-permissions-api**](https://github.com/lucko/fabric-permissions-api) - Supporting permission nodes instead of OP levels.
+
+## Sponge
+*None*
+
+## Velocity
+[**PremiumVanish**](https://www.spigotmc.org/resources/14404) -
+Supporting PremiumVanish's vanishing levels instead of using a basic compatibility system.  
+[**RedisBungee**](https://github.com/ProxioDev/RedisBungee) -
+Communicating with other proxies to properly display visuals on players on another proxy.  
+[**VelocityScoreboardAPI**](https://github.com/NEZNAMY/VelocityScoreboardAPI) -
+Sending scoreboard packets (scoreboard-teams, belowname-objective, playerlist-objective, scoreboard)
+
+# Compatibility issues
+* **Glow plugins** will fail to apply glow color correctly. Check [How to make the plugin compatible with glow plugins](https://github.com/NEZNAMY/TAB/wiki/How-to-make-TAB-compatible-with-glow-plugins) for more information.
+* **[Tablisknu](https://forums.skunity.com/resources/tablisknu.727/)** (skript addon) prevents TAB from assigning teams (sorting & nametags).
+* **SkBee** (skript addon) sends empty scoreboard, causing TAB's to not show sometimes.
+* **Waterfall**'s `disable_tab_list_rewrite: true` **may** cause tablist to use offline UUIDs while TAB expects online uuids, causing various problems (most notably tablist formatting not working). Checking for this option is not an option either, because tablist rewrite might still be enabled despite being disabled (don't ask how, I have no idea). Set the option to `false` if you are experiencing issues.
+* **ViaVersion on BungeeCord and TAB on backend** acts like a client-sided protocol hack, making it impossible for TAB to know player's real version and causing issues related to it, see [Per-version experience](https://github.com/NEZNAMY/TAB/wiki/Additional-information#per-version-experience) for more info. Avoid this combination. Either install ViaVersion on all backend servers instead or install TAB on BungeeCord instead.
+* **ViaVersion**'s `hide-scoreboard-numbers` config option makes [Belowname](https://github.com/NEZNAMY/TAB/wiki/Feature-guide:-Belowname)'s `value` and [Playerlist objective](https://github.com/NEZNAMY/TAB/wiki/Feature-guide:-Playerlist-Objective)'s `value` not visible for 1.20.3+ clients on <1.20.3 server when enabled. When using this setup, you'll need to keep the option disabled (sadly scoreboard numbers will not be hidden, solving this would require an implementation on ViaVersion's side).
+* **Custom clients / resource packs** - Unofficially modified minecraft clients often tend to break things. Just Lunar client has tons of bugs that can be reproduced with TAB. Resource packs may also contain modifications you are not aware of, making things not look the way you want them to. If you are experiencing any visual issue and are using a custom client or resource pack, try it with a clean vanilla client. If it works there, it's an issue with the client / resource pack and TAB cannot do anything about it.  
+  For example, here are a few bugs in LunarClient / FeatherClient that you may run into when using TAB:
+  * They add their icon to players in tablist, but don't widen the entries. This results in player names overlapping with latency bar. You can avoid this by configuring some spaces in tabsuffix.
+  * They don't support color field in chat components, which means they don't support RGB codes and will display bossbar without colors as well.
+  * Bossbar is not visible on 1.8.
+  * Rendering belowname 3 times.
+  * They don't respect nametag visibility rule, showing their own nametag using F5 even if set to invisible by the plugin.
+  * When the scoreboard is set to use all 0s, lines are rendered in opposite order on 1.20.3+.
+  * They don't display 1.20.3+ NumberFormat feature in scoreboard objectives.
+* **Random Spigot/BungeeCord forks** - All safe patches for improving security & performance are present in well-known public opensource projects, such as Paper, Purpur or Waterfall. Using a random overpriced closed-source (and probably obfuscated) fork from BuiltByBit may not be safe, since they likely include unsafe patches that may break compatibility with plugins in an attempt to fix things that are not broken. Before spending your entire budget on such a fork, reconsider it first. Paper (and its forks) is a performance-oriented fork used by 2/3 of all MC servers worldwide, while the rest is still stuck on Spigot. It is highly unlikely your needs are so specific you need every single "improvement" anyone can come up with. If you need a feature, Purpur is a feature-oriented fork. Together with plugins you should achieve what you are looking for.
@@ -0,0 +1,97 @@
+# Page content
+* [Adding the dependency](#adding-the-dependency)
+* [Getting started](#getting-started)
+* [Lifespan of API calls](#lifespan-of-api-calls)
+* [Events](#Events)
+
+# External Content
+* [BossBar](https://github.com/NEZNAMY/TAB/wiki/Feature-guide:-Bossbar#api)
+* [Header/Footer](https://github.com/NEZNAMY/TAB/wiki/Feature-guide:-Header-&-Footer#api)
+* [Nametags](https://github.com/NEZNAMY/TAB/wiki/Feature-guide:-Nametags#api)
+* [Scoreboard](https://github.com/NEZNAMY/TAB/wiki/Feature-guide:-Scoreboard#api)
+* [Sorting](https://github.com/NEZNAMY/TAB/wiki/Feature-guide:-Sorting-players-in-tablist#api)
+* [Tablist name formatting](https://github.com/NEZNAMY/TAB/wiki/Feature-guide:-Tablist-name-formatting#api)
+* [Placeholders](https://github.com/NEZNAMY/TAB/wiki/Placeholders#api)
+
+# Adding the dependency
+
+For Maven users, you can add the API dependency like this:
+
+```xml
+<repository>
+    <id>jitpack.io</id>
+    <url>https://jitpack.io</url>
+</repository>
+
+<dependency>
+    <groupId>com.github.NEZNAMY</groupId>
+    <artifactId>TAB-API</artifactId>
+    <version>5.0.5</version>
+    <scope>provided</scope>
+</dependency>
+ ```
+
+Or, for Gradle users, here are a few examples:
+
+Groovy:
+```groovy
+repositories {
+    maven { url 'https://jitpack.io' }
+}
+
+dependencies {
+    compileOnly 'com.github.NEZNAMY:TAB-API:5.0.5'
+}
+```
+
+Kotlin:
+```kotlin
+repositories {
+    maven("https://jitpack.io")
+}
+
+dependencies {
+    compileOnly("com.github.NEZNAMY", "TAB-API", "5.0.5")
+}
+```
+
+**WARNING: DO NOT SHADE THE API IN TO YOUR JAR! DO NOT RELOCATE THE API FROM ITS ORIGINAL PACKAGE!**
+
+If you relocate, the API that you are calling will also get relocated in your code, meaning that you will be trying to call the relocated API. If you shade the API in, your code could load that bundled API, causing class path conflicts.
+Ensure that you are using **`<scope>provided</scope>` for Maven**, or **`compileOnly` for Gradle**.
+
+# Getting started
+First, you need to get an instance of the API.
+You can do this with `TabAPI.getInstance()`.  
+The `TabAPI` class that you want to import is located in the `me.neznamy.tab.api` package.
+If you do not see this imported,
+or it is imported but the package is not `me.neznamy.tab.api`, then you have the **wrong class**.
+
+Now you have the instance, you can get a `TabPlayer` with the methods `getPlayer(UUID)` and `getPlayer(String)`, to get players by UUID and name respectively.  
+If no player was found with the UUID or the name that you gave, these methods will return `null`. It is important that you catch this, to avoid running in to a `NullPointerException`. You should **NOT** assume that just because a player has logged in that TAB will already have a player for them, as players are processed asynchronously. This will be especially true for join events like `PlayerJoinEvent`.
+
+If you want to be 100% sure that the player you want is loaded when you want to process them, use `PlayerLoadEvent`.
+This will give you the `TabPlayer` that has been loaded, so that you can process that `TabPlayer`.
+See below for more details on how to use the event.
+
+# Lifespan of API calls
+All API calls result in temporary changes to the plugin's logic.
+When the plugin is reloaded or server restarted, all previous API calls will lose effect.
+This also applies for players after they reconnect—they are reset back.
+If you want to perform long-term changes to player's prefix or suffix,
+call TAB's [commands](https://github.com/NEZNAMY/TAB/wiki/Commands-&-Permissions) from your plugin.  
+If you want to re-apply your changes on plugin reload, listen to [events](#events) using plugin's own event system,
+specifically `TabLoadEvent`, which is called on plugin reload.
+
+# Events
+TAB is using a custom platform-independent event API. As such, the same event listener code will work on all supported platforms. Usage is also different, let's take a look at an example:
+```
+TabAPI.getInstance().getEventBus().register(PlayerLoadEvent.class, event -> {
+    TabPlayer tabPlayer = event.getPlayer();
+    //do something
+});
+```
+TAB plugin provides the following events:
+* `TabLoadEvent` - Called when the plugin has finished its load, either on startup or plugin reload.
+* `PlayerLoadEvent` - Called when the plugin has finished loading a player (either join or plugin reload).
+* `PlaceholderRegisterEvent` - Called when the plugin is about to register a parser for used PlaceholderAPI placeholder, allowing to override it.
@@ -0,0 +1,52 @@
+# Content
+* [About](#about)
+* [errors.log](#errorslog)
+* [placeholder-errors.log](#placeholder-errorslog)
+* [anti-override.log](#anti-overridelog)
+
+# About
+TAB logs various events in multiple files to keep the console clean.
+All of these notifications are negative, so they should be looked at.
+
+Files are only created when something is about to get logged.
+This means if you have none of these files in your folder, everything is good.
+It is safe to delete the logs any time while the server is running without needing to reload the plugin or anything.
+
+All files have their sizes limited to 16 MB to avoid giant files consisting of the same error repeating over and over.
+Remember these files are **logs**; therefore, after solving the problems you must delete them.
+These files will not delete themselves.  
+After deleting a file, there is no need to perform any other action.
+Every time an error is about to be logged, the file is created if it doesn't exist.
+
+Java errors usually contain stack traces.
+If you got an error spamming with an error message but no stack trace,
+the most common cause is java not including it because too many errors were thrown already.
+To bypass this check, add `-XX:-OmitStackTraceInFastThrow` to your startup parameters.
+
+# errors.log
+No one likes having their console spammed with errors.
+Fixing errors is the most reliable solution, however, that takes time,
+and you usually don't get an update fixing an error the second you report it.
+Because of that, all plugin errors are moved to this file instead.
+
+# placeholder-errors.log
+This file is used
+to track errors thrown by PlaceholderAPI expansions when trying to retrieve the value of a placeholder.
+These should be reported to the expansion author.
+First line(s) of error should give you a good idea which expansion it is,
+as well as the actual placeholder which threw the error
+(displayed on top of the error).
+
+# anti-override.log
+This file logs all attempts of other plugins to override TAB's visuals.
+This is checking for features that only a single plugin can be displaying info in at once
+(such as nametag prefix/suffix, tablist prefix/suffix).
+This means that (at least) one of your plugins is not configured correctly,
+and you didn't disable functions you don't want.
+If you want TAB to use a feature, disable it in other plugins.
+If you want a different plugin to display it, disable it in TAB (disabled features do not log this).
+
+It is unfortunately not possible to easily figure out which plugin is causing it, you can only guess from the message.
+
+Although this is technically unnecessary since TAB automatically blocks other plugins from overriding it,
+it's good to have your plugins configured properly.  
@@ -0,0 +1,161 @@
+# Content
+* [About](#about)
+* [Configuration](#configuration)
+* [Additional info](#additional-info)
+  * [Additional note 1 - Copying nametag visibility rule](#additional-note-1---copying-nametag-visibility-rule)
+  * [Additional note 2 - Hidden on sneak on 1.8](#additional-note-2---hidden-on-sneak-on-18)
+  * [Additional note 3 - Visible on NPCs](#additional-note-3---visible-on-npcs)
+* [Tips & Tricks](#tips--tricks)
+  * [Tip 1 - Heart symbol](#tip-1---heart-symbol)
+  * [Tip 2 - Displaying health as 0-10 or in %](#tip-2---displaying-health-as-0-10-or-in-)
+* [Limitations](#limitations)
+* [Examples](#examples)
+  * [Example 1 - Per-world values](#example-1---per-world-values)
+  * [Example 2 - Hiding `title` for 1.20.3+ players](#example-2---hiding-title-for-1203-players)
+
+# About
+The scoreboard objective with BELOW_NAME display slot that adds another line of text below nametag of players.
+It is only visible on players within 8-block range.
+This value is client sided and cannot be changed by the plugin.  
+![](https://images-ext-1.discordapp.net/external/YlGPCRDJVeZZI0TPWmVBKyHszxSkjatmclyqUThvTz8/https/image.prntscr.com/image/jcETUzVQQYqectQ2aI4iqQ.png)
+
+This line automatically appears on all player entities when enabled. **Therefore, it is not possible to only display it on some players or not display it on NPCs**.
+
+The feature can be configured in **config.yml** under **belowname-objective** section.
+
+The feature's properties are displayed as `[score]` + space + `title` (no, the space cannot be removed), where `[score]` is:
+* `value` for 1.20.2- (will show `0` on NPCs)
+* `fancy-value` for 1.20.3+ (will show `fancy-value-default` on NPCs)
+
+# Configuration
+| Option name         | Default value         | Description                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    |
+|---------------------|-----------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
+| enabled             | true                  | Enables / Disables the feature                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                 |
+| value               | %health%              | [1.20.2-] An integer from -2147483648 to 2147483647, doesn't support decimal values. The number is always white. Supports placeholders with player-specific output, such as player health. Only visible on 1.20.2 and lower. <br/> **Note**: Even if you only support 1.20.3+, you still need to configure this value to properly evaluate to a number, because the value is still sent to the client (just not displayed). You can set it to `0` for simplicity.                                                              |
+| fancy-value         | &c%health%            | [1.20.3+] Any text, supports placeholders with per-player output. Only visible on 1.20.3+.                                                                                                                                                                                                                                                                                                                                                                                                                                     |
+| fancy-value-default | NPC                   | [1.20.3+] Default display for all player entities. Plugin uses the value above for every real player, therefore this default value will only appear on player entities which are not actual players, a.k.a. NPCs. Only visible on 1.20.3+.                                                                                                                                                                                                                                                                                     |
+| title               | Health                | Text displayed after `value`. It is formally called scoreboard title, which is displayed on all player entities and value is shared on all players and therefore not bound to specific players, which makes it unable to display the value per-player. It should only contain static text or placeholders which return same value for all players. All inserted placeholders are parsed for the player viewing the text. This is intentional to allow advanced configuration with conditions for per-world values for example. |
+| disable-condition   | %world%=disabledworld | A [condition](https://github.com/NEZNAMY/TAB/wiki/Feature-guide:-Conditional-placeholders) that must be met for disabling the feature for players. Set to empty for not disabling the feature ever.                                                                                                                                                                                                                                                                                                                            |
+
+# Additional Info
+## Additional note 1 - Copying nametag visibility rule
+The minecraft feature is programmed to be affected by nametag visibility rule.
+This means that when the nametag is set to invisible, belowname will be invisible as well.
+
+## Additional note 2 - Hidden on sneak on 1.8
+Belowname is not visible on 1.8.x clients when player is sneaking. This is client-sided behavior and cannot be changed by the server.
+
+## Additional note 3 - Visible on NPCs
+Belowname objective is automatically attached to all entities of player type with the default value of
+`0` (<1.20.3) or value configured as `fancy-value-default` (1.20.3+).
+This includes player NPCs.
+
+There is currently only one way to make them not visible on NPCs.
+From [Additional note 1 - Copying nametag visibility rule](#additional-note-1---copying-nametag-visibility-rule) we know
+that belowname is not visible if player's nametag is invisible.
+NPC plugin can take advantage of this by using teams to hide the original name and display a hologram instead.
+
+This is how you can achieve it using the following popular NPC plugins:
+* **Citizens**:
+  * 1 - Select the NPC (`/npc select <ID>` or `/npc select` to select the nearest NPC)
+  * 2 - Hide its original nametag (which also hides belowname) using `/npc name`
+  * 3 - Display your desired text using `/npc hologram add <text>` ([more info](https://wiki.citizensnpcs.co/Commands#:~:text=the%20NPC%20hitbox-,/npc%20hologram,-add%20%5Btext%5D%20%7C%20set))
+
+# Tips & Tricks
+## Tip 1 - Heart symbol
+If you want to show health of players and display a heart symbol as text, you can use this one: `❤`.
+```
+belowname-objective:
+  title: "&4❤"
+```
+> [!IMPORTANT]
+> Make sure your config is saved in UTF-8 encoding to properly read the heart symbol.
+
+## Tip 2 - Displaying health as 0-10 or in %
+If you want health to display health as 0-10 instead of 0-20, you can achieve it with PlaceholderAPI:
+* `%math_0_{player_health}/2%` for 0-10
+* `%math_0_{player_health}*5%` for 0-100
+
+# Limitations
+* [1.5 - 1.12.2] Title length is limited to 32 characters (including color codes).
+* [1.5 - 1.20.2] `value` is limited to a white number.
+* The format is a **[score] + space + shared title**. No, the space cannot be removed.
+* The title is the same on all players, therefore, it cannot be personalized (such as player's faction). Only [score] can be per-player.
+* It appears on all entities of player type. **This includes player NPCs.**
+
+# Examples
+## Example 1 - Per-world values
+This feature doesn't directly support per-world values or similar.
+However, this can be achieved with conditions.
+Let's make `fancy-value` conditional based on player's world.
+Let's make an example with 3 worlds.
+Check if player is in world `world1`, then show one text.
+If not, check if player is in world `world2`, then show another text.
+If not, show the final text.
+This can be achieved by chaining 2 conditions:
+```
+conditions:
+  belowname1:
+    conditions:
+    - "%world%=world1"
+    true: "Text to display in world world1" # Player is in world world1, display the text
+    false: "%condition:belowname2%" # Player is not in world world1, check another condition
+  belowname2:
+    conditions:
+    - "%world%=world2"
+    true: "Text to display in world world2" # Player is in world world2, display the text
+    false: "Text to display in other worlds" # Player is not in any of the 2 worlds
+```
+> [!WARNING]
+> DO NOT JUST RANDOMLY PASTE THIS ENTIRE "CONDITIONS" SECTION INTO YOUR CONFIG!
+> INSTEAD, EDIT YOUR EXISTING CONDITIONS SECTION TO PREVENT HAVING THE SECTION TWICE,
+> HAVING SECOND ONE COMPLETELY OVERRIDE THE FIRST ONE!
+
+Finally, use this condition as value in `fancy-value`:
+```
+belowname-objective:
+  fancy-value: "%condition:belowname1%"
+```
+If you are under 1.20.3 and want to make `value` and `title` conditional,
+create two condition chains, one for each value and use them.
+
+> [!NOTE]
+> This is just an example, the plugin is not limited to displaying different values only per world.
+> If you want per server values on BungeeCord, use %server% with server names.
+> If you want WorldGuard regions, use %worldguard_region_name% with region names.
+> This works for any placeholder offered by the plugin or by PlaceholderAPI.
+
+## Example 2 - Hiding `title` for 1.20.3+ players
+1.20.3 has replaced `value` field,
+which is limited to a white number with value configurable as `fancy-value`, which has no limits.
+However, `title` field is still visible on 1.20.3+.
+If you support both version ranges and want to make the best out of the new functionality,
+you might want to not show `title` to 1.20.3+ players anymore,
+since you can fully customize the text you want to display in `fancy-value`.
+
+First, let's remind ourselves what `title` *actually* is.
+It is actually called scoreboard title.
+Yes, just like the one on top of sidebar, just displayed elsewhere.
+This is why it displays on all players and placeholders are parsed for the viewing player.
+With this knowledge, all we need to do is check for player's version and only show something for <1.20.3.
+For this, we will use `%player-version-id%` placeholder,
+which returns the network protocol version of player's game version, which can then be compared to.
+```
+conditions:
+  version:
+    - "%player-version-id%>=765" # 1.20.3 is 765
+  true: "" # Show empty value for 1.20.3+
+  false: "Some text to display"
+```
+> [!WARNING]
+> DO NOT JUST RANDOMLY PASTE THIS ENTIRE "CONDITIONS" SECTION INTO YOUR CONFIG!
+> INSTEAD, EDIT YOUR EXISTING CONDITIONS SECTION TO PREVENT HAVING THE SECTION TWICE,
+> HAVING SECOND ONE COMPLETELY OVERRIDE THE FIRST ONE!
+```
+belowname-objective:
+  title: "%condition:version%"
+```
+Unfortunately, due to the limitations of this feature,
+there is a forced space between `value`/`fancy-value` and `title`,
+even if the `title` is empty.
+You'll either need to live with it, or put some shared text there to avoid having a space at the end.  
@@ -0,0 +1,221 @@
+# Content
+* [About](#about)
+* [Configuration](#configuration)
+    * [Defining bossbars](#defining-bossbars)
+        * [style](#style)
+        * [color](#color)
+        * [progress](#progress)
+        * [text](#text)
+        * [announcement-bar](#announcement-bar)
+        * [display-condition](#display-condition)
+    * [Announce command](#announce-command)
+    * [Additional settings](#additional-settings)
+* [Limitations](#limitations)
+* [Additional info](#additional-info)
+    * [Additional note 1 - Hiding bar itself](#additional-note-1---hiding-bar-itself)
+    * [Additional note 2 - Not hiding on server switch](#additional-note-2---not-hiding-on-server-switch)
+* [API](#api)
+* [Tips & Tricks](#tips--tricks)
+    * [Tip 1 - Animated bossbar color](#tip-1---animated-bossbar-color)
+    * [Tip 2 - Switching between bossbars with condition](#tip-2---switching-between-bossbars-with-condition)
+
+# About
+![](https://images-ext-2.discordapp.net/external/0H5v5gcK12jm-O_kljlx-iYdJ1Q3wBsY_Dch7Jr_aAk/https/image.prntscr.com/image/x4VewIuiRwO-XLGTvDxfWw.png)  
+Bars with text on top of the screen originally designed to display the health of ender dragon & wither,
+but plugins found another use for it.
+In 1.9, mojang added a packet
+dedicated to displaying text without requiring an entity and allowing customizable color and style as well.
+TAB only supports this new functionality, and the feature does not support 1.8 and lower.
+
+This feature can be configured in **config.yml** under **bossbar** section.
+
+# Configuration
+## Defining bossbars
+```
+bossbar:
+  bars:
+    MyBossbar:
+      style: "PROGRESS"
+      color: "%animation:barcolors%"
+      progress: "100"
+      text: "&fWebsite: &bwww.domain.com"
+```
+Every bossbar line has 4 properties:
+
+### style
+Type of bossbar division.  
+You can choose from 5 styles: **PROGRESS**, **NOTCHED_6**, **NOTCHED_10**, **NOTCHED_12** and **NOTCHED_20**  
+![](https://images-ext-1.discordapp.net/external/yMuJNksnulOd_ZtI3yGw6CaQhon-ewVHsqaMzT8RcGk/https/image.prntscr.com/image/FzWSvsalTW6YVRPPK3oa9g.png)  
+These were defined by mojang, no other options are available. Other plugins may be using different names, but it's the same result in the end.
+
+
+### color
+Color of bossbar.  
+You can choose from 7 colors: **BLUE**, **GREEN**, **PINK**, **PURPLE**, **RED**, **WHITE** and **YELLOW**  
+![](https://images-ext-2.discordapp.net/external/MwNGvtNT0vspb_xiGUyx_WQNayvSmb8h0Sk4W7Vxfoc/https/image.prntscr.com/image/fM7kq5XIRCiTN5n-ffpNyA.png)  
+These were defined by mojang, no other options are available.
+
+
+### progress
+A number from 0 to 100. Accepts decimals.  
+![image](https://user-images.githubusercontent.com/6338394/196031770-2208848c-8e38-44cc-aa49-c86427160cab.png)  
+If you want to show the progress of a placeholder's value relative to a maximum one, you can use the [Math Expansion](https://github.com/PlaceholderAPI/PlaceholderAPI/wiki/Placeholders#math) from PlaceholderAPI and use a placeholder like this one: `%math_{placeholder_current_value}/{placeholder_max_value}*100%` or `%math_{placeholder_current_value}/<max_value>*100%` if your max value is fixed.
+
+> [!NOTE]
+> Replace the text in between the `{}` with the actual placeholder you want to use and `<max_value>` with a valid number
+(i.e., 20).  
+You cannot use the `%placeholder%` format inside the math placeholder.
+
+Example for showing a player's health: `%math_{player_health}/20*100%` or `%math_{player_health}/{player_max_health}*100%`
+
+### text
+Text of the bossbar. Length is not limited, supports RGB codes on 1.16+. Does not support newlines.
+
+### announcement-bar
+When set to true, the bossbar will not appear by default, only when used in announce command.
+```
+bossbar:
+  bars:
+    MyBossbar:
+      style: "PROGRESS"
+      color: "BLUE"
+      progress: "100"
+      text: "Text"
+      announcement-bar: true #false or undefined means it will be visible all the time
+```
+### display-condition
+[Condition](https://github.com/NEZNAMY/TAB/wiki/Feature-guide:-Conditional-placeholders) that must be met for player to see the bossbar. Even when using announce command on a bossbar with display condition, players must meet it to see the bossbar. When condition is not defined, bossbar has no requirement to be displayed.  
+**Example**:
+```
+bossbar:
+  bars:
+    MyBossbar:
+      style: "PROGRESS"
+      color: "BLUE"
+      progress: "100"
+      text: "This bossbar is only visible in world 'world'"
+      display-condition: "%world%=world"
+```
+
+## Announce command
+`/tab bossbar announce <name> <time>`  
+`name` is name of bossbar defined in config.yml under **bossbar** section, `time` is length of display time in seconds.
+
+When using a bossbar announcement, you have a new placeholder available:
+`%countdown%` that shows remaining time of the announcement in seconds.
+You can further use this placeholder in progress, for example,
+using Math expansion from PlaceholderAPI, such as `%math_{tab_placeholder_countdown}/<total time>*100%`.
+
+## Additional settings
+| Option name            | Default value | Description                                                                                                                                                                                                                                                                                                                                                                                                                                 |
+|------------------------|---------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
+| enabled                | false         | Enables / Disables the feature                                                                                                                                                                                                                                                                                                                                                                                                              |
+| toggle-command         | /bossbar      | A command to toggle bossbar visibility for player running the command. This command requires `tab.bossbar.toggle` permission. <br />**Note:** This command will not appear in command auto-complete, because it's not a real registered command. Registered commands must be defined in plugin jar directly and cannot be dynamic. If you want to solve this, you can try getting a dummy private plugin made which registers that command. |
+| remember-toggle-choice | false         | When enabled, disabling bossbar using `toggle-command` is remembered between reloads and restarts.                                                                                                                                                                                                                                                                                                                                          |
+| hidden-by-default      | false         | When enabled, bossbar will automatically be hidden until toggle command is used.                                                                                                                                                                                                                                                                                                                                                            |
+
+# Limitations
+* Does not support newlines. If you want to display more lines, you'll need to create multiple bossbars.
+* The bar itself cannot be removed from the server side. However, it can be removed with a resource pack.
+
+# Additional info
+## Additional note 1 - Hiding bar itself
+If you want to hide the bossbar itself and only show text, this is possible, but not from the plugin's side.
+You'll need to create a custom resource pack where the bar is invisible.
+Then, you need to force your players to get the resource pack.
+
+## Additional note 2 - Not hiding on server switch
+When under a proxy network and having TAB installed on backend server and switching to another server,
+the bossbar will not hide.
+This is because BungeeCord makes it look like a world switch to the client.
+To avoid this, the only way is to install TAB on BungeeCord and disable bossbar on that server.
+
+# API
+*To get started with the API, see [Developer API](https://github.com/NEZNAMY/TAB/wiki/Developer-API) page.*
+
+To access this feature, you'll need to obtain `BossBarManager` instance. Get it using `TabAPI.getInstance().getBossBarManager()`. If this feature is disabled, the method will return `null`.
+
+A boss bar is made up of a few things:
+* A name. This is either the name given in the config, if the bar was loaded from the config, or a random UUID string when created with API.
+* A title. This is the display message of the boss bar.
+* The progress from 0 to 100.
+* The color. This determines what color the boss bar will appear when it is shown to clients.
+* The style. This determines how many segments, if any, the boss bar will be split to.
+
+Let's start with methods in `BossBarManager`:
+* `BossBarManager#createBossBar(String, float, BarColor, BarStyle` - Creates new bossbar using direct values.
+* `BossBarManager#createBossBar(String, String, String, String` - Creates new bossbar. Accepts all the previous parameters as strings, to allow for placeholders, though the given placeholders must match the requirements (progress will be a number, color and style matching enum names).
+* `BossBarManager#getBossBar(String)` - Returns bossbar by name defined in config.
+* `BossBarManager#toggleBossBar(TabPlayer, boolean)` - Toggles all bossbars for specified player. The boolean flags whether toggle message defined in messages.yml should be sent to the player or not.
+* `BossBarManager#hasBossBarVisible(TabPlayer)` - Returns `true` if player has bossbars visible, `false` if disabled using toggling.
+* `BossBarManager#setBossBarVisible(TabPlayer, boolean, boolean)` - Sets bossbar visibility status for specified player to specified value (first boolean). Second boolean determines whether toggle message configured in messages.yml should be sent or not.
+* `BossBarManager#sendBossBarTemporarily(TabPlayer, String, int)` - Temporarily sends bossbar to player. String defines name of the bossbar defined in config. Int defines length in milliseconds.
+* `BossBarManager#announceBossBar(String, int)` - Sends bossbar with specified name in config to all players for `int` milliseconds.
+* `BossBarManager#getAnnouncedBossBars()` - Returns all bossbars, which are currently being announced.
+* `BossBarManager#getRegisteredBossBars()` - Returns map of all registered bossbars using configuration or the API.
+
+Methods in `BossBar`:
+* `BossBar#getName()` - Returns name of the bossbar defined in config, or randomly generated UUID string when generated using API.
+* `BossBar#setTitle(String)` - Sets title. Accepts placeholders, which will be replaced and periodically updated.
+* `BossBar#setProgress(String)` - Sets progress. Accepts placeholders, which will be replaced and periodically updated.
+* `BossBar#setProgress(float)` - Sets progress.
+* `BossBar#setColor(String)` - Sets color. Accepts placeholders, which will be replaced and periodically updated.
+* `BossBar#setColor(BarColor)` - Sets color.
+* `BossBar#setStyle(String)` - Sets style. Accepts placeholders, which will be replaced and periodically updated.
+* `BossBar#setStyle(BarStyle)` - Sets style.
+* `BossBar#getTitle()` - Returns raw title.
+* `BossBar#getProgress()` - Returns raw progress as string.
+* `BossBar#getColor()` - Returns raw color as string.
+* `BossBar#getStyle()` - Returns raw style as string.
+* `BossBar#addPlayer(TabPlayer)` - Sends the bossbar to specified player.
+* `BossBar#removePlayer(TabPlayer)` - Removes the bossbar from specified player.
+* `BossBar#getPlayers()` - Returns all players that can currently see this bossbar.
+* `BossBar#containsPlayer(TabPlayer)` - Returns `true` if player can see this bossbar, `false` if not.
+* `BossBar#isAnnouncementBar()` - Returns `true` if this bossbar is defined as announcement bar in config, `false` if visible permanently.
+
+# Tips & Tricks
+## Tip 1 - Animated bossbar color
+You can animate the color of a bossbar using [animations](https://github.com/NEZNAMY/TAB/wiki/Animations).  
+First, create an animation in **animations.yml**, such as
+```
+BossColor:
+  change-interval: 1000
+  texts:
+    - "BLUE"
+    - "YELLOW"
+```
+Then, use the animation in bossbar configuration
+```
+  bars:
+    ServerInfo:
+      style: "PROGRESS"
+      color: "%animation:BossColor%"
+      progress: "100"
+      text: "&fWebsite: &bwww.domain.com"
+```
+This bossbar will change color every second between blue and yellow colors.  
+You can do the same with progress, style and text as well.
+
+## Tip 2 - Switching between bossbars with condition
+If you want the plugin to switch between bossbars based on a condition, first consider using condition for text itself
+(or some other property).
+If this is not an option (you want text, color, style and progress to be different, which would result in 4 conditions),
+create 2 bars and give them the same condition, except, negate it.
+If your original condition uses `=`, make second condition use `!=`.
+For number comparisons, negate `<` using `>=` and so on.  
+**Example**:
+```
+  bars:
+    full:
+      style: "PROGRESS"
+      color: "YELLOW"
+      progress: "100"
+      text: "&aYour health is full"
+      display-condition: "%health%=20"
+    notfull:
+      style: "PROGRESS"
+      color: "RED"
+      progress: "0"
+      text: "&cYou took damage"
+      display-condition: "%health%!=20"
+```
@@ -0,0 +1,217 @@
+# Content
+* [About](#about)
+* [Condition types](#condition-types)
+  * [Number comparations](#number-comparations)
+  * [Text operations](#text-operations)
+  * [Permission](#permission)
+* [Multiple condition requirements](#multiple-condition-requirements)
+* [Condition output](#condition-output)
+* [Configuration](#configuration)
+* [Usage](#usage)
+  * [Displaying text](#displaying-text)
+  * [Display condition of a feature](#display-condition-of-a-feature)
+    * [Short format](#short-format)
+* [Refresh interval](#refresh-interval)
+* [Examples](#examples)
+  * [Example 1 - Chaining conditional placeholders](#example-1---chaining-conditional-placeholders)
+  * [Example 2 - Conditions in conditions](#example-2---conditions-in-conditions)
+
+# About
+Conditions / conditional placeholders allow you
+to create output which depends on the output of other placeholders or permission requirement.  
+They have 2 main uses in the plugin:
+* Display condition which must be met to be able to see something (bossbar, scoreboard, layout)
+* Conditional placeholders which return defined outputs in both cases if the condition passes or fails
+
+# Condition types
+## Number comparations
+`>=`: greater than or equal to  
+Example: `%ping%>=100` will pass if the player's ping is greater than or equal to `100`.
+
+`>`: greater than   
+Example: `%ping%>100` will pass if the player's ping is greater than `100`.
+
+`<=`: less than or equal to  
+Example: `%ping%<=100` will pass if the player's ping is less than or equal to `100`.
+
+`<`: less than  
+Example: `%ping%<100` will pass if the player's ping is less than `100`.
+
+## Text operations
+`=`: equal to (must match exactly)  
+Example: `%world%=world` will pass if player is in world `world`.
+
+`!=`: not equal to (opposite of the above)  
+Example: `%world%!=world` will pass if player is in any world except `world`.
+
+**Note 1**: For `=` and `!=` you can check for empty output of a placeholder using `%my_placeholder%=` and `%my_placeholder%!=`.
+
+`<-`: contains (left side for full text, right side text to contain)  
+Example: `%world%<-lobby-` will pass if player is in any world that contains `lobby-` (such as `lobby-1` etc.).
+
+`|-`: starts with (left side for full text, right side text to start with)  
+Example: `%world%|-lobby-` will pass if player is in any world that starts with `lobby-` (such as `lobby-1` etc.).
+
+`-|`: ends with (left side for full text, right side text to end with)  
+Example: `%world%-|nether` will pass if player is in any world that ends with `nether` (such as `world_nether` etc.).
+
+**Note 2**: For string operators, the text must match placeholder's output exactly, including color codes.
+If you are using [Placeholder output replacements](https://github.com/NEZNAMY/TAB/wiki/Feature-guide:-Placeholder-output-replacements),
+condition must contain the altered output.  
+To see the exact output of a placeholder including color codes, use `/tab parse <player> <placeholder>`.
+
+## Permission
+`permission:<value>`: permission requirement  
+Example: `permission:my.permission` will pass if player has `my.permission` permission.
+
+# Multiple condition requirements
+Each condition has a `conditions` parameter, which a list of conditions. If you define more than 1 condition, you must specify the condition type.  
+This value can be found under `type` field. Types are:
+* `AND` - all sub-conditions must be met for the final condition to pass
+* `OR` - at least one sub-condition must be met for the final condition to pass
+
+If you only defined one subcondition, you don't need to define the type at all, since it's not used for anything.
+
+# Condition output
+If using condition as a placeholder, you can specify output in both cases using `yes` and `no` values. `yes` is used when condition passes, `no` if not. If using condition only as a view requirement, you can leave these values empty / not specify them at all.
+
+# Configuration
+Open **config.yml** and find this section:
+```
+conditions:
+  health:
+    conditions:
+    - '%health%<21'
+    - '%health%>15'
+    type: AND
+    yes: Healthy!
+    no: Damaged!
+```
+`health` is name of our condition in this case.  
+`conditions` is a list of subconditions that must be met for this condition to pass.  
+`type` defines whether all subconditions must be met or at least one.  
+`yes` & `no` define output in both cases.
+
+# Usage
+You have 2 ways to use conditions.
+
+## Displaying text
+The first way is to use conditions to display text.
+Configure outputs in `yes` and `no` values and then use `%condition:<name>%`,
+which will output text defined in `yes` or `no` depending on if condition is met or not.
+<details>
+  <summary>Example</summary>
+
+```
+conditions:
+  serverName:
+    conditions:
+      - "%server%=lobby"
+    yes: "You are in the lobby"
+    no: "You are not in lobby"
+```
+
+Use with `%condition:serverName%`
+</details>
+
+## Display condition of a feature
+The second way is to use condition's name in places where a condition is accepted.
+This includes display conditions for bossbar, scoreboard and layout.
+In these cases, yes/no texts are unused; therefore, they do not need to be defined.
+<details>
+  <summary>Example</summary>
+
+```
+conditions:
+  MyCondition:
+    conditions:
+      - "permission:tab.admin"
+```
+```
+scoreboards:
+  MyScoreboard:
+    display-condition: MyCondition
+```
+
+In this example, scoreboard will only be displayed to players with `tab.admin` permission.
+</details>
+
+### Short format
+If trying to use a condition on place where it's available (bossbar display condition, scoreboard display condition) where you don't need the yes/no values, you can use a short format instead.
+
+This can be used by simply creating all subconditions and separating them with `;` for `AND` condition type. For `OR` type, use `|`.
+<details>
+  <summary>Example</summary>
+
+Single condition:
+```
+display-condition: "%server%=lobby"
+```
+
+Multiple conditions, all of them must be met:
+```
+display-condition: "%server%=lobby;%world%=world"
+```
+
+Multiple conditions, at least one of them must be met:
+```
+display-condition: "%server%=lobby|%server%=lobby2"
+```
+
+</details>
+
+# Refresh interval
+Conditions are just placeholders after all, and, as such, they must be refreshed periodically.
+Refresh intervals of conditions are not directly configurable.
+They are based on placeholders used inside (subconditions, yes/no values).  
+Permission checks count as 1000ms.  
+To configure refresh intervals of placeholders,
+check out the [Optimization guide](https://github.com/NEZNAMY/TAB/wiki/Optimizing-the-plugin#2---placeholder-refresh-intervals).
+
+# Examples
+## Example 1 - Chaining conditional placeholders
+Let's create colored ping by chaining conditions using multiple intervals for ping quality. This specific case would be easier done using [replacements](https://github.com/NEZNAMY/TAB/wiki/Feature-guide:-Placeholder-output-replacements), but this is just an example. Let's say we want <50 for good, <100 for medium and 100+ for bad. Let's create the first condition:
+```
+conditions:
+  ping:
+    conditions:
+    - "%ping%<50"
+    true: "&a%ping%"
+    false: "%condition:ping2%"
+```
+When ping is <50, display it as green. Otherwise, use another condition. Put them together and we get
+```
+conditions:
+  ping:
+    conditions:
+    - "%ping%<50"
+    true: "&a%ping%" # Ping is < 50, display as green
+    false: "%condition:ping2%" # Ping is 50+, check another condition
+  ping2:
+    conditions:
+    - "%ping%<100"
+    true: "&e%ping%" # Ping is < 100, display as yellow
+    false: "&c%ping%" # Ping is 100+, display as red
+```
+Finally, we can use this ping placeholder using `%condition:ping%`.  
+This example chained 2 conditions, but more can be used. There is no limit.
+
+# Example 2 - Conditions in conditions
+If you want to use a condition in another one,
+for example, to use both "AND" and "OR" types, create 2 conditions and use one in the other one.  
+For example, if we want to check that player is in server `lobby` **and** in worlds **either** `world1` or `world2`,
+it can be achieved in the following way:
+```
+conditions:
+  world:
+    conditions:
+      - "%world%=world1"
+      - "%world%=world2"
+    type: OR
+  main:
+    conditions:
+      - "%condition:world%=true"
+      - "%server%=lobby"
+    type: AND
+```
+Then, use condition `main` as the display condition. Note that `yes`/`no` values were not defined, as such, they default to `true` and `false`, respectively. Therefore, we use the placeholder from the condition and check if the result is `true`. Then, check if player is also in the specified server.  
@@ -0,0 +1,75 @@
+# Content
+* [About](#about)
+* [Configuration](#configuration)
+  * [Grouping players only from certain servers](#grouping-players-only-from-certain-servers)
+  * [Configuring isolated servers](#configuring-isolated-servers)
+  * [Seeing all players on the network from some server](#seeing-all-players-on-the-network-from-some-server)
+* [Compatibility with vanish plugins](#compatibility-with-vanish-plugins)
+
+# About
+This feature allows you to see players from other servers under a bungeecord network, instead of only seeing players on the same server.  
+To use this feature, you need [TAB installed on bungeecord](https://github.com/NEZNAMY/TAB/wiki/Installation#bungeecord). This option is not available on bukkit and will not be added.
+
+# Configuration
+| Option name                            | Default value | Description                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            |
+|----------------------------------------|---------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
+| enabled                                | false         | Enables / Disables the feature                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                         |
+| server-groups                          | *Map*         | See [Grouping players only from certain servers](#grouping-players-only-from-certain-servers)                                                                                                                                                                                                                                                                                                                                                                                                                                          |
+| spy-servers                            | *List*        | See [Seeing all players on the network from some server](#seeing-all-players-on-the-network-from-some-server)                                                                                                                                                                                                                                                                                                                                                                                                                          |
+| display-others-as-spectators           | false         | When enabled, players on different servers will appear as having spectator gamemode in tablist.                                                                                                                                                                                                                                                                                                                                                                                                                                        |
+| display-vanished-players-as-spectators | true          | When enabled, vanished players will show as in spectator gamemode for those, who have permission to see vanished players (tab.seevanished) (others will obviously not see them at all). Vanished players will still see themselves in the gamemode they are actually in, since changing that would cause problems (client would think it's in spectator gamemode while it isn't).                                                                                                                                                      |
+| isolate-unlisted-servers               | false         | When enabled, servers not listed in any group will not share playerlist with any other server, instead of sharing it with other unlisted servers.                                                                                                                                                                                                                                                                                                                                                                                      |
+| update-latency                         | false         | When **enabled**, plugin will send ping update to players on other servers, since backend servers only send ping updates of players on the same server. This is displayed as the green bar in tablist, unless altered by a mod / resource pack (?). <br /> <br />When **disabled**, ping of players on other servers will be set to 0 (5 bars).  <br /> <br />Disabled by default, because it's not only not very useful, but also has a very high CPU usage to due spamming a large amount of packets (especially on large networks). |
+
+## Grouping players only from certain servers
+In case you want multiple servers to share playerlist,
+but not with every server, create a server group and put servers there.
+The default example
+```
+global-playerlist:
+  server-groups:
+    lobbies:
+      - lobby1
+      - lobby2
+    group2:
+      - server1
+      - server2
+```
+Contains 2 groups, each of them consisting of 2 servers.
+Server group name can be anything (in our case, they're called "lobbies" and "group2").
+Under group name, list the actual server names defined in config.yml of bungeecord.
+
+With this setup, "lobby1" and "lobby2" will share playerlist, as well as "server1" with "server2". All unlisted servers are automatically put into a hidden default group and share playerlist. This means that all other servers except these 4 will share playerlist.
+
+To make all servers share the playerlist, simply clear server groups and set
+```
+  server-groups: {}
+```
+
+## Configuring isolated servers
+If you want servers which are isolated (no one will see these players, and they will not see anyone on other servers),
+create a new group and only put that 1 server there.
+For example:
+```
+global-playerlist:
+  server-groups:
+    test1:
+      - isolatedServer1
+    test2:
+      - isolatedServer2
+```
+
+## Seeing all players on the network from some server
+If, despite configuring server groups,
+you want players to see everyone on the network if they're connected to specific server(s),
+you can list those servers at
+```
+global-playerlist:
+  spy-servers:
+    - spyserver1
+    - spyserver2
+```
+Now, players connected to "spyserver1" or "spyserver2" will see everyone on the network in tablist, but no one else (unless on another spy server / in the same server group) will see them.
+
+# Compatibility with vanish plugins
+For compatibility with vanish plugins, vanish status must be detected correctly. See [Additional information - Vanish detection](https://github.com/NEZNAMY/TAB/wiki/Additional-information#vanish-detection) for more info.
@@ -0,0 +1,127 @@
+# Content
+* [About](#about)
+* [Configuration](#configuration)
+  * [Global settings](#global-settings)
+  * [Per-world / per-server](#per-world--per-server)
+  * [Per-group / per-player](#per-group--per-player)
+* [Additional info](#additional-info)
+  * [Additional note 1 - Not resetting on server switch](#additional-note-1---not-resetting-on-server-switch)
+* [Tips & Tricks](#tips--tricks)
+  * [Tip 1 - Dynamic line count](#tip-1---dynamic-line-count)
+* [API](#api)
+
+# About
+Minecraft feature **introduced in 1.8** showing text above and below playerlist. It cannot be displayed on 1.7 clients in any way.
+
+![](https://images-ext-2.discordapp.net/external/Jm9G7_fX8Rq4KU-Syj57W2a_leel380bZ4lmd6c0vBs/https/image.prntscr.com/image/qvuAdtgZTDeZ4IeABi8I3g.png)
+
+# Configuration
+| Option name       | Default value         | Description                                                                                                                                                                                         |
+|-------------------|-----------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
+| enabled           | true                  | Enables / Disables the feature                                                                                                                                                                      |
+| disable-condition | %world%=disabledworld | A [condition](https://github.com/NEZNAMY/TAB/wiki/Feature-guide:-Conditional-placeholders) that must be met for disabling the feature for players. Set to empty for not disabling the feature ever. |
+
+## Global settings
+The example above is using this configuration:
+```
+header-footer:
+  header:
+  - "This is the first line of header"
+  - "2nd line of header"
+  footer:
+  - "This is the first line of footer"
+  - "2nd line of footer"
+```
+It is the default header/footer for everyone, unless overridden in some way.
+
+## Per-world / per-server
+```
+header-footer:
+  per-world:
+    <your world>:
+      header:
+        - "Header in specified world"
+      footer:
+        - "Footer in specified world"
+  per-server:
+    <your server>:
+      header:
+        - "Header in specified server"
+      footer:
+        - "Footer in specified server"
+```
+
+For multiple worlds/servers to share the same settings, separate them with `;`.  
+For worlds/servers starting with a specified text, use `*` after the shared part. For ending with a shared part, use `*` at the beginning.  
+Example:
+```
+header-footer:
+  per-world:
+    world1;world2:
+      header:
+        - "Shared header in worlds world1 and world2"
+    lobby-*:
+      header:
+        - "Header in all worlds starting with lobby-"
+```
+
+> [!NOTE]
+> To make per-world work on proxy installation,
+> install the [TAB-Bridge](https://www.mc-market.org/resources/21641) plugin on your backend servers.
+
+## Per-group / per-player
+**groups.yml**
+```
+MyGroup:
+  header:
+    - "This is a header for MyGroup group"
+  footer:
+    - "This is a footer for MyGroup group"
+per-world:
+  MyWorld:
+    TestGroup:
+      header:
+        - "Header for group TestGroup in world MyWorld"
+```
+Same for users, which can be configured in **users.yml**.
+
+# Additional info
+## Additional note 1 - Not resetting on server switch
+When under a BungeeCord network and having TAB installed on backend server and switching to another server, the header/footer will not reset. This is because BungeeCord makes it look like a world switch to the client. To avoid this, you have 2 options:
+* Install TAB on BungeeCord and disable header/footer on the server.
+* Install a plugin that sends some, or even empty header/footer on join.
+
+# Tips & Tricks
+## Tip 1 - Dynamic line count
+The entire header is just a single character sequence that allows newline symbol (`\n`) for new lines. It is only being split into multiple lines in config for convenience to make it readable when configuring and editing. Same for footer.  
+If using a placeholder that returns the newline symbol, it will create a new line. You can use this to your advantage and create a [conditional placeholder](https://github.com/NEZNAMY/TAB/wiki/Feature-guide:-Conditional-placeholders) or an [animation](https://github.com/NEZNAMY/TAB/wiki/Animations) that includes newline in some frames.
+<details>
+  <summary>Example</summary>
+
+**animations.yml**
+```
+MyAnimation:
+  change-interval: 1000
+  texts:
+    - "First frame with only 1 line"
+    - "Second frame\nconsisting of 2 lines"
+```
+**config.yml**
+```
+header-footer:
+  header:
+    - "%animation:MyAnimation%"
+```
+</details>
+
+# API
+*To get started with the API, see [Developer API](https://github.com/NEZNAMY/TAB/wiki/Developer-API) page.*
+
+To access this feature, you'll need to obtain `HeaderFooterManager` instance. Get it using `TabAPI.getInstance().getHeaderFooterManager()`. If this feature is disabled, the method will return `null`.
+
+To set the header and/or footer for a player, use the following:
+* `HeaderFooterManager#setHeader(TabPlayer, String)`
+* `HeaderFooterManager#setFooter(TabPlayer, String)`
+* `HeaderFooterManager#setHeaderAndFooter(TabPlayer, String, String)`
+
+To reset the header and/or footer for a player back to their original values, use `null` as argument.  
@@ -0,0 +1,282 @@
+# Content
+* [About](#about)
+* [Creating a layout](#creating-a-layout)
+  * [Display condition](#display-condition)
+  * [Fixed slots](#fixed-slots)
+  * [Player groups](#player-groups)
+* [Managing multiple layouts with conditions](#managing-multiple-layouts-with-conditions)
+* [Skins](#skins)
+  * [Format](#format)
+* [Additional settings](#additional-settings)
+* [Additional info](#additional-info)
+  * [Additional note 1 - Playerlist objective incompatibility](#additional-note-1---playerlist-objective-incompatibility)
+  * [Additional note 2 - Global playerlist incompatibility](#additional-note-2---global-playerlist-incompatibility)
+  * [Additional note 3 - [1.19.3 - 1.21.1] Entries in chat complete](#additional-note-3---1193---1211-entries-in-chat-complete)
+  * [Additional note 4 - Per world playerlist incompatibility](#additional-note-4---per-world-playerlist-incompatibility)
+  * [Additional note 5 - [1.8 - 1.21.3] Second layer of skin missing](#additional-note-5---18---1213-second-layer-of-skin-missing)
+* [Examples](#examples)
+  * [Example 1 - Per-server columns](#example-1---per-server-columns)
+
+# About
+This feature allows you to customize all 80 tablist slots. Displaying less than 4 columns is currently not supported. This feature can be enabled and configured in **config.yml** file under **layout** section.
+
+This feature is only available for versions **1.8** and up due to massive tablist changes, which would make 1.7- compatibility require a complete rewrite of the functionality and could still cause all kinds of visual issues, including, but not limited to compatibility with other plugins adding/removing players from the tablist.
+
+# Creating a layout
+Layouts can be creating in config under `layout.layouts` section. Each layout contains 3 settings: Fixed slots, player groups and display condition (optional).
+
+## Display condition
+Condition that must be met for player to see the layout.
+If player does not meet the condition, the next defined layout's condition is checked.
+If a player does not meet any defined display condition, they will see the default tablist.
+Display condition is optional and doesn't need to be set.  
+For list of possible condition types see [Conditions page](https://github.com/NEZNAMY/TAB/wiki/Feature-guide:-Conditional-placeholders).  
+Example:
+```
+layouts:
+  staff:
+    condition: "permission:tab.staff"
+```
+This layout will only be visible to players with `tab.staff` permission.
+
+## Fixed slots
+These are slots with fixed position that contain configurable text and skin.  
+They can be configured under `fixed-slots` option of each layout. The definition syntax is `SLOT|TEXT|SKIN`. If you don't want to define custom skin for that slot, use `SLOT|TEXT`.  
+`SLOT` - The position of the fixed slot. It can be from 1 to 80. By default, the direction is set to columns, so the first column is 1-20.  
+`TEXT` - the text. It supports placeholders.  
+`SKIN` - layout's skin, see below for configuration.  
+Example:
+```
+layouts:
+  staff:
+    fixed-slots:
+      - '1|&3RAM&f:'
+      - '2|&b%memory-used%MB / %memory-max%MB'
+      - '3|&8&m                       '
+      - '4|&3TPS&f:'
+      - '5|&b%tps%'
+```
+
+## Player groups
+These are groups of players that meet the specified condition. They consist of 2 parts - condition and slots.
+
+**1. Condition**  
+The condition players must meet to be displayed in the group.
+If a player doesn't meet condition for a group, the next group's condition is checked
+(groups are checked in the order they are defined in config).
+If player doesn't meet any condition, they are not displayed at all.
+Display condition is not required (can be used to make a "default" group with the remaining players).
+
+**2. Slots**  
+Slot intervals dedicated to the group. Interval `1-5` would mean all slots from 1 to 5. In case you want to define multiple intervals to exclude some slots, define another interval below the first one.  
+Example:
+```
+layouts:
+  myLayout:
+    groups:
+      staff:
+        condition: permission:tab.staff
+        slots:
+          - '24-40'
+      players:
+        slots:
+          - '44-80'
+```
+In this example, slots `24-40` will be reserved for players with `tab.staff` permission. Players without that permission will be in slots `44-80`.
+
+# Managing multiple layouts with conditions
+You can define multiple layouts and display them based on a condition.
+To do so, define `condition` for layouts.
+Conditions are checked in the order layouts are defined in config.
+If layout doesn't specify condition, it is displayed with no requirement.
+If a player does not meet display condition for any layout, they will see the classic tablist.  
+Example:
+```
+layouts:
+  staff:
+    condition: "permission:tab.staff"
+    fixed-slots:
+      ...
+    groups:
+      ...
+  default:
+    fixed-slots:
+      ...
+    groups:
+      ...
+```
+In this example, players with `tab.staff` permission will see `staff` layout, others will see `default` layout.
+
+# Skins
+In slots where players are, their skin is displayed. For fixed slots, if their skin is defined, it is used, otherwise `default-skin` is used. It is also used if invalid skin is specified anywhere.
+
+## Format
+Currently, TAB supports 3 skin formats:
+* `mineskin:<ID>` - takes UUID from [MineSkin](https://mineskin.org). You can find some pre-uploaded skins at the bottom of this page.
+* `player:<name>` - displays skin of player `name`
+* `texture:<texture>` - uses literal skin texture. This lets you use heads from [Minecraft-Heads](https://minecraft-heads.com/custom-heads) by taking the texture in the `Minecraft-URL` field.    
+  ![](https://cdn.discordapp.com/attachments/817789229479624728/916373892237512715/unknown.png)
+
+Some pre-uploaded Mineskin skins:
+```yml
+BTLP's balance.png: 510604280
+BTLP's clock.png: 2053951237
+BTLP's server.png: 604037953
+BTLP's ping.png: 796704708
+BTLP's players.png: 1160612233
+BTLP's rank.png: 527763880
+Aqua: 1749359849
+Black: 1551047136
+Blue: 1870064311
+Dark Aqua: 1893783461
+Dark Blue: 899643609
+Dark Gray: 383747683
+Dark Green: 588254656
+Dark Purple: 2061328517
+Dark Red: 924139093
+Gold: 1074335506
+Gray: 745109047
+Green: 224445819
+Pink: 1818936290
+Red: 1160568696
+White: 1105851698
+Yellow: 1307755006
+```
+
+# Additional settings
+| Option name                   | Default value        | Description                                                                                                                                                                                                                                                                |
+|-------------------------------|----------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
+| direction                     | COLUMNS              | Defines direction of slots. Options are COLUMNS (top to bottom, left to right) and ROWS (left to right, top to bottom). This does not only change the slot numbers in configuration, but will also affect the way players are being filled into player groups.             |
+| enable-remaining-players-text | true                 | When enabled, the last slot of player group will show how many more players there are, instead of using the last slot for one more player.                                                                                                                                 |
+| remaining-players-text        | "... and %s more"    | Text to show if option above is enabled.                                                                                                                                                                                                                                   |
+| default-skin                  | "mineskin:383747683" | Default skin to display for fixed slots that do not define a skin, empty slots and fixed slots with invalid skin.                                                                                                                                                          |
+| empty-slot-ping-value         | 1000                 | Ping value to use for fixed slots and empty slots. The ping intervals for bars are client sided and are as following: <br />- Negative value: ✖ <br />- 0 - 149: 5 bars <br />- 150 - 299: 4 bars <br />- 300 - 599: 3 bars <br />- 600 - 999: 2 bars <br />- 1000+: 1 bar |
+
+![image](https://user-images.githubusercontent.com/6338394/179363352-40f815d4-fc37-4ca1-8056-298488e84a60.png)
+![image](https://user-images.githubusercontent.com/6338394/179355373-3e50b8c5-95d7-4470-b93f-deb162ccc145.png)
+
+# Additional info
+## Additional note 1 - Playerlist objective incompatibility
+To avoid showing fake players in tab-complete, TAB uses an empty string as the fake players' names.  
+Though Minecraft's scoreboard objectives (which help achieve the Playerlist objective feature) only use players' names and not players' UUIDs to define values.  
+As a result, it is impossible for TAB to assign a different value for each fake player since they all have the same name, making the [Playerlist objective](https://github.com/NEZNAMY/TAB/wiki/Feature-guide:-Playerlist-Objective) feature incompatible.
+
+## Additional note 2 - Global playerlist incompatibility
+The way this feature works is by pushing all real players out of the tablist and showing fake players instead.  
+As a result, enabling [Global playerlist](https://github.com/NEZNAMY/TAB/wiki/Feature-guide:-Global-playerlist) feature won't make any difference, since real players aren't visible in the tablist.  
+Layout feature is capable of working with all online players connected to the server where TAB is installed, meaning it can show players from all servers when installed on BungeeCord. Because of this, if you use layout, you can disable global playerlist to reduce resource usage.
+
+## Additional note 3 - [1.19.3 - 1.21.1] Entries in chat complete
+From 1.19.3 until 1.21.1 (inclusive), entries will also appear in chat complete.
+The mechanic used to hide them on <1.19.3 can no longer be used since 1.19.3.
+1.21.2 has added a new way of sorting players, which is being taken advantage of to restore empty chat complete.
+> [!NOTE]
+> To hide entries from chat complete on 1.21.2+,
+the server also has to be 1.21.2+ so TAB can send the new content to the players
+(having TAB installed on proxy counts as using the latest version).
+
+## Additional note 4 - Per world playerlist incompatibility
+Layout works by adding 80 fake players into the tablist, pushing real player entries out of view.
+Because of this,
+when using [per world playerlist](https://github.com/NEZNAMY/TAB/wiki/Feature-guide:-Per-world-playerlist),
+the feature will only hide the real players,
+which are outside tablist and not visible anyway and not touch the layout entries.
+However, you can replicate the same effect using layout feature itself, using conditions.
+<details>
+  <summary>Example</summary>
+
+*We are going to ignore fixed slots in the examples,
+as they don't affect anything, and you can just configure them however you want.*  
+Let's create 2 layouts, one for world `world1` and one for world `world2`.
+Each layout only displays players in that world.
+```
+  layouts:
+    layout1:
+      condition: "%world%=world1"
+      fixed-slots: []
+      groups:
+        players:
+          condition: "%world%=world1"
+          slots:
+            - 1-80
+    layout2:
+      condition: "%world%=world2"
+      fixed-slots: []
+      groups:
+        players:
+          condition: "%world%=world2"
+          slots:
+            - 1-80
+```
+You can also merge multiple worlds into a group.
+```
+  layouts:
+    layout1:
+      condition: "%world%=world1|%world%=world2"
+      fixed-slots: []
+      groups:
+        players:
+          condition: "%world%=world1|%world%=world2"
+          slots:
+            - 1-80
+```
+You can also replicate "ignore-effect-in-worlds" by creating a layout with condition for displaying, but not for groups.
+```
+  layouts:
+    globalWorld:
+      condition: "%world%=globalWorld"
+      fixed-slots: []
+      groups:
+        players: # No condition here to show all players
+          slots:
+            - 1-80
+```
+</details>
+
+## Additional note 5 - [1.8 - 1.21.3] Second layer of skin missing
+Layout works by creating 80 fake entries, pushing real players out of the tablist.
+Unfortunately, players must be spawned around the player viewing the tablist to see the second layer of their skin.
+Since those fake entries you see are not the actual players and aren't spawned,
+as a result, you won't see the second layers of skins.
+This can only be fixed by actually letting the real entries display in the tablist,
+which would require a rework of the feature, which is not planned.  
+**1.21.4 has added a new tablist option called "show hats", which layout sets to true.
+They will be visible for 1.21.4+ players on 1.21.4+ servers (using a proxy counts as being latest).**
+
+# Examples
+## Example 1 - Per-server columns
+```
+layout:
+  enabled: true
+  direction: COLUMNS
+  default-skin: mineskin:383747683
+  enable-remaining-players-text: true
+  remaining-players-text: '... and %s more'
+  empty-slot-ping-value: 1000
+  layouts:
+    default:
+      fixed-slots:
+      - "1|&2&lLobby"
+      - "21|&2&lSurvival"
+      - "41|&2&lCreative"
+      - "61|&2&lSkyblock"
+      groups:
+        lobby:
+          condition: "%server%=lobby"
+          slots:
+          - 2-20
+        survival:
+          condition: "%server%=survival"
+          slots:
+          - 22-40
+        creative:
+          condition: "%server%=creative"
+          slots:
+          - 42-60
+        skyblock:
+          condition: "%server%=skyblock"
+          slots:
+          - 62-80
+```
+You can also remove the last condition (in this case `condition: "%server=skyblock%"`) and the columns will be used for all other servers, instead of just a specified one.  
+![image](https://github.com/NEZNAMY/TAB/assets/6338394/81016b5a-9b40-445e-8bfc-58204f5457f5)
@@ -0,0 +1,226 @@
+# Content
+* [About](#about)
+* [Configuration](#configuration)
+  * [Groups and users](#groups-and-users)
+  * [Per-world / per-server](#per-world--per-server)
+  * [Priority system](#priority-system)
+  * [Placeholder support](#placeholder-support)
+  * [Additional settings](#additional-settings)
+* [Tips & Tricks](#tips--tricks)
+* [Limitations](#limitations)
+* [Additional info](#additional-info)
+  * [Additional note 1 - NPC (in)compatibility](#additional-note-1---npc-incompatibility)
+  * [Additional note 2 - Prefix/suffix on pets](#additional-note-2---prefixsuffix-on-pets)
+  * [Additional note 3 - Changing name itself](#additional-note-3---changing-name-itself)
+  * [Additional note 4 - F1 view](#additional-note-4---f1-view)
+  * [Additional note 5 - Transparent players](#additional-note-5---transparent-players)
+* [API](#api)
+  * [Changing prefix and suffix](#changing-prefix-and-suffix)
+  * [Collision](#collision)
+  * [Manipulating visibility](#manipulating-visibility)
+  * [Disabling team handling](#disabling-team-handling)
+
+# About
+Nametags are controlled by a feature called scoreboard teams. They offer 6 properties:
+* Team name - used for sorting players in tablist, see [Sorting guide](https://github.com/NEZNAMY/TAB/wiki/Feature-guide:-Sorting-players-in-tablist) for more info
+* Prefix - prefix displayed in nametag, it will be referred to as `tagprefix`
+* Suffix - suffix displayed in nametag, it will be referred to as `tagsuffix`
+* Nametag visibility rule
+* Collision rule
+* Team color (1.13+) - used to set name and glow color (check out [How to make TAB compatible with glow plugins](https://github.com/NEZNAMY/TAB/wiki/How-to-make-TAB-compatible-with-glow-plugins)) (on 1.12- it uses last color of prefix).
+
+When enabling this feature, TAB will control all of these. It is not possible to take values from 2 different teams (plugins). Most of the compatibility problems with other plugins can be solved with placeholders. If you want sorting but not nametags, just don't configure any prefix/suffix. If you want another plugin to handle teams, configure sorting in that plugin.
+
+This feature can be configured in **config.yml** under **scoreboard-teams** section.
+
+# Configuration
+## Groups and users
+Properties can be applied in 2 ways: groups and users. Users can be defined by both username and their UUID. Values applied to users take priority over groups.
+
+**groups.yml**
+```
+admin:
+  tagprefix: "&4&lAdmin &r"
+```
+
+This can also be achieved with commands, in this case `/tab group admin tagprefix "&4&lAdmin &r"`.
+
+**users.yml**
+```
+_NEZNAMY_:
+  tagprefix: "&6&lTAB &r"
+
+# An alternate way using UUID
+237d8b55-3f97-4749-aa60-e9fe97b45062:
+  tagprefix: "&6&lTAB &r"
+```
+This can also be achieved with commands, in this case `/tab player _NEZNAMY_ tagprefix "&4&lAdmin &r"` or `/tab playeruuid _NEZNAMY_ tagprefix "&4&lAdmin &r"`.
+
+Properties can also be set as "default" for everyone who does not have them defined.
+For that purpose, a group keyword `_DEFAULT_` was made.
+Example:
+**groups.yml**
+```
+admin:
+  tagprefix: "&4&lAdmin &r"
+_DEFAULT_:
+  tagprefix: "&7" # This will be displayed on everyone except admin
+```
+
+## Per-world / per-server
+Values can also be applied per-world (and per-server on bungeecord), where they can be defined per group/user. These values take priority over global settings. Example:  
+**groups.yml**
+```
+per-world:
+  world1:
+    _DEFAULT_:
+      tagprefix: "&a" # Everyone in world "world1" will have this prefix
+per-server:
+  server1:
+    _DEFAULT_:
+      tagprefix: "&a" # Everyone in server "server1" will have this prefix
+```
+
+For multiple worlds/servers to share the same settings, separate them with a`;`.  
+For worlds/server starting with a specified text, use `*` after shared part. For ending with a shared part, use `*` at the beginning.  
+Example:
+```
+per-world:
+  world1;world2:
+    _DEFAULT_:
+      tagsuffix: "Shared tagsuffix in worlds world1 and world2"
+  lobby-*:
+    _DEFAULT_:
+      tagsuffix: "Suffix in all worlds starting with lobby-"
+```
+
+## Priority system
+The full list of priorities looks like this:
+1. value set using the [API](#api)
+2. per-world / per-server applied to username
+3. value applied to username
+4. per-world / per-server applied to uuid
+5. value applied to uuid
+6. per-world / per-server applied to player's group
+7. per-world / per-server applied to group `_DEFAULT_`
+8. value applied to player's group
+9. value applied to group `_DEFAULT_`
+
+This list is browsed through until the first match is found. If no match is found, empty value is used.
+
+Values are taken independently of each other.
+This means you can set per-world tagprefix, but only keep one global tagsuffix, for example.
+
+You can see the source of a value displayed on player by using `/tab debug <player>` and checking "source"
+part of the value you are looking for.
+
+## Placeholder support
+All values fully support [TAB's internal placeholders](https://github.com/NEZNAMY/TAB/wiki/Placeholders#internal-placeholders) and [PlaceholderAPI placeholders](https://github.com/PlaceholderAPI/PlaceholderAPI/wiki/Placeholders) including relational placeholders.
+The number of placeholders is not limited, and they can be used in combination with static text as well.
+
+## Additional settings
+| Option name                 | Default value         | Description                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                               |
+|-----------------------------|-----------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
+| enabled                     | true                  | Enables / Disables the feature                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            |
+| enable-collision            | true                  | Controls collision rule. Available values are: <br />- `true` - Collision will be enabled permanently. <br />- `false` - Collision will be disabled permanently. <br /> - *Conditional expression* - Collision will be enabled if player meets the condition (for example `%world%=world` will result in collision only being enabled for players in world `world`). <br /> - *Condition name* - Uses name of a [defined condition](https://github.com/NEZNAMY/TAB/wiki/Feature-guide:-Conditional-placeholders) that must be met for a player to have collision enabled. |
+| invisible-nametags          | false                 | When enabled, everyone will have invisible nametag all the time. Option to hide nametags was added in minecraft **1.8**, therefore it will not work on 1.7 and lower.                                                                                                                                                                                                                                                                                                                                                                                                     |
+| anti-override               | true                  | While enabled, prevents other plugins from assigning online players into teams and making TAB not work correctly. They should be configured to not use teams, however many users fail to disable features in other plugins that they don't want, making this option required. Some plugins don't even say they use teams to achieve their goals. Did you know even Paper uses teams?                                                                                                                                                                                      |
+| can-see-friendly-invisibles | false                 | Controlling value of the team flag. It allows you to see invisible players in the same team as transparent instead of completely invisible. Since TAB places each player into an individual team, this option will only take effect in combination with plugins that spawn a dummy clone of the player (sit or disguise plugins).                                                                                                                                                                                                                                         |
+| disable-condition           | %world%=disabledworld | A [condition](https://github.com/NEZNAMY/TAB/wiki/Feature-guide:-Conditional-placeholders) that must be met for disabling the feature for players. Set to empty for not disabling the feature ever.                                                                                                                                                                                                                                                                                                                                                                       |
+
+# Tips & Tricks
+If you want TAB to only take prefixes/suffixes from the permission plugin,
+delete all groups from **groups.yml** and only keep this:
+```
+_DEFAULT_:
+  tagprefix: "%luckperms-prefix%"
+  tagsuffix: "%luckperms-suffix%"
+```
+
+# Limitations
+* [1.5 - 1.12.2] Prefix/suffix length is limited to 16 characters (including color codes).
+* [1.13+] The name can only have one code. That is either color or magic code (such as &4 or &l), but not both.
+* The name cannot be effectively changed and the plugin doesn't offer it.
+* Name does not support RGB codes. Any used RGB colors will be rounded to the nearest legacy code.
+* The same value manages name color and glow color, which means they cannot be different.
+
+# Additional info
+## Additional note 1 - NPC (in)compatibility
+Teams are bound to player names, not uuids or entity ids.
+Because of that, they will affect all player entities with that name.
+This includes NPCs with the same names as online players, and prefixes/suffixes will be displayed on those as well.
+To avoid it, make their names not match any online player and use holograms to display them instead
+(Citizens plugin has an option for this).
+
+## Additional note 2 - Prefix/suffix on pets
+Since 1.9 teams affect tamed animals as well, displaying prefix/suffix on them as well and if nametags are set to be invisible, they will be completely invisible as well. If you want to avoid it, install [this plugin](https://www.spigotmc.org/resources/109466/).
+
+## Additional note 3 - Changing name itself
+Teams do not allow to change the nametag name itself.
+Changing name is a complicated process which is slightly out of scope of the plugin as well,
+this is what nick plugins are about.
+On top of that, it's a pain
+requiring a ton of different packets which change their structure every version and with how many versions the plugin supports,
+it doesn't sound like fun doing.
+
+## Additional note 4 - F1 view
+Using teams causes player nametags to remain visible when using F1 view.
+The plugin cannot avoid this in any way.
+The only possible solution would be to modify the client.
+
+## Additional note 5 - Transparent players
+Minecraft's teams can show players in the same team transparent (partially invisible).
+This requires both players (viewer and target) to be in the same team.
+As such, this effect is impossible to achieve with TAB,
+because it puts every player into a different team
+to properly sort players and give them different prefix/suffix in nametag
+(and more, such as collision and nametag visibility).
+
+If you want this effect, the only way is to use another plugin that offers this and disable TAB's teams entirely by setting
+```
+scoreboard-teams:
+  enabled: false
+```
+In config.yml. Keep in mind, you'll not be able to use any team features if you do so.
+
+# API
+*To get started with the API, see [Developer API](https://github.com/NEZNAMY/TAB/wiki/Developer-API) page.*
+
+To access this feature, you'll need to obtain `NameTagManager` instance. Get it using `TabAPI.getInstance().getNameTagManager()`. If this feature is disabled, the method will return `null`.
+
+## Changing prefix and suffix
+To set the values for the respective formatting, use the following:
+* `NameTagManager#setPrefix(TabPlayer, String)`
+* `NameTagManager#setSuffix(TabPlayer, String)`
+  To reset them, set values to `null`.
+
+To get custom values previously set using the API (they will return `null` if no custom value is set):
+* `NameTagManager#getCustomPrefix(TabPlayer)`
+* `NameTagManager#getCustomSuffix(TabPlayer)`
+
+To get the original value set by the plugin based on configuration:
+* `NameTagManager#getOriginalPrefix(TabPlayer)`
+* `NameTagManager#getOriginalSuffix(TabPlayer)`
+
+> [!NOTE]
+> These values are only temporary,
+> meaning they won't get saved anywhere and will get reset on player quit or plugin reload.
+> If you wish to save these values into file,
+> use [commands](https://github.com/NEZNAMY/TAB/wiki/Commands-&-Permissions#tab-playergroupplayeruuid-name-property-value-options).
+
+## Collision
+* `NameTagManager#getCollisionRule(TabPlayer)` - Returns forced collision rule using the API, `null` if no value was forced and player follows the configuration.
+* `NameTagManager#setCollisionRule(TabPlayer, Boolean)` - Forces collision rule to the player. Use `null` to reset value and make it follow configuration again.
+
+## Manipulating visibility
+* `NameTagManager#hideNametag(TabPlayer)` - Hides player's nametag from all players
+* `NameTagManager#hideNametag(TabPlayer, TabPlayer)` - Hides player's nametag from a specific player, where the first `TabPlayer` is the player whose nametag you want to hide, and the second `TabPlayer` is the player who you want to hide the first player's nametag from.
+* `NameTagManager#showNametag(TabPlayer)` - Shows player's nametag back again for everyone
+* `NameTagManager#showNametag(TabPlayer, TabPlayer)` - Shows player's nametag back. The first `TabPlayer` is the player whose nametag you want to show, and the second `TabPlayer` is the player who you want to show the first player's nametag to.
+* `NameTagManager#hasHiddenNametag(TabPlayer)` - Returns `true` if player has hidden nametag for everyone, `false` if not
+* `NameTagManager#hasHiddenNametag(TabPlayer, TabPlayer)` - Returns `true` if player has hidden nametag for specific player, `false` if not. The first `TabPlayer` is the player whose nametag you want to check is hidden, and the second `TabPlayer` is the player who you want to check if they can see the first player's nametag.
+
+## Disabling team handling
+* `NameTagManager#pauseTeamHandling(TabPlayer)` - Pauses team handling for a specific player. This will unregister the player's team and disable anti-override for teams.
+* `NameTagManager#resumeTeamHandling(TabPlayer)` - Resumes team handling for a specific player. This will register the player's team and enable anti-override for teams.
+* `NameTagManager#hasTeamHandlingPaused(TabPlayer)` - Returns `true` if handling is disabled using methods above, `false` if not.
@@ -0,0 +1,35 @@
+# Content
+* [About](#about)
+* [Configuration](#configuration)
+  * [Grouping playerlist from multiple worlds](#grouping-playerlist-from-multiple-worlds)
+
+# About
+This feature allows you to limit players you see in tablist to only players in your world, or in a group of worlds.  
+This feature can be configured in **config.yml** under **per-world-playerlist** section.  
+To use it, you need TAB installed on bukkit server. This feature is not available on BungeeCord.
+
+# Configuration
+| Option name                    | Default value | Description                                                                                                 |
+|--------------------------------|---------------|-------------------------------------------------------------------------------------------------------------|
+| enabled                        | false         | Enables / Disables the feature.                                                                             |
+| allow-bypass-permission        | false         | If enabled, players with `tab.bypass` permission will see everyone in tablist despite this feature enabled. |
+| ignore-effect-in-worlds        | *List*        | List of worlds where players will see everyone in tablist, not just players in the same world / world group |
+| shared-playerlist-world-groups | *Map*         | See [Grouping playerlist from multiple worlds](#grouping-playerlist-from-multiple-worlds)                   |
+
+## Grouping playerlist from multiple worlds
+In case you want multiple worlds to share playerlist despite this option enabled, create a group and put world names there. The default example
+```
+per-world-playerlist:
+  shared-playerlist-world-groups:
+    lobby:
+      - lobby1
+      - lobby2
+    minigames:
+      - paintball
+      - bedwars
+```
+Contains 2 groups, each of them consisting of 2 worlds.
+World group name can be anything (in our case, they're called "lobby" and "minigames").
+Under group name, list the actual world names.
+
+With this setup, "lobby1" and "lobby2" will share playerlist, as well as "paintball" with "bedwars". All other worlds will have playerlist not shared with any other worlds. Creating a group for 1 world only is completely useless.  
@@ -0,0 +1,26 @@
+# About
+By default, the server sends information about ping of players to everyone,
+which you can see in the tablist as the green bar.
+Some modified clients allow seeing the exact value instead of just bars.
+This feature spoofs the ping value of all players to the configured value, hiding their true ping.
+I don't know why anyone would want to do that.
+
+# Configuration
+Find this section in your **config.yml**
+```
+ping-spoof:
+  enabled: false
+  value: 0
+```
+To enable the feature, set `enabled: true`.  
+When the feature is enabled, everyone's ping value will be shown as value configured in `value` field.
+
+The ping intervals for bars are client sided and are as following:  
+| Ping value | Displayed icon |
+| ----------- | -------------- |
+| Negative | ![image](https://user-images.githubusercontent.com/6338394/179717654-add90ec7-1321-41a3-99e6-76420e665833.png)|
+| 0 - 149 | ![image](https://user-images.githubusercontent.com/6338394/179717531-3c6409b6-6bf8-41c1-a150-ce0ed615e5a5.png)|
+| 150 - 299 | ![image](https://user-images.githubusercontent.com/6338394/179717804-cfedfe33-7846-4b60-8559-be2b902b4a75.png)|
+| 300 - 599 | ![image](https://user-images.githubusercontent.com/6338394/179717915-0bccc83c-a2db-4459-9a76-58754f1307df.png)|
+| 600 - 999 | ![image](https://user-images.githubusercontent.com/6338394/179717996-eec0942a-17c9-44ff-9428-3137f76f50a4.png)|
+| 1000+ | ![image](https://user-images.githubusercontent.com/6338394/179718067-a3c86f83-cb57-436e-97ef-f3de394d9c41.png)|
@@ -0,0 +1,196 @@
+# Content
+* [About](#about)
+* [Configuration](#configuration)
+    * [Supported replacement patterns](#supported-replacement-patterns)
+        * [Pattern 1: Exact text](#pattern-1-exact-text)
+        * [Pattern 2: Number intervals](#pattern-2-number-intervals)
+        * [Pattern 3: else](#pattern-3-else)
+    * [Supported content in values](#supported-content-in-values)
+* [Using in other plugins](#using-in-other-plugins)
+* [Examples](#examples)
+    * [Example 1 - Adding brackets to placeholder output if it returns non-empty value](#example-1---adding-brackets-to-placeholder-output-if-it-returns-non-empty-value)
+    * [Example 2 - Replicating PlaceholderAPI's %player_colored_ping%](#example-2---replicating-placeholderapis-player_colored_ping)
+    * [Example 3 - Using both original and replaced output](#example-3---using-both-original-and-replaced-output)
+
+# About
+Most placeholders don't have fully configurable output, making you unable to customize it as you'd like.
+This is especially a problem with placeholders such as vanish or afk ones that return "yes"
+or "no" instead of some fancy text.
+It is a job of the plugins providing placeholders to allow control over outputs,
+but for plugins that don't we have a solution - now you're able to configure output of any placeholder in many ways.
+
+# Configuration
+Open **config.yml** and find this section:
+```
+placeholder-output-replacements:
+  <placeholder>:
+    <original output>: <new output>
+```
+
+## Supported replacement patterns
+
+### Pattern 1: Exact text
+If the placeholder's output is exact to the text on the left side, it will return text on the right side.
+<details>
+  <summary>Example</summary>
+
+```
+placeholder-output-replacements:
+  "%tps%":
+    "20": "Running at perfect 20 TPS!"
+  "%essentials_vanished%":
+    "yes": " &7[V]"
+    "no": ""
+```
+
+</details>
+
+> [!NOTE]
+> If you want to replace empty output, use `""` or `''` on the left side.
+
+> [!NOTE]
+> The text must match exactly, including color codes.
+> To check the color codes a placeholder returns use
+> [`/tab parse <player> <placeholder>`](https://github.com/NEZNAMY/TAB/wiki/Commands-&-Permissions#tab-parse-text)
+> and check "Without colors" part.
+
+### Pattern 2: Number intervals
+Output will be replaced if it's numeric and belongs in a configured interval.
+<details>
+  <summary>Example</summary>
+
+```
+placeholder-output-replacements:
+  "%tps%":
+    "15-20": "Solid"
+    "5-15": "Bad"
+    "0-5": "Terrible"
+```
+</details>
+
+> [!NOTE]
+> If a number is included in more than 1 interval (just like 5 and 15 from the example above), the one higher is used.
+> In this case, 15 would give `Solid` and 5 would give `Bad`.
+
+Intervals can be defined using both `-` and `~`.
+If you need support for negative values, use `~` for an interval instead of `-`.
+<details>
+  <summary>Example</summary>
+
+```
+placeholder-output-replacements:
+  "%my_negative_placeholder%":
+    "-100~-1": "Negative"
+    "0": "Zero"
+    "1-100": "Positive"
+```
+</details>
+
+### Pattern 3: else
+If none of the configured outputs are used and "else" is set, that value will be used instead.
+<details>
+  <summary>Example</summary>
+
+```
+placeholder-output-replacements:
+  "%tps%":
+    "20": "Running at perfect 20 TPS!"
+    "15-20": "Solid"
+    "5-15": "Bad"
+    "else": "Terrible" #0-5 in this case
+```
+</details>
+
+## Supported content in values
+You can use placeholders inside outputs, including the original placeholder you are altering.
+It will return the original output of the placeholder.
+<details>
+  <summary>Example</summary>
+
+```
+placeholder-output-replacements:
+  "%tps%":
+    "20": "Running at perfect 20 TPS!"
+    "15-20": "%tps% (Solid)"
+    "5-15": "%tps% (Bad)"
+    "else": "%tps% (Terrible)"
+```
+
+With this example, if TPS reaches, for example 17.5, the output would be `17.5 (Solid)`.
+</details>
+
+# Using in other plugins
+These replacements are only supported inside TAB. They won't work in other plugins.  
+If you want to use these in other plugins, you'll need to [enable tab's PlaceholderAPI expansion](https://github.com/NEZNAMY/TAB/wiki/Placeholders#placeholderapi) and use `%tab_replace_<placeholder>%`. If you, for example, configure output for %player_health%, use `%tab_replace_player_health%`.
+
+This only works for PlaceholderAPI placeholders, not TAB's internal ones. For TAB's internal ones use `%tab_placeholder_<placeholder>`, such as for %health% use `%tab_placeholder_health%`.
+
+# Examples
+## Example 1 - Adding brackets to placeholder output if it returns non-empty value
+When displaying faction or clan of players, you may want to add brackets if a player is in a faction/clan,
+but not show them if they are not in one.
+To achieve this,
+we are going to use [Pattern 1: Exact text](#pattern-1-exact-text) and [Pattern 3: else](#pattern-3-else).
+If the placeholder returned nothing, show nothing.
+Otherwise, show the output with added brackets:
+```
+placeholder-output-replacements:
+  "%my_placeholder%":
+    "": ""
+    "else": "[%my_placeholder%] "
+```
+Note that you'll need to match the placeholder output exactly. Not all clan/faction-like plugins return empty value when player doesn't have any. They may return just a color code, such as `&7`, in which case replacing empty value won't work. To see what the exact output of a placeholder is, use `/tab parse <player> <placeholder>` and check "Without colors" part. If that's the case, you'll need to change it on the left side. Example:
+```
+placeholder-output-replacements:
+  "%my_placeholder%":
+    "&7": ""
+    "else": "[%my_placeholder%] "
+```
+**Don't forget that parse command applies replacements, so when trying to see what placeholder returns, you should disable any previously configured replacements for that placeholder to see the correct raw output**.
+## Example 2 - Replicating PlaceholderAPI's %player_colored_ping%
+> [!NOTE]
+> Please note that this is just an example to demonstrate the plugin's functionality.
+> It is not supposed to discourage anyone from using PlaceholderAPI or any of its placeholders.*
+
+The placeholder allows you to configure intervals in config.yml. Default values are <50 for good, <100 for medium and 100+ for high. We can achieve this using [Pattern 2: Number intervals](#pattern-2-number-intervals) and [Pattern 3: else](#pattern-3-else). When put together, it looks as following:
+```
+placeholder-output-replacements:
+  "%ping%":
+    "0-50": "&a%ping%"
+    "51-100": "&e%ping%"
+    "else": "&c%ping%"
+```
+Keep in mind that now the placeholder will no longer return just a number,
+which can break features like [Playerlist Objective](https://github.com/NEZNAMY/TAB/wiki/Feature-guide:-Playerlist-Objective),
+which require a numeric input (for versions prior to 1.20.3).
+If you want that feature and ping to be displayed there, replacements won't work for you,
+and you'll need
+to use [Conditional placeholders](https://github.com/NEZNAMY/TAB/wiki/Feature-guide:-Conditional-placeholders) instead
+to achieve colored ping.
+
+# Example 3 - Using both original and replaced output
+Once configured, replacements are applied as the placeholder output everywhere. It is not directly possible to use original output in one place and replaced in another.
+
+If you need this, you should consider [conditional placeholders](https://github.com/NEZNAMY/TAB/wiki/Feature-guide:-Conditional-placeholders) instead.  
+If conditional placeholders are too complicated to use, there are alternate ways. The main point of the solution is to create different placeholder that eventually calls the same function and returns the same result. This can be done by "wrapping" the placeholder into another one. The easiest way using existing TAB's functions is using animations. Create an animation with a single frame that contains the placeholder and configure replacements for that placeholder instead.
+<details>
+  <summary>Example for %ping%</summary>
+
+**animations.yml**:
+```
+ping:
+  change-interval: 50 # Actual value doesn't matter
+  texts:
+    - "%ping%"
+```
+Then, configure replacements for the animation in **config.yml**:
+```
+placeholder-output-replacements:
+  "%animation:ping%":
+    "0-50": "&a%animation:ping%" # %ping% would work too
+    "51-100": "&e%animation:ping%"
+    "else": "&c%animation:ping%"
+```
+Now, you can use `%ping%` for original output and `%animation:ping%` for replaced.
+
+</details>
@@ -0,0 +1,34 @@
+# Content
+* [About](#about)
+* [Configuration](#configuration)
+* [Limitations](#limitations)
+* [Additional info](#additional-info)
+  * [Additional note 1 - Spectator gamemode](#additional-note-1---spectator-gamemode)
+
+# About
+The scoreboard objective with PLAYER_LIST display slot. On 1.20.2- it supports 2 display types:
+* yellow number  
+  ![](https://images-ext-1.discordapp.net/external/ioDTFWFe9qUGg8ZgNFCPIoXN6B-EnbqHb0WXE9200a8/https/image.prntscr.com/image/w8sjR4y9QhuaEcnU5tGTmw.png)
+* hearts  
+  ![](https://images-ext-2.discordapp.net/external/RxWu_5hBSLUWqS7vCvSPY9PnNxkYfAMQQXwkbi6GEyU/https/image.prntscr.com/image/edpM4XpOT1q3SsQ5vYNjzQ.png)
+
+Since 1.20.3, it can display any text.  
+![image](https://github.com/NEZNAMY/TAB/assets/6338394/2300b73e-d0cb-4eec-8ff1-e16be60bba49)
+
+This feature can be configured in **config.yml** under **playerlist-objective** section.
+
+# Configuration
+| Option name       | Default value         | Description                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                     |
+|-------------------|-----------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
+| enabled           | true                  | Enables / Disables the feature                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  |
+| value             | "%ping%"              | [1.20.2-] Defines value displayed. You can set this to any placeholder that outputs a number. Setting value to `%health%`, `%player_health%` or `%player_health_rounded%` will result in the display type being changed to hearts instead of number. If you want to display health but as a number and not hearts, set value to `0%health%` for example. Only visible on 1.20.2 and lower. <br/> **Note**: Even if you only support 1.20.3+, you still need to configure this value to properly evaluate to a number, because the value is still sent to the client (just not displayed). You can set it to `0` for simplicity. |
+| fancy-value       | "&7Ping: %ping%"      | [1.20.3+] Value to display for 1.20.3+ clients. Supports any text.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              |
+| disable-condition | %world%=disabledworld | A [condition](https://github.com/NEZNAMY/TAB/wiki/Feature-guide:-Conditional-placeholders) that must be met for disabling the feature for players. Set to empty for not disabling the feature ever.                                                                                                                                                                                                                                                                                                                                                                                                                             |
+
+# Limitations
+* [1.5 - 1.20.2] Only 2 display types are supported - yellow number and hearts.
+* [1.5 - 1.20.2] A yellow 0 will appear on all tablist entries that aren't actual players (such as NPCs and [layout](https://github.com/NEZNAMY/TAB/wiki/Feature-guide:-Layout) entries) and it cannot be removed.
+
+# Additional info
+## Additional note 1 - Spectator gamemode
+The feature will not be visible on players with spectator gamemode. To resolve this, check out [Spectator fix](https://github.com/NEZNAMY/TAB/wiki/Feature-guide:-Spectator-fix) feature.  
@@ -0,0 +1,318 @@
+# Content
+* [About](#about)
+* [Creating a scoreboard](#creating-a-scoreboard)
+  * [title](#title)
+  * [lines](#lines)
+    * [Alignment](#alignment)
+    * [Empty placeholder output](#empty-placeholder-output)
+  * [display-condition](#display-condition)
+* [Chaining scoreboards](#chaining-scoreboards)
+* [Announce command](#announce-command)
+* [Additional settings](#additional-settings)
+* [Limitations](#limitations)
+* [Longer lines](#longer-lines)
+* [Compatibility with other plugins](#compatibility-with-other-plugins)
+* [API](#api)
+  * [Creating custom scoreboards](#creating-custom-scoreboards)
+  * [Showing custom scoreboards](#showing-custom-scoreboards)
+  * [Toggling scoreboard visibility](#toggling-scoreboard-visibility)
+  * [Announcing a scoreboard](#announcing-a-scoreboard)
+* [Examples](#examples)
+  * [Example 1 - Per-world scoreboards](#example-1---per-world-scoreboards)
+  * [Example 2 - Periodical scoreboard switching](#example-2---periodical-scoreboard-switching)
+  * [Example 3 - Per-version scoreboards](#example-3---per-version-scoreboards)
+
+# About
+Scoreboard objective with SIDEBAR display slot.
+
+This feature can be configured in **config.yml** under **scoreboard** section.
+
+# Creating a scoreboard
+Scoreboards can be created in `scoreboards` section. You can define as many scoreboards as you want. Each scoreboard can have a condition requirement, which must be met to display the scoreboard. If it's not met, the next defined scoreboard is checked and so on. If the last defined scoreboard has a condition requirement which isn't met, player won't see anything.
+
+Each scoreboard defines up to 3 parameters:
+
+## title
+Title of the scoreboard.
+Limited to 32 characters on MineCraft versions below 1.13 (including color codes).
+It is automatically centered by the client.
+
+## lines
+Up to 15 lines of text. You can define more, but the client won't display them.
+
+Since 1.20.3, you can also configure the value on the right side, which no longer has to be a red number. To set it, use `||` sequence and put right-side text after it. Example:
+```
+      lines:
+      - "Left side text 1||Right side text 1"
+      - "Left side text 2....||Right side text 2...."
+      - "Left side text 3.......||Right side text 3......."
+```
+Will give you the following:  
+![image](https://github.com/NEZNAMY/TAB/assets/6338394/785e4e66-935c-4233-8a16-f3e34386cfd0)
+
+The right side text will not be visible at 1.20.2 and lower, and numbers will be displayed instead.
+To properly see the right side, not only the client has to be 1.20.3+, but the server as well,
+since the plugin cannot send a packet that does not exist (on older versions).
+Proxies always include new content and therefore count as the latest version.
+This can be used to send new content to new players while having an outdated server version.
+
+### Alignment
+The left side of the text is automatically aligned to the left,
+while the right side is automatically aligned to the right.
+This is done by the client and is out of plugin's control.
+If you want to center a line, you'll need to do it manually.
+If dynamic placeholder output length is preventing your from doing it,
+you can try to bypass it by adding spaces before and after it to artificially increase and force the scoreboard width,
+such as
+`- "          Centered text          "` (or more spaces if needed).
+
+### Empty placeholder output
+When a line consists only of a placeholder that returned empty output, the line will be hidden completely. This is intentional to allow dynamic scoreboard size based on placeholder output. This is not the case if empty line is configured (`""`), to allow empty lines in configuration.
+
+## display-condition
+A [condition](https://github.com/NEZNAMY/TAB/wiki/Feature-guide:-Conditional-placeholders) that must be met to display this scoreboard. If it isn't met for the player, the next scoreboard's condition is checked.
+
+# Chaining scoreboards
+When defining more than 1 scoreboard in config, the plugin will display the correct scoreboard based on conditions.
+The plugin goes through all defined scoreboards, starting with the scoreboard on top.
+If the scoreboard's condition is met or not set, it is displayed.
+If not, the next defined scoreboard is checked and so on.
+If no suitable scoreboard is found (the last one has a condition requirement which wasn't met), none is displayed.
+Example:
+```
+  scoreboards:
+    scoreboard1:
+      display-condition: "permission:tab.scoreboard.admin"
+      title: "Title 1"
+      lines:
+        - "Scoreboard for admins"
+    scoreboard2:
+      display-condition: "%world%=myWorld"
+      title: "Title 2"
+      lines:
+        - "Scoreboard in world myWorld"
+    scoreboard3:
+      title: "Title 3"
+      lines:
+        - "Line 1"
+```
+Scoreboard `scoreboard1` is checked first. If condition is not met, `scoreboard2` is checked. If that condition is not met, `scoreboard3` is displayed.  
+If a player meets both conditions (has defined permission and is in defined world), `scoreboard1` will be displayed, because it is defined first and therefore has the highest priority. You can switch scoreboards based on your priority needs.
+
+# Announce command
+This takes priority over the current scoreboard.
+Once the announcement is over, the previous scoreboard is restored.  
+`/tab announce scoreboard <name> <time>`  
+name - name of scoreboard to be displayed  
+time - number of seconds to display the scoreboard for
+
+# Additional settings
+| Option name                | Default value | Description                                                                                                                                                                                                                                                                                                                                                                                                                                                |
+|----------------------------|---------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
+| enabled                    | false         | Enables / Disables the feature                                                                                                                                                                                                                                                                                                                                                                                                                             |
+| toggle-command             | /sb           | Command that can be used to toggle scoreboard for the player running the command. Players need `tab.scoreboard.toggle` permission to use it. <br />**Note:** This command will not appear in command auto-complete, because it's not a real registered command. Registered commands must be defined in plugin jar directly and cannot be dynamic. If you want to solve this, you can try getting a dummy private plugin made which registers that command. |
+| remember-toggle-choice     | false         | When enabled, toggling decision is saved into a file to remember it even after reloads/restarts/reconnects                                                                                                                                                                                                                                                                                                                                                 |
+| hidden-by-default          | false         | If enabled, scoreboard will automatically be hidden on join until toggle command is used to show it.                                                                                                                                                                                                                                                                                                                                                       |
+| use-numbers                | false         | If enabled, numbers 1-15 will be used in the scoreboard. If disabled, `static-number` is shown everywhere.                                                                                                                                                                                                                                                                                                                                                 |
+| static-number              | 0             | If `use-numbers` is disabled, this is number to be in all lines.                                                                                                                                                                                                                                                                                                                                                                                           |
+| delay-on-join-milliseconds | 0             | Delay in milliseconds to send scoreboard after joining.                                                                                                                                                                                                                                                                                                                                                                                                    |
+
+# Limitations
+* [1.5 - 1.12.2] The title is limited to 32 characters (including color codes).
+* [1.5 - 1.12.2] Line length is limited to 28 characters (including color codes) (68 on lines with static text / [Longer lines](#longer-lines)).
+* [1.5 - 1.20.2] The red numbers on the right really cannot be removed from the plugin side (a client modification / resource pack is necessary).
+* The client only displays up to 15 lines. If a plugin sends more, only the top 15 scores will be displayed. Changing this would require a client modification.
+
+# Longer lines
+To make sure the scoreboard never flickers, it's only using prefix/suffix components to display text.
+These can easily be changed without any visual issues.
+The player name part, however, cannot be changed.
+A line has to be completely removed and a new one added.
+There's a chance a frame is rendered between these 2 packets are sent,
+causing the scoreboard to have 1 line missing for 1 frame, causing the visual issue known as "flickering".
+
+However,
+if your scoreboard only has placeholders that don't change value often
+(pretty much any placeholder except animations, really),
+you can make TAB use player name part,
+allowing you to use an additional up to 40 characters.
+To do so, add `Long|` prefix to all lines that should use this bypass.
+```
+      lines:
+        - "Classic line with shorter limit"
+        - "Long|Long line with much higher character limit"
+```
+This bypass is automatically enabled for all lines that only use static text
+(since there's nothing to refresh and cause flickering),
+therefore doing it for such lines (like in the example above) has no effect.
+
+# Compatibility with other plugins
+TAB automatically detects scoreboard coming from other plugins, and when one is sent, TAB hides its own scoreboard.
+Later, when the other plugin hides its scoreboard, TAB will send its scoreboard back to the player.
+
+This detection must be available on your platform.
+For that,
+see the Scoreboard section on [compatibility page](https://github.com/NEZNAMY/TAB/wiki/Compatibility#supported-features-per-platform).
+If it says ✔, the detection is available.
+If it says ❗, it means this detection is not available on your platform.
+As a result, when the other plugin hides its scoreboard, TAB will not be able to resend its own.
+
+If you want this detection,
+and it's not supported by your platform,
+you can achieve it
+using an alternate solution with conditions that will make TAB display no scoreboard if the condition is not met.
+For this, you'll need to have more information about when exactly do plugins send scoreboards and how to detect it.
+
+<details>
+  <summary>Example using PremiumVanish</summary>
+
+When you are vanished using PremiumVanish plugin, placeholder `%premiumvanish_isvanished%` will return `Yes` instead of the usual `No`. You can put this as a display condition to all defined scoreboards.  
+An original
+```
+  scoreboards:
+    scoreboard1:
+      title: Default
+      lines:
+      - 'Line of text'
+```
+would turn into
+```
+  scoreboards:
+    scoreboard1:
+      display-condition: "%premiumvanish_isvanished%=No"
+      title: Default
+      lines:
+      - 'Line of text'
+```
+Remember to add this condition to all of your scoreboards if you have more than 1
+(for those with an existing condition merge them using `;`).  
+Keep in mind [placeholder output replacements](https://github.com/NEZNAMY/TAB/wiki/Feature-guide:-Placeholder-output-replacements) apply to placeholders here as well,
+so if you configured a fancy output for that placeholder, you'll need to use it in the display condition as well.
+To see what exactly has placeholder returned, use `/tab parse <player> <placeholder>`.
+</details>
+
+# API
+*To get started with the API, see [Developer API](https://github.com/NEZNAMY/TAB/wiki/Developer-API) page.*
+
+To access this feature, you'll need to obtain `ScoreboardManager` instance. Get it using `TabAPI.getInstance().getScoreboardManager()`. If this feature is disabled, the method will return `null`.
+
+## Creating custom scoreboards
+You can create and register new scoreboards using `ScoreboardManager#createScoreboard(String, String, List<String>)`, where the first `String` is the name, the second `String` is the title that will be displayed, and the `List<String>` is the list of lines that the scoreboard will display.
+
+## Showing custom scoreboards
+To show your new scoreboard to a player, you can use `ScoreboardManager#showScoreboard(TabPlayer, Scoreboard)`, where the `TabPlayer` is the player you want to show the scoreboard to, and the `Scoreboard` is the scoreboard you want to show. Doing this will also disable automatic scoreboard updating for the player, so that your scoreboard does not get overridden until you unregister it.  
+To reset the scoreboard that a player is using to the default scoreboard that they should be seeing as determined by the config, use `ScoreboardManager#resetScoreboard(TabPlayer)`.  
+To determine whether a player has a custom scoreboard set (one that was shown through the API), use `ScoreboardManager#hasCustomScoreboard(TabPlayer)`.
+
+## Toggling scoreboard visibility
+To change whether a player can see scoreboards, use `ScoreboardManager#setScoreboardVisible(TabPlayer, boolean, boolean)`, and to determine whether a player can see scoreboards, use `ScoreboardManager#hasScoreboardVisible(TabPlayer)`.  
+To toggle whether a player can see scoreboards, use `ScoreboardManager#toggleScoreboard(TabPlayer, boolean)`. This will either make scoreboards visible if they are not already, or make them hidden if they are currently visible.
+
+## Announcing a scoreboard
+To announce a scoreboard to all players on the server for a given number of ticks,
+use `ScoreboardManager#announceScoreboard(String, int)`,
+which will look up a scoreboard with the given `String` name,
+and if one is found, send it to all players for the given `int` ticks.
+
+# Examples
+## Example 1 - Per-world scoreboards
+We will be using a condition of "equals" (=) type and check for output of `%world%` placeholder.
+If condition is met, it means player is in that world and the scoreboard is displayed.
+If not, check for the next scoreboard's condition.
+If none of the conditions are met, display the default scoreboard.
+```
+  scoreboards:
+    # start
+    scoreboard1:
+      display-condition: "%world%=world1"
+      title: 'Scoreboard 1'
+      lines:
+      - 'You are in world world1'
+    # first condition didn't pass, try next
+    scoreboard2:
+      display-condition: "%world%=world2"
+      title: 'Scoreboard 2'
+      lines:
+      - 'You are in world world2'
+    # first two conditions didn't pass, try next
+    scoreboard3:
+      display-condition: "%world%=world3"
+      title: 'Scoreboard 3'
+      lines:
+      - 'You are in world world3'
+    # none of the conditions above passed, display default scoreboard
+    default:
+      title: 'Default scoreboard'
+      lines:
+      - 'You are not in any of the worlds listed above'
+```
+> [!NOTE]
+> This is just an example, the plugin is not limited to displaying scoreboard only per world.
+> If you want per server scoreboards on proxy, use %server% with server names.
+> If you want worldguard regions, use %worldguard_region_name% with region names.
+> This works for any placeholder offered by the plugin or by PlaceholderAPI.
+
+## Example 2 - Periodical scoreboard switching
+We can use [animations](https://github.com/NEZNAMY/TAB/wiki/Animations) to make the plugin switch between scoreboards using display condition. Let's say we want to switch between 2 scoreboards. First, we create an animation:  
+**animations.yml**
+```
+switchingScoreboard:
+  change-interval: 10000
+  texts:
+  - "1"
+  - "2"
+```
+This animation will switch frames every 10 seconds.  
+Then, we will use the output of this animation as a display condition.
+If animation is on the first frame, display the first scoreboard.
+Otherwise, display the second scoreboard.
+Result:
+**config.yml**
+```
+  scoreboards:
+    scoreboard1:
+      display-condition: "%animation:switchingScoreboard%=1" # If animation is on the first frame
+      title: "Scoreboard 1"
+      lines:
+      - 'Text'
+    # Animation is on the second frame
+    scoreboard2:
+      title: "Scoreboard 2"
+      lines:
+      - 'Text'
+```
+We don't need to define display condition for the second scoreboard,
+since if animation is not on the first frame, it has to be on the second one.
+If using more than 2, you will need to define display condition for all of them (except the last one).
+
+# Example 3 - Per-version scoreboards
+1.20.3 has added new features to scoreboards, which are not visible to older clients. If you want to use new features for new players while still displaying things properly for older players, you'll need to create 2 different scoreboards.  
+You'll find 2 placeholders useful for this:
+* `%player-version-id%` - Returns network ID of player's protocol version. Unlike with version names, you can perform numerical comparisons with these. You can find all version IDs [here](https://github.com/NEZNAMY/TAB/blob/master/shared/src/main/java/me/neznamy/tab/shared/ProtocolVersion.java). For example, 1.20.3 is 765.
+* `%bedrock%` - Returns `true` if player is using the bedrock edition, which does not support new functions either.
+
+We only want the first scoreboard for players with version 765 or greater and not bedrock players. This can be achieved with the following condition: `display-condition: "%player-version-id%>=765;%bedrock%=false"`.
+
+Let's go ahead and set it up (with proper spacing):
+```
+  scoreboards:
+    scoreboard-1.20.3+:
+      title: "Scoreboard for 1.20.3+ and not bedrock"
+      display-condition: "%player-version-id%>=765;%bedrock%=false" # Only display it to players using 1.20.3+ AND NOT bedrock edition
+      lines:
+        - "* &eOnline&7:||%online%"
+        - "* &eCurrent World&7:||%worldonline%"
+        - "* &eStaff&7:||%staffonline%"
+        - "* &bRank&7:||%group%"
+        - "* &bPing&7:||%ping%&8ms"
+        - "* &bWorld&7:||%world%"
+    scoreboard:
+      title: "Scoreboard for <1.20.3 and bedrock"
+      lines:
+        - "* &eOnline&7: &f%online%"
+        - "* &eCurrent World&7: &f%worldonline%"
+        - "* &eStaff&7: &f%staffonline%"
+        - "* &bRank&7: &f%group%"
+        - "* &bPing&7: &f%ping%&8ms"
+        - "* &bWorld&7: &f%world%"
+```
@@ -0,0 +1,257 @@
+# Content
+* [Enabling](#enabling)
+* [Methods of sorting](#methods-of-sorting)
+  * [GROUPS](#groups)
+  * [PERMISSIONS](#permissions)
+  * [PLACEHOLDER](#placeholder)
+  * [PLACEHOLDER_A_TO_Z](#placeholder_a_to_z)
+  * [PLACEHOLDER_Z_TO_A](#placeholder_z_to_a)
+  * [PLACEHOLDER_LOW_TO_HIGH](#placeholder_low_to_high)
+  * [PLACEHOLDER_HIGH_TO_LOW](#placeholder_high_to_low)
+* [Multiple elements with the same priority](#multiple-elements-with-the-same-priority)
+* [Combining multiple sorting types](#combining-multiple-sorting-types)
+* [Additional settings](#additional-settings)
+* [Additional info](#additional-info)
+  * [Additional note 1 - Limitations](#additional-note-1---limitations)
+  * [Additional note 2 - per-world sorting](#additional-note-2---per-world-sorting)
+  * [Additional note 3 - Compatibility issues with other plugins](#additional-note-3---compatibility-issues-with-other-plugins)
+* [Common mistakes](#common-mistakes)
+* [API](#api)
+
+# Enabling
+To enable sorting, you must have either [Nametags](https://github.com/NEZNAMY/TAB/wiki/Feature-guide:-Nametags) or [Layout](https://github.com/NEZNAMY/TAB/wiki/Feature-guide:-Layout) (or both) enabled.
+
+> [!TIP]
+> To verify you enabled sorting, run `/tab debug`. It will say `Sorting type:` followed by anything except `DISABLED`.
+
+# Methods of sorting
+Below are all the different methods that you can use to sort players.
+
+## GROUPS
+This is the default and recommended method. Players will be sorted by their primary permission group, according to the configured group list.
+
+First, put your players into groups in your permission plugin.
+All the ways to do it can be found
+at [How to assign players into groups](https://github.com/NEZNAMY/TAB/wiki/How-to-assign-players-into-groups).
+> [!TIP]
+> Verify player's group using `/tab debug <player>`.
+It should say `Primary permission group:` followed by group you configured.
+If not, you did not assign players into groups correctly.
+
+Second, place all of your groups in to a comma separated list **in order of priority** into `sorting-types`. Example:
+```yaml
+scoreboard-teams:
+  sorting-types:
+    - "GROUPS:owner,admin,mod,default"
+```
+> [!TIP]
+> Verify configured sorting priority of players using `/tab debug <player>`.
+
+It should show a message like this:  
+![image](https://github.com/NEZNAMY/TAB/assets/6338394/095d8523-e8c0-4eff-8935-b0b8e6e0d5ff)
+
+If a group is not in the list, you will get the following:  
+![image](https://github.com/NEZNAMY/TAB/assets/6338394/9c530873-87c9-4db7-8916-a6121dbeed37)  
+If that's the case, you forgot to add that group into the list.
+
+## PERMISSIONS
+> [!CAUTION]
+> This method is not recommended,
+> as many low quality servers give OP to every staff member and don't know how to negate permissions,
+> making this option not function as intended.
+> If you think you can pull it off, and sorting by primary group is not an option, you can give this a try.  
+This method is, however, handy when trying to sort specific players without assigning them into a group.
+
+This method will sort players based on permission nodes they have.  
+Place all of your permissions in to a comma separated list **in order of priority**.  
+For example, if you have the permissions `my.permission.1`, `my.permission.2`, `my.permission.3`, and want to have players sorted in that order, you would end up with a configuration like `PERMISSIONS:my.permission.1,my.permission.2,my.permission.3`.  
+Example:
+```yaml
+scoreboard-teams:
+  sorting-types:
+    - "PERMISSIONS:my.permission.1,my.permission.2,my.permission.3"
+```
+> [!TIP]  
+> Verify sorting permissions of a player using `/tab debug <player>`
+
+## PLACEHOLDER
+This method sorts players using the output of a placeholder and comparing that to pre-defined values.  
+To configure this sorting type, write the placeholder that you want to use, followed by a colon (`:`), followed by a comma separated list of outputs to check against.  
+For example, if you want to sort players using the output of the `%essentials_afk%` placeholder, depending on whether it is `yes` or `no`, you would do that using a configuration such as `PLACEHOLDER:%essentials_afk%:no,yes`, where players who the placeholder outputs `no` for will be sorted above players who the placeholder outputs `yes` for in this case, putting AFK players on the bottom.  
+Example:
+```yaml
+scoreboard-teams:
+  sorting-types:
+    - "PLACEHOLDER:%essentials_afk%:no,yes"
+```
+
+## PLACEHOLDER_A_TO_Z
+This method sorts players alphabetically, according to the output of a placeholder.  
+To configure this sorting type, write the placeholder that you want to use. That's it.  
+For example, if you want to sort players by their name alphabetically, you would do that using a configuration such as `PLACEHOLDER_A_TO_Z:%player%`.  
+Example:
+```yaml
+scoreboard-teams:
+  sorting-types:
+    - "PLACEHOLDER_A_TO_Z:%player%"
+```
+
+## PLACEHOLDER_Z_TO_A
+This method sorts players reverse alphabetically, according to the output of a placeholder.  
+This is identical to the above A to Z sorting, except that the alphabet is backwards, so Z comes first, and A comes last.  
+To configure this sorting type, write the placeholder that you want to use. That's it.  
+For example, if you want to sort players by their name reverse alphabetically, you would do that using a configuration such as `PLACEHOLDER_Z_TO_A:%player%`.  
+Example:
+```yaml
+scoreboard-teams:
+  sorting-types:
+    - "PLACEHOLDER_Z_TO_A:%player%"
+```
+
+## PLACEHOLDER_LOW_TO_HIGH
+This method sorts players numerically depending on the output of a **numeric** placeholder from the lowest value to the highest value.  
+**Only placeholders that output number values will work with this sorting type!**  
+Supported number interval is from -1,000,000,000 to 1,000,000,000 and 5 decimal places.  
+To configure this sorting type, write the placeholder that you want to use. That's it.  
+For example, if you want to sort players using the output of the `%health%` placeholder from the lowest health to highest, you would do that using a configuration such as `PLACEHOLDER_LOW_TO_HIGH:%health%`.  
+Example:
+```yaml
+scoreboard-teams:
+  sorting-types:
+    - "PLACEHOLDER_LOW_TO_HIGH:%health%"
+```
+
+## PLACEHOLDER_HIGH_TO_LOW
+This method sorts players numerically depending on the output of a **numeric** placeholder from the highest value to the lowest value.  
+**Only placeholders that output number values will work with this sorting type!**  
+Supported number interval is from -1,000,000,000 to 1,000,000,000 and 5 decimal places.  
+To configure this sorting type, write the placeholder that you want to use. That's it.  
+For example, if you want to sort players using LuckPerms weights, you would do that using a configuration such as `PLACEHOLDER_HIGH_TO_LOW:%luckperms_highest_group_weight%`.  
+Example:
+```yaml
+scoreboard-teams:
+  sorting-types:
+    - "PLACEHOLDER_HIGH_TO_LOW:%luckperms_highest_group_weight%"
+```
+
+# Multiple elements with the same priority
+If using a sorting type that uses pre-defined values ([GROUPS](#groups), [PERMISSIONS](#permissions) or [PLACEHOLDER](#placeholder)), you can sort multiple elements with the same priority by separating them with `|` symbol. Example using group sorting:
+```
+scoreboard-teams:
+  sorting-types:
+    - "GROUPS:owner,admin,vip1|vip2,default"
+```
+Where `vip1` and `vip2` will be sorted with the same priority (3rd).  
+This works for permissions and pre-defined placeholder values as well.
+
+# Combining multiple sorting types
+Since `sorting-types` is a list, you are able to use more than one sorting type. Sorting type priorities go in the same order as defined in the config. Let's take a look at the default config:
+```
+  sorting-types:
+    - "GROUPS:owner,admin,mod,helper,builder,vip,default"
+    - "PLACEHOLDER_A_TO_Z:%player%"
+```
+Here, players are sorted by their group first.
+Owner goes above admin etc. However,
+if 2 people have the same group (such as admin), the next sorting type decides the final order.
+In this case, admin with alphabetically lower username will be higher in the tablist.
+
+A common request is putting AFK players on the bottom of tablist. This can be achieved with the following configuration:
+```
+  sorting-types:
+    - "PLACEHOLDER:%essentials_afk%:no,yes"
+    - "GROUPS:owner,admin,mod,helper,builder,vip,default"
+    - "PLACEHOLDER_A_TO_Z:%player%"
+```
+With AFK status taking the highest priority, AFK players will always be sorted below players which are not AFK.
+Both player groups (afk and non-afk) then follow the rest of the logic explained above to define the final order.
+If trying to copy-paste this example, keep
+in mind [Placeholder output replacements](https://github.com/NEZNAMY/TAB/wiki/Feature-guide:-Placeholder-output-replacements) work here as well,
+so if you are using a fancier output for %essentials_afk%,
+you will need to use outputs respectively when defining sorting as well.
+
+Although you can theoretically use as many sorting types as you want, there are still strict limits set by mojang. See more about these limits and how to avoid them as much as possible at [Additional note 1 - Limitations](#additional-note-1---limitations).
+
+# Additional settings
+| Option name            | Default value | Description                                                            |
+|------------------------|---------------|------------------------------------------------------------------------|
+| case-sensitive-sorting | true          | When enabled, players will be sorted as A-Z a-z. When disabled, Aa-Zz. |
+
+# Additional info
+## Additional note 1 - Limitations
+All sorting elements must together build a team name up to 16 characters long. Because of that, cuts in placeholder outputs may be required. TAB is already using the shortest possible values for all sorting types:
+* `GROUPS`, `PERMISSIONS` and `PLACEHOLDER` - 1 character
+* `PLACEHOLDER_LOW_TO_HIGH` and `PLACEHOLDER_HIGH_TO_LOW` - 3 characters
+* `PLACEHOLDER_A_TO_Z` and `PLACEHOLDER_Z_TO_A` - as many as used
+
+All your sorting types must be within a 15-character limit.
+Any characters above that will be cut off (TAB reserves 1 character to ensure each player is in a unique team).
+To get the most out of it, use the 1-character sorting types where possible.
+
+You can bypass this limit by using [Layout](https://github.com/NEZNAMY/TAB/wiki/Feature-guide:-Layout) feature.
+Player ordering is fully plugin-sided and therefore is not artificially limited.
+
+## Additional note 2 - per-world sorting
+Defining a per-world sorting type is not supported.
+However,
+this can be achieved with [Conditional placeholders](https://github.com/NEZNAMY/TAB/wiki/Feature-guide:-Conditional-placeholders).
+Check for %world% and return one placeholder if it matches, another one if not.
+This will work with anything, not just worlds (server, regions, etc.).
+
+## Additional note 3 - Compatibility issues with other plugins
+As you already know by now, sorting is managed by scoreboard teams (their names to be exact).
+Player can only be a member of one team.
+In other words, only one plugin can handle teams at a time.
+Having multiple plugins handling teams is supposed to end in a disaster.
+
+Fortunately, TAB contains a function that prevents other plugins from assigning players into teams.
+This can be enabled/disabled by toggling `anti-override` setting under `scoreboard-teams`.
+This is, however, highly recommended to keep enabled, unless all of your plugins are configured correctly.
+When a plugin tries to override TAB's teams, this action is logged into `anti-override.log` file.
+If your file is empty / does not exist, it means you have no conflicting plugins / settings and can disable this option,
+slightly boosting performance.
+If the file exists, most of the time you can guess where the teams come from by their name.  
+Here are a few common teams and their sources (`xxxx` means any, usually random character sequence):
+* `collideRule_xxxx` - this comes from Paper. Not going to explain why as that would be quite long, but the way you can avoid is by setting `enable-player-collisions: true` in paper config and `enable-collision: false` in TAB config (yes, collisions will be disabled).
+* `CMINPxx` - CMI, set `DisableTeamManagement: true` in `plugins/CMI/config.yml`.
+* `CIT-xxxxxxxxxxxx` - Citizens NPC with the same name as some online player. Make NPC names not match real players and use holograms to display your desired text (/npc name or something).
+* `PVP-xxxxxxxxxxxx` - Team coming from [PvPManager](https://www.spigotmc.org/resources/pvpmanager-lite.845/) plugin.
+
+This detection, however, is not 100%.
+Because of that, you may still be experiencing a compatibility issue even with anti-override enabled.
+To identify such an issue, check if /tab reload fixes your sorting issue.
+If it does, it's a compatibility issue of some sort.
+If not, it is most likely a misconfiguration issue.
+
+# Common mistakes
+Every possible mistake could be called "not reading this wiki page", but that would make this section pointless.
+For that reason, let's call it list of mistakes made when following this page.
+
+The most common mistakes include:
+* Disabling both teams and layout, not realizing it disables sorting as well.
+* Disabling anti-override without disabling teams in other plugins.
+* Mistaking `primary-group-finding-list` for the sorting list, despite that list having nothing to do with sorting and by default even having a comment above it saying it has nothing to do with sorting.
+* Not configuring primary groups correctly. This can have multiple reasons, such as
+  * Not configuring group weights in LuckPerms.
+  * Accidentally enabling `use-bukkit-permission-manager` option when on BungeeCord without knowing what it does.
+  * Installing TAB on BungeeCord without having any permission plugin on BungeeCord.
+  * Enabling `assign-groups-by-permissions` without giving those permissions (or the opposite - giving away OP to users, resulting in the highest group being taken).
+
+  [Debug command](https://github.com/NEZNAMY/TAB/wiki/Commands-&-Permissions#tab-debug-player) will help you identify if this is your case.
+* Using a plugin that causes TAB to fail to apply teams (such as Tablisknu). This includes installing TAB plugin on both bukkit and bungeecord, causing the installations to conflict.
+
+# API
+*To get started with the API, see [Developer API](https://github.com/NEZNAMY/TAB/wiki/Developer-API) page.*
+
+To access this feature, you'll need to obtain `SortingManager` instance. Get it using `TabAPI.getInstance().getSortingManager()`. If sorting is disabled, the method will return `null`.
+
+You can change player's team name using the following methods:
+* `SortingManager#forceTeamName(TabPlayer, String)` - Sets player's team name to specified value (and performs team unregister & register with new name).
+* `SortingManager#getForcedTeamName(TabPlayer)` - Returns player's forced team name using the method above. Will return `null` if no value is set.
+
+Unfortunately, there is no simple way of just changing one's position while still accounting for other players.
+This is because the plugin supports a lot of sorting options, not just groups,
+so doing amateur stuff like "priority 1, 2" doesn't make sense.
+If you are really only interested in sorting by groups and changing group which player is sorted as,
+you can use `TabPlayer#setTemporaryGroup(String)`.
+To reset the group back to normal, call the function with `null` argument.
@@ -0,0 +1,31 @@
+# Content
+* [About](#about)
+* [Enabling](#enabling)
+* [Permissions](#permissions)
+* [Additional info](#additional-info)
+  * [Additional note 1 - Seeing yourself still as spectator](#additional-note-1---seeing-yourself-still-as-spectator)
+
+# About
+With the introduction of spectator gamemode in 1.8,
+players having it automatically appear on the bottom of tablist with transparent name and missing [Playerlist Objective](https://github.com/NEZNAMY/TAB/wiki/Feature-guide:-Playerlist-Objective).
+This feature cancels gamemode change packets to spectator gamemode, cancelling this minecraft feature.
+
+# Enabling
+To enable this feature, open **config.yml** and set
+```
+prevent-spectator-effect:
+  enabled: true
+``` 
+
+# Permissions
+| Permission            | Description                                                                                                                                                                                                   |
+|-----------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
+| `tab.spectatorbypass` | Players with this permission will see spectators the usual way despite this feature being enabled. If you don't want players (or even staff members) to bypass this feature, don't give them that permission. |
+
+# Additional info
+## Additional note 1 - Seeing yourself still as spectator
+Receiving information about going spectator gamemode allows players to clip through walls.
+Cancelling this on self would result in inability to go through walls.
+To avoid this, the information will be canceled for every player except the one going spectator gamemode.
+Therefore, if you change gamemode to spectator, you will still see yourself on the bottom,
+but no one else will (unless someone has the bypass permission).
@@ -0,0 +1,163 @@
+# Content
+* [About](#about)
+* [Configuration](#configuration)
+  * [Introduction](#introduction)
+  * [Groups and users](#groups-and-users)
+  * [Per-world / per-server](#per-world--per-server)
+  * [Priority system](#priority-system)
+  * [Placeholder support](#placeholder-support)
+  * [Additional settings](#additional-settings)
+* [Tips & Tricks](#tips--tricks)
+* [API](#api)
+
+# About
+This feature allows you to configure player name formats in the tablist.
+It was added to minecraft in version 1.8.
+Versions 1.7 and lower only allow up to 16 characters including name,
+which is too limiting and not supported by this plugin.
+If you wish to have prefix/suffix for 1.7 and lower,
+take advantage of [this client-sided mechanic](https://github.com/NEZNAMY/TAB/wiki/Client%E2%80%90sided-mechanics#nametag-format-in-tablist) and configure tagprefix/tagsuffix,
+which will appear in the tablist.  
+![image](https://user-images.githubusercontent.com/6338394/205877929-4df82c78-9773-4614-b4a3-93e1673d6046.png)
+
+Settings of this feature can be configured in **config.yml** under **tablist-name-formatting** section.
+
+# Configuration
+## Introduction
+The display name is split into 3 parts for convenience:  
+`tabprefix` - first part of the text, this is where prefix is usually configured  
+`customtabname` - second part of the text, it will be used as player name. If customtabname is not defined at all (not just setting empty value!), player's original name will be used instead  
+`tabsuffix` - last part of the text, this is where suffix is usually configured
+
+These values are then merged and displayed in the tablist.  
+![image](https://user-images.githubusercontent.com/6338394/205877510-e40f93ce-80df-46f2-84f0-c113e0e813e8.png)
+
+You are free to use the 3 properties in any way you want since they are only split for convenience.
+However, it is still a good idea to use them for their designed purpose to not get lost a poor configuration.
+This means that the text which should appear before player's name should be put into `tabprefix`,
+any placeholder that is supposed to display player's name (such as from a nickname plugin)
+should go into `customtabname` and any text that should appear after player's name should be put into `tabsuffix`.
+
+## Groups and users
+Properties can be applied in 2 ways: groups and users.
+Users can be defined by both username and their UUID.
+Values applied to users take priority over groups.
+Example:  
+**groups.yml**
+```
+admin:
+  tabprefix: "&4&lAdmin &r"
+```
+This can also be achieved with commands, in this case `/tab group admin tabprefix "&4&lAdmin &r"`.
+
+**users.yml**
+```
+_NEZNAMY_:
+  tabprefix: "&6&lTAB &r"
+
+# An alternate way using UUID
+237d8b55-3f97-4749-aa60-e9fe97b45062:
+  tabprefix: "&6&lTAB &r"
+```
+This can also be achieved with commands, in this case `/tab player _NEZNAMY_ tabprefix "&6&lTAB &r"` or `/tab playeruuid _NEZNAMY_ tabprefix "&6&lTAB &r"`.
+
+Properties can also be set as "default" for everyone who does not have them defined.
+For that purpose, a group keyword `_DEFAULT_` was made.
+Example:   
+**groups.yml**
+```
+admin:
+  tabprefix: "&4&lAdmin &r"
+_DEFAULT_:
+  tabprefix: "&7" # This will be displayed on everyone except admin
+```
+
+## Per-world / per-server
+Values can also be applied per-world (and per-server on bungeecord), where they can be defined per group/user. These values take priority over global settings. Example:  
+**groups.yml**
+```
+per-world:
+  world1:
+    _DEFAULT_:
+      tabprefix: "&a" # Everyone in world "world1" will have this prefix
+per-server:
+  server1:
+    _DEFAULT_:
+      tabprefix: "&a" # Everyone in server "server1" will have this prefix
+```
+For multiple worlds/servers to share the same settings, separate them with `;`.  
+For worlds/servers starting with a specified text, use `*` after shared part. For ending with a shared part, use `*` at the beginning.  
+Example:
+```
+per-world:
+  world1;world2:
+    _DEFAULT_:
+      tabsuffix: "Shared tabsuffix in worlds world1 and world2"
+  lobby-*:
+    _DEFAULT_:
+      tabsuffix: "Suffix in all worlds starting with lobby-"
+```
+
+## Priority system
+The full list of priorities looks like this:
+1. value set using the [API](#api)
+2. per-world / per-server applied to username
+3. value applied to username
+4. per-world / per-server applied to uuid
+5. value applied to uuid
+6. per-world / per-server applied to player's group
+7. per-world / per-server applied to group `_DEFAULT_`
+8. value applied to player's group
+9. value applied to group `_DEFAULT_`
+
+This list is browsed through until the first match is found. If no match is found, empty value is used (except `customtabname`, which defaults to player's name).
+
+Values are taken independently of each other.
+This means you can set per-world tabprefix, but only keep one global tabsuffix, for example.
+
+You can see the source of a value displayed on player by using `/tab debug <player>` and checking "source"
+part of the value you are looking for.
+
+## Placeholder support
+All values fully support [TAB's internal placeholders](https://github.com/NEZNAMY/TAB/wiki/Placeholders#internal-placeholders) and [PlaceholderAPI placeholders](https://github.com/PlaceholderAPI/PlaceholderAPI/wiki/Placeholders) including relational placeholders.
+The number of placeholders is not limited, and they can be used in combination with static text as well.
+
+## Additional settings
+| Option name       | Default value         | Description                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                         |
+|-------------------|-----------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
+| enabled           | true                  | Enables / Disables the feature                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      |
+| anti-override     | true                  | When enabled, prevents other plugins from overriding TAB. This results in slightly higher CPU usage, but will make sure the function works as expected. <br />Unlike with teams, attempts to override TAB are not logged into anti-override.log file. This is due to high amount of false positives from TAB's own features, as well as bungeecord server switch, higher CPU usage and more. Whether you need this or not depends on how properly your plugins are configured. Some of them attempt to format tablist even if you'd not expect it from such plugin. Keep this enabled to stay safe. |
+| disable-condition | %world%=disabledworld | A [condition](https://github.com/NEZNAMY/TAB/wiki/Feature-guide:-Conditional-placeholders) that must be met for disabling the feature for players. Set to empty for not disabling the feature ever.                                                                                                                                                                                                                                                                                                                                                                                                 |
+
+# Tips & Tricks
+If you want TAB to only take prefixes/suffixes from your permission plugin,
+delete all groups from **groups.yml** and only keep this:
+```
+_DEFAULT_:
+  tabprefix: "%luckperms-prefix%"
+  tabsuffix: "%luckperms-suffix%"
+```
+
+# API
+*To get started with the API, see [Developer API](https://github.com/NEZNAMY/TAB/wiki/Developer-API) page.*
+
+To access this feature, you'll need to obtain `TabListFormatManager` instance. Get it using `TabAPI.getInstance().getTabListFormatManager()`. If this feature is disabled, the method will return `null`.
+
+To set the values for the respective formatting, use the following:
+* `TabListFormatManager#setPrefix(TabPlayer, String)`
+* `TabListFormatManager#setName(TabPlayer, String)`
+* `TabListFormatManager#setSuffix(TabPlayer, String)`
+
+To reset the values, set them to `null`.
+
+To get custom values previously set using the API (they will return `null` if no custom value is set):
+* `TabListFormatManager#getCustomPrefix(TabPlayer)`
+* `TabListFormatManager#getCustomName(TabPlayer)`
+* `TabListFormatManager#getCustomSuffix(TabPlayer)`
+
+To get the original value set by the plugin based on configuration:
+* `TabListFormatManager#getOriginalPrefix(TabPlayer)`
+* `TabListFormatManager#getOriginalName(TabPlayer)`
+* `TabListFormatManager#getOriginalSuffix(TabPlayer)`
+
+**Note**: These values are only temporary, meaning they won't get saved anywhere and will get reset on player quit or plugin reload. If you wish to save these values into file, use [commands](https://github.com/NEZNAMY/TAB/wiki/Commands-&-Permissions#tab-playergroupplayeruuid-name-property-value-options).  
@@ -0,0 +1,13 @@
+When a plugin for linking proxies is detected, TAB automatically enables its hook to add support for it.
+No configuration is necessary.  
+Supported redis plugins:
+* [RedisBungee](https://github.com/ProxioDev/RedisBungee)
+
+Supported features:
+* [Belowname](https://github.com/NEZNAMY/TAB/wiki/Feature-guide:-Belowname)
+* [Global playerlist](https://github.com/NEZNAMY/TAB/wiki/Feature-guide:-Global-playerlist)
+* [Nametags](https://github.com/NEZNAMY/TAB/wiki/Feature-guide:-Nametags) & [Sorting](https://github.com/NEZNAMY/TAB/wiki/Feature-guide:-Sorting-players-in-tablist)
+* [Tablist name formatting](https://github.com/NEZNAMY/TAB/wiki/Feature-guide:-Tablist-name-formatting)
+* [Playerlist Objective](https://github.com/NEZNAMY/TAB/wiki/Feature-guide:-Playerlist-Objective)
+
+The hook does not and will never support [Layout](https://github.com/NEZNAMY/TAB/wiki/Feature-guide:-Layout), which would require drastic changes to the feature itself and wouldn't be worth it, since the amount of visible players is usually even lower due to fixed slots and RedisBungee is used on networks with many players, so there will be enough players to work with anyway.
@@ -0,0 +1,139 @@
+# Content
+* [#1 - Why are NPCs showing up in the tablist?](#1---why-are-npcs-showing-up-in-the-tablist)
+* [#2 - How to make TAB work with LuckPerms?](#2---how-to-make-tab-work-with-luckperms)
+* [#3 - I enabled MySQL, and my prefix is now gone!](#3---i-enabled-mysql-and-my-prefix-is-now-gone)
+* [#4 - Why is player sorting not working?](#4---why-is-player-sorting-not-working)
+* [#5 - How to add players to %staffonline% placeholder?](#5---how-to-add-players-to-the-staffonline-placeholder)
+* [#6 - How to make player heads visible in tablist?](#6---how-to-make-player-heads-visible-in-tablist)
+* [#7 - Where can i find current default config files?](#7---where-can-i-find-current-default-config-files)
+* [#8 - How can I split players into multiple columns?](#8---how-can-i-split-players-into-multiple-columns)
+* [#9 - How to use space in prefix/suffix command?](#9---how-to-use-spaces-in-prefixsuffix-command)
+* [#10 - Can I change/remove the green connection bar in tablist?](#10---can-i-changeremove-the-green-connection-bar-in-tablist)
+* [#11 - Placeholder is not working](#11---placeholder-is-not-working)
+* [#12 - How can I display ItemsAdder images?](#12---how-can-i-display-itemsadder-images)
+* [#13 - How can I use UTF characters in configuration?](#13---how-can-i-use-utf-characters-in-configuration)
+* [#14 - Is there a way to remove all players from tablist?](#14---is-there-a-way-to-remove-all-players-from-tablist)
+* [#15 - How to add images to tablist?](#15---how-to-add-images-to-tablist)
+* [#16 - Is MiniMessage supported?](#16---is-minimessage-supported)
+* [#17 - Is it possible to show the number of players in a specific group, similar to staffonline placeholder?](#17---is-it-possible-to-show-the-number-of-players-in-a-specific-group-similar-to-staffonline-placeholder)
+* [#18 - Why is the plugin flagged as a virus by Windows defender?](#18---why-is-the-plugin-flagged-as-a-virus-by-windows-defender)
+
+## #1 - Why are NPCs showing up in the tablist?
+See [Citizens FAQ](https://wiki.citizensnpcs.co/Frequently_Asked_Questions#Why_are_NPCs_showing_up_in_the_tablist.3F).
+
+## #2 - How to make TAB work with LuckPerms?
+* If you want to take prefixes/suffixes, check [this guide](https://github.com/NEZNAMY/TAB/wiki/Mini-guides-collection#taking-prefixessuffixes-from-permission-plugin) and use `%luckperms-prefix%` & `%luckperms-suffix%`.
+* Sorting:
+  First, [Configure weights correctly in LuckPerms](https://github.com/NEZNAMY/TAB/wiki/How-to-setup-weights-priorities#luckperms). Then, you have 2 options:
+  * Configure [sorting by groups](https://github.com/NEZNAMY/TAB/wiki/Feature-guide:-Sorting-players-in-tablist#groups) (recommended).
+  * Sorting by weights directly: `PLACEHOLDER_HIGH_TO_LOW:%luckperms_highest_group_weight%`.
+
+## #3 - I enabled MySQL, and my prefix is now gone!
+When enabling [MySQL](https://github.com/NEZNAMY/TAB/wiki/MySQL), it will be used as a data storage and groups.yml / users.yml files will no longer be used.  
+If you want to upload your configuration to MySQL (or download it back to files), use [MySQL conversion commands](https://github.com/NEZNAMY/TAB/wiki/MySQL#data-conversion) - [`/tab mysql upload`](https://github.com/NEZNAMY/TAB/wiki/MySQL#uploading-from-files-to-mysql) and [`/tab mysql download`](https://github.com/NEZNAMY/TAB/wiki/MySQL#downloading-from-mysql-to-files), respectively.  
+After you are done, run `/tab reload` for the changes to take effect.
+
+## #4 - Why is player sorting not working?
+See [Common mistakes section on sorting page](https://github.com/NEZNAMY/TAB/wiki/Feature-guide:-Sorting-players-in-tablist#common-mistakes).
+
+## #5 - How to add players to the %staffonline% placeholder?
+Give them the `tab.staff` permission.
+
+## #6 - How to make player heads visible in tablist?
+Players who did not buy the game will never be able to see heads.
+The client displays Player heads when connection to the server is an online connection authenticated through Mojang.
+It cannot be directly controlled by plugins.
+The intended way to reach this is by setting `online-mode=true` in `server.properties`.  
+If you want to allow pirates on your server,
+you can still display heads for players who bought the game by changing their connections to online connections.
+Most commonly used plugins for this are [FastLogin](https://www.spigotmc.org/resources/14153/) and [JPremium](https://www.spigotmc.org/resources/27766/),
+which change connections of premium players who enabled it to online connections.  
+The same goes for disabling heads - you cannot disable them if you have online mode enabled.
+
+## #7 - Where can i find current default config files?
+You can do any of the following:
+* Check the [source code](https://github.com/NEZNAMY/TAB/tree/master/shared/src/main/resources/config).
+* Delete or rename a file, and the plugin will regenerate it.
+* Open the plugin jar as a zip file and take files from there.
+
+## #8 - How can I split players into multiple columns?
+The client puts players into columns, it is not managed by the server.
+The only way is to get more players.
+They automatically split into more columns at 21, 41 and 61 players (due to limit of 20 entries per column).
+If you don't mind getting all 80 slots filled with fake player slots,
+check out the [Layout](https://github.com/NEZNAMY/TAB/wiki/Feature-guide:-Layout) feature.
+
+## #9 - How to use spaces in prefix/suffix command?
+Use "", for example `/tab group owner tabprefix "&2&lOwner&r "`
+
+## #10 - Can I change/remove the green connection bar in tablist?
+The connection bar is client sided and cannot be re-textured or removed by TAB.
+You will need a custom minecraft client or a resource pack.
+
+## #11 - Placeholder is not working
+Most common reasons for a placeholder to not work include:
+* Using % symbol by itself, which breaks placeholder starts and ends and therefore breaks all placeholders after it (use %% to display the symbol)
+* Trying to use a PlaceholderAPI placeholder without downloading its expansion or not having PlaceholderAPI installed at all
+* Trying to use [TAB's internal bukkit-only placeholders](https://github.com/NEZNAMY/TAB/wiki/Placeholders#bukkit-only) on BungeeCord
+* Trying to use [PlaceholderAPI placeholders on BungeeCord](https://github.com/NEZNAMY/TAB/wiki/How-to-set-up-PlaceholderAPI-support-on-bungeecord) without installing [bridge plugin](https://www.mc-market.org/resources/20631/)
+
+The full list of reasons can be found on the [Placeholders](https://github.com/NEZNAMY/TAB/wiki/Placeholders#placeholder-is-not-working) page.
+
+## #12 - How can I display ItemsAdder images?
+ItemsAdder offers placeholders, which return the respective symbol to which your desired image is bound to. You can get them using ItemsAdder's PlaceholderAPI expansion using their `%img_<name>%` placeholder. ItemsAdder's internal placeholders (`:something:`) will not work in TAB.
+
+If you are unable to change the references
+(for example, because they are defined in permission plugin and used elsewhere as well),
+you can use [PlaceholderAPI](https://github.com/NEZNAMY/TAB/wiki/Quick-PlaceholderAPI-startup-guide)'s `imgfix` expansion
+that replaces format of given placeholders into the correct format.  
+Example: `%luckperms_prefix%` -> `%imgfix_{luckperms_prefix}%`
+
+## #13 - How can I use UTF characters in configuration?
+**Option 1**: [Save the file in UTF-8 encoding](https://github.com/NEZNAMY/TAB/wiki/How-to-save-the-config-in-UTF8-encoding) and use your desired symbol directly.
+
+**Option 2**:  Find hex code of your symbol (4 hexadecimal numbers) and use `\uxxxx` format,
+where `xxxx` is hex code of the symbol.  
+Make sure to also wrap the text into `""` for the text to properly take `\` as an escape symbol.
+Using `''` will result in the text being display literally, not as a code.
+
+**Note:** Minecraft does not support every single UTF symbol and displays unsupported symbols as a box. You can try sending your symbol into chat and see if it works or not. If not, it's not supported by MC.
+
+## #14 - Is there a way to remove all players from tablist?
+For a player to be visible in game, they must be in the tablist as well.
+Remember the NPC in tablist issue?
+If you don't mind players not appearing in the game, get a plugin that hides all players.
+If you want to see them in the game, however, your only choice is to put a lot of empty lines into header,
+which will push all players out of the screen.
+
+## #15 - How to add images to tablist?
+You can check out [this reddit post](https://www.reddit.com/r/admincraft/comments/llrgty/comment/gnswdcz/?utm_source=share&utm_medium=web2x&context=3).
+When using the symbol in configuration using \u format, remember to use `""` in config instead of `''`.
+
+## #16 - Is MiniMessage supported?
+Kind of.
+MiniMessage support **is** included; however, this doesn't mean it is guaranteed to work.
+MiniMessage library must be included in your server software.
+TAB does not include this library.
+* It **is** included in **Paper 1.18.2** and higher, **Velocity** and **Sponge 8**.
+* It **is not** included in **Spigot**, any server software for 1.18.1 and lower, **BungeeCord**, **Sponge 7** and **Fabric**.
+
+If you believe MiniMessage should be supported on your server but doesn't work, open a bug report.
+
+## #17 - Is it possible to show the number of players in a specific group, similar to staffonline placeholder?
+The plugin's internal placeholders are limited, and this kind of functionality is not included.
+However,
+you can achieve this using PlaceholderAPI's `PlayerList` expansion
+and following [this example](https://github.com/Tanguygab/PlayerList-PlaceholderAPI-Expansion/wiki#list-of-players-in-group).
+
+## #18 - Why is the plugin flagged as a virus by Windows defender?
+First, this is a false positive.
+[Here](https://www.spigotmc.org/threads/windows-defender-false-positives.639507/)'s a spigot thread confirming it.
+
+After experimenting with VirusTotal,
+it turns out the antivirus software available on the website used flags [bStats](https://github.com/Bastian/bStats) library as malicious.
+Its purpose is to collect anonymous data about servers and submitting it to [bStats.org](https://bstats.org/),
+where plugin authors can see how many servers use their plugins (if they don't disable it).
+It also checks for CPU and OS types, which could be the reason for the false positive.
+[Here](https://bstats.org/plugin/bukkit/TAB%20Reborn/5304) is one of TAB's pages as an example.
+
+Windows defender could be flagging it for the same reason.
@@ -0,0 +1,37 @@
+# About the wiki
+The wiki explains the functionality of the plugin as of version **5.0.5**.
+If your config looks different or is missing some features, you are using an old version of the plugin.
+To get the latest version, check [releases](https://github.com/NEZNAMY/TAB/releases/).  
+Wiki for older plugin versions is not available.
+
+If you plan to run your server for longer than 1 week,
+it's a good idea to read this wiki as it explains everything about the plugin.
+This will give you knowledge to do things you had no idea were possible, giving you an advantage over everyone else.
+
+A lot of examples on the wiki use PlaceholderAPI placeholders without explaining its installation step by step. If you are going to use the examples and aren't familiar with the plugin, check out [Quick PlaceholderAPI startup guide](https://github.com/NEZNAMY/TAB/wiki/Quick-PlaceholderAPI-startup-guide).
+
+# Limitations of plugins
+TAB is a plugin.
+It only modifies the server behavior to your liking.
+It does not add anything into the game.
+Because of that, you'll need
+to carefully read the limitations of each feature to know what they are capable of and what they are not capable of.
+Some of the undesired behavior can be altered using a resource pack and some using a modified client.
+Both of these are out of scope of TAB as a plugin; therefore, no advanced information regarding this is provided.
+
+# Public plugin
+TAB is a public plugin designed to satisfy the needs of a majority of servers.
+
+This means it has functions not everyone will need. All you need to do is disable functions you don't want. Disabled features do not consume the CPU at all.
+
+On the other hand, it cannot contain everything everyone can think of.
+There must be a balance
+between providing as much as possible while making the configuration as short and readable as possible.
+This is not an easy task.
+The majority of things that are not supported directly can be achieved in different ways.
+Adding direct way for everything everyone asks for would not only take a lot of time,
+but make the plugin harder to configure for everyone, as well as introduce a lot of duplicate ways to achieve things,
+making the plugin overcomplicated.  
+If your need is very specific and not available in the plugin in any way,
+you should look into private plugin development.
+You will end up with a plugin made just for you with everything you want and nothing else.  
@@ -0,0 +1,58 @@
+# Content
+* [About](#about)
+* [Option 1: Primary group from permission plugin](#option-1-primary-group-from-permission-plugin)
+* [Option 2: Permission nodes](#option-2-permission-nodes)
+* [Taking groups from backend servers when TAB is on proxy](#taking-groups-from-backend-servers-when-tab-is-on-proxy)
+
+## About
+TAB uses groups to assign properties (such as tabprefix) and sort players in tablist (if sorting by groups). You have 2 ways of configuring primary groups of players in TAB.
+
+First option hooks into your permission plugin and takes groups from it. Therefore, your permission plugin must be supported.  
+**Supported permission plugins**: **LuckPerms** everywhere, on Bukkit any plugin supporting **Vault**.  
+If your permission plugin is not supported, you can use [Option 2](#option-2-permission-nodes).
+
+## Option 1: Primary group from permission plugin
+This is the default method and recommended.
+TAB will ask your permission plugin for player's primary group.
+There are 2 simple steps to this:
+* Keep `assign-groups-by-permissions: false` in your config
+* Put players into groups in your permission plugin
+> [!CAUTION]
+> If assigning players into multiple groups, make sure their weights are correct
+> (for luckperms /lp group \<group\> setweight \<number\>).
+
+> [!TIP]
+> Verify player's group using `/tab debug <player>`. It should say `Primary permission group: <your group>`.
+
+## Option 2: Permission nodes
+Instead of taking whole groups, TAB will check for permission nodes and assign groups based on the highest permission.
+1. Go to config.yml and set `assign-groups-by-permissions: true`.
+2. Give `tab.group.<group name>` permission to the user/permission group.
+3. Put all possible groups into `primary-group-finding-list`.
+   This is necessary because:  
+   #1 - there's no way to get the list of permissions, only checking for a permission.
+   The list will be used for a list of permissions to check for.  
+   #2 - if a player has permission for more than one group, the list will be used to pick the correct one
+   (the one higher in the list).
+
+> [!WARNING]
+> Remember that OP = all permissions!
+> That's the whole point of OP function.
+> To grant all permissions.
+> In that case,
+> you need to negate permissions in your permission plugin for other groups which are higher than player's wanted group.
+
+# Taking groups from backend servers when TAB is on proxy
+By default, TAB takes groups from the permission plugin installed on the same server instance.
+In the case of proxy installation, groups are by default taken from the proxy.
+To see how is your proxy permission plugin configured, use its respective command
+(for LuckPerms it's `/lpb user <player> info` instead of `/lp`).
+
+If you don't have your permission plugin synced using MySQL for sharing groups and don't wish to, and want groups to be taken from backend servers instead, enable the config option:
+```
+use-bukkit-permissions-manager: true
+```
+When enabling it, all group **and** permission requests will be done through [Bridge plugin](https://github.com/NEZNAMY/TAB/wiki/TAB-Bridge) to take data from backend servers. Your groups will now match data from backend server a player is connected to (in case of LuckPerms `/lp user <player> info`).
+
+When assigning by permissions instead of taking the primary group directly from permission plugin,
+the permission nodes (`tab.group.<name>`) will be taken from backend servers instead.
@@ -0,0 +1,98 @@
+# Content
+* [Tablist](#tablist)
+* [Nametag](#nametag)
+* [Tips & Tricks](#tips--tricks)
+  * [Tip 1 - Nickname prefix](#tip-1---nickname-prefix)
+  * [Tip 2 - Sorting nicked players with the lowest priority](#tip-2---sorting-nicked-players-with-the-lowest-priority)
+
+# Tablist
+This one is straightforward.
+The tablist format of players is one text split into 3 parts in the plugin for convenience
+(tabprefix, customtabname, tabsuffix).
+Using `customtabname` you can configure name part into any placeholder you want,
+including one from your nickname plugin.
+All you need is a working PlaceholderAPI placeholder from your nickname plugin.
+Example:  
+**groups.yml**
+```
+_DEFAULT_:
+  customtabname: '%essentials_nickname%'
+```
+or using in-game command `/tab group _DEFAULT_ customtabname %essentials_nickname%`.
+
+This example uses `%essentials_nickname%` placeholder from Essentials. Giving it to `_DEFAULT_` group keyword makes it a default value for all groups that do not override this property.
+
+> [!CAUTION]
+> Do NOT put nickname placeholder into tabprefix!
+> You will end up with double names!
+> Put the nickname placeholder into customtabname instead.
+
+# Nametag
+Nametags are more complicated because they consist of player's username, team prefix and team suffix.
+There is no intended way to do this.
+The only way is changing it using a nickname plugin.
+Some nickname plugins actually change name in game profile, which also changes it in nametag.
+You will need to find one that offers this and then use it.
+This is a complicated process with lots of side effects, so TAB does not offer it.
+
+# Proper compatibility with plugins that change profile name
+If using a nickname plugin that changes player's profile name to change it in the name tag,
+this has lots of side effects.
+Most notably, it breaks all name-bound features,
+especially [nametags](https://github.com/NEZNAMY/TAB/wiki/Feature-guide:-Nametags) and [sorting](https://github.com/NEZNAMY/TAB/wiki/Feature-guide:-Sorting-players-in-tablist).
+For that reason, TAB must detect name change.
+This is done automatically on Bukkit, BungeeCord and Fabric.
+This detection is not available on Sponge and Velocity.
+
+In order for TAB to properly detect name change, player UUID must remain the same,
+otherwise it's a random entry with a random uuid and random name, which TAB isn't able to match with actual players.
+Make sure your nickname plugin is not changing UUID of players.
+If UUID changes, the plugin won't be able to properly format names even in the tablist,
+since entries there are bound to UUIDs and by changing it, it will break.  
+Identifying whether name change detection is working properly or not can be checked
+by setting `debug: true` in config and checking console on name change.
+It should say `Processing name change of player <player name> to <new nickname>`.
+If it doesn't, something went wrong, most likely UUID not matching.
+
+# Tips & Tricks
+## Tip 1 - Nickname prefix
+By default, Essentials prefixes nicknames of players in chat using `~` symbol for nicked players. We can very easily replicate that with [Conditional placeholders](https://github.com/NEZNAMY/TAB/wiki/Feature-guide:-Conditional-placeholders). First, create a new condition:
+```
+conditions:
+  nick:
+    conditions:
+    - '%essentials_nickname%=%player%'
+    yes: "%player%"              # If nickname = player name -> player is not nicked
+    no: "~%essentials_nickname%" # If nickname != player name -> player is nicked
+```
+Then, use `%condition:nick%` in your `customtabname` instead of the placeholder directly.
+
+# Tip 2 - Sorting nicked players with the lowest priority
+Let's say your sorting list looks like this:
+```
+  sorting-types:
+    - "GROUPS:owner,admin,mod,helper,builder,vip,default"
+    - "PLACEHOLDER_A_TO_Z:%player%"
+```
+Let's also assume that you want every nicked player to be sorted as `default`. This can be achieved using [sorting by placeholder](https://github.com/NEZNAMY/TAB/wiki/Feature-guide:-Sorting-players-in-tablist#placeholder) and creating a [condition](https://github.com/NEZNAMY/TAB/wiki/Feature-guide:-Conditional-placeholders) that will return output based on nick status. First, let's create the condition:
+```
+conditions:
+  group:
+    conditions:
+    - '%haonick_isNicked%=true'
+    yes: "default"
+    no: "%group%"
+```
+When the condition is met, meaning player is nicked, it will return the group we want nicked players to be sorted as, in this case `default`. Otherwise, return player's actual group.  
+The condition check may differ with different nickname plugins. You will need to check documentation of your nickname plugin to see what kind of placeholders it offers and what they return (you can also use `/tab parse` to see what exactly did a placeholder return).  
+In this case, we are using placeholder `%haonick_isNicked%`, which returns `true` for nicked players.  
+If using Essentials, the line would look like this: `%essentials_nickname%!=%player%`, because Essentials is made to return player's actual name when not nicked, meaning when it's not equal, player is nicked.
+
+Finally, use the conditional placeholder in sorting:
+```
+  sorting-types:
+  - PLACEHOLDER:%condition:group%:owner,admin,mod,helper,builder,vip,default"
+  - PLACEHOLDER_A_TO_Z:%player%
+```
+This will result in nicked players being sorted as `default`.  
+If you want to achieve something more complicated, such as not only sorted as default, but another rank, you will need to dig deeper into your problem, analyzing available placeholders and functions that will help you achieve your result.  
@@ -0,0 +1,31 @@
+
+This guide will explain how to solve the incompatibility with glow plugins.
+
+# Content
+* [Reason for compatibility issue](#reason-for-compatibility-issue)
+* [Solution](#Solution)
+* [Examples of glow plugins](#examples-of-glow-plugins)
+
+## Reason for compatibility issue
+Glow color is managed by scoreboard teams, which also handle nametag formatting and player sorting in tablist. Only one plugin can handle teams at a time. Because of that, TAB will prevent glow plugins from assigning players into teams.
+
+## Solution
+The solution to get around this issue is to use the glow plugin's placeholder (if it has any).  
+This placeholder has to be at the end of the player's `tagprefix` as it has to be the last color in the prefix.
+> [!WARNING]
+> For Minecraft versions below 1.13 the prefix can't be longer than 14 characters due to [16-character limit](https://github.com/NEZNAMY/TAB/wiki/Feature-guide:-Nametags#limitations) total
+(glow placeholder adds 2 characters - `&` and the color code)
+
+**Example:**
+This example uses the placeholder of the [eGlow](https://www.spigotmc.org/resources/63295/) plugin.
+
+**groups.yml**
+```
+_DEFAULT_:
+  tagprefix: '%vault-prefix%%eglow_glowcolor%'
+```
+
+## Examples of glow plugins
+- [eGlow](https://www.spigotmc.org/resources/63295/) (%eglow_glowcolor%) (Paid)
+- [CMI](https://www.spigotmc.org/resources/3742/) (%cmi_user_glow_code%) (Paid)
+- ... more?
@@ -0,0 +1,28 @@
+# Programs
+* [Notepad](#notepad)
+* [Notepad++](#notepad-1)
+* [Sublime Text 3](#sublime-text-3)
+* [WinSCP](#winscp)
+***
+
+# Notepad
+Open the file > Click file > Save as... > Set encoding to UTF-8 > Click save
+![](https://i.ibb.co/zQHbL3p/notepad.png)
+
+***
+
+# Notepad++
+Open the file > Click encoding > Click UTF-8 (if that didn't work, use Convert to UTF-8)  
+![](https://i.ibb.co/qNdj80Q/notepad.png)
+
+***
+
+# Sublime Text 3
+![](https://cdn.discordapp.com/attachments/659545536533364776/847537718236938260/unknown.png)
+
+***
+
+# WinSCP
+Open the file in WinSCP and check if it is in UTF-8 encoding already (1). If it is not, click on ENCODING at the top (2), select UTF-8 (3) and then save the file. You can now edit the file as you like and paste in characters.
+![](https://i.ibb.co/nRxDmHk/Win-SCP-Xlxw-Qfft-Cb.png)
+![](https://i.ibb.co/dP77yzp/Win-SCP-UXWc4-Xdp2-N.png)
@@ -0,0 +1,72 @@
+# Content
+* [Introduction](#introduction)
+* [Usage](#usage)
+  * [Magic codes](#magic-codes)
+* [Invalid code handling](#invalid-code-handling)
+* [Compatibility with <1.16](#compatibility-with-116)
+* [Fonts](#fonts)
+  * [Usage](#usage-1)
+  * [Compatibility with RGB and gradients](#compatibility-with-rgb-and-gradients)
+
+# Introduction
+As of 1.16, mojang introduced RGB color support.
+This allows us to use 256^3 different colors instead of the original 16 ones.
+This is not supported on <1.16 in any way.
+
+# Usage
+Supported RGB formats:
+* `#RRGGBB`
+* `&#RRGGBB`
+* `{#RRGGBB}`
+* `#<RRGGBB>`
+* `&x&R&R&G&G&B&B`
+
+Gradients:
+* `<#RRGGBB>Text</#RRGGBB>`
+* `{#RRGGBB>}Text{#RRGGBB<}`
+* `<$#RRGGBB>Text<$#RRGGBB>`
+
+TAB uses the first by default, but is able to accept the other types as well without leaving any characters (such as `{}`) behind.  
+**Gradients only support 2 colors, using more will result in an invalid syntax and won't work.**
+> [!CAUTION]
+> Remember to replace `RRGGBB` with actual hexadecimal numbers (0-9, a-f)!
+
+You can use a tool like [this one](https://htmlcolorcodes.com/) to easily find suitable colors.
+
+## Magic codes
+Just like with legacy colors, use color first, then magic codes (in any order). For example with **bold**: `#00FFFF&lText`.
+
+For gradients, put the magic codes at the beginning of text. For example `<#00FF00>&lBold gradient text</#FF00FF>`.
+
+# Invalid code handling
+In case you accidentally use invalid hex color code, the plugin will simply ignore it and keep it in raw format.
+
+# Compatibility with <1.16
+Since <1.16 clients do not understand these color codes, something else must be displayed instead.
+TAB, server software or viaversion (depending on your setup)
+will find the closest legacy color to the desired RGB combination and will use that color instead.
+
+# Fonts
+The plugin offers usage of the font feature introduced in Minecraft 1.16.
+> [!IMPORTANT]
+> This does NOT refer to different character sets!
+> This refers to different fonts defined in resource packs or MC itself.
+
+## Usage
+The syntax is `<font:FONT_NAME>Text</font>` where `FONT_NAME` is name of your desired font.
+
+**Example**  
+`<font:minecraft:alt>This is a text written in minecraft enchantment table language which no one understands</font>`
+
+**Result**  
+![image](https://github.com/NEZNAMY/TAB/assets/6338394/9a19cb1b-2761-4500-b058-2e7a7cd68d14)
+
+
+## Compatibility with RGB and gradients
+When trying to use both font and RGB or gradients, font must be outside and RGB/gradients inside.
+
+**Example**  
+`<font:minecraft:alt><#00FF00>This is a colorful text written in minecraft enchantment table language which no one understands, but it looks pretty</#FF0000></font>`
+
+**Result**  
+![image](https://github.com/NEZNAMY/TAB/assets/6338394/81da5bc4-1920-4dad-bcf5-002b5de741f8)
@@ -0,0 +1,65 @@
+# Content
+* [Backend](#backend)
+* [BungeeCord / Velocity](#bungeecord--velocity)
+  * [Proxy installation](#proxy-installation)
+  * [Backend installation](#backend-installation)
+  * [Mixed installation](#mixed-installation)
+* [Updating the plugin](#updating-the-plugin)
+
+# Backend
+Installation on Bukkit / Fabric / Sponge is as simple as it can be.
+Put the plugin into the plugins folder and restart the server.  
+Dynamic (re)loads at runtime such as `/plugman load tab` to load the plugin are fully supported.
+However, plugins hooking into TAB may break when you use such ways to (re)load it.
+
+# BungeeCord / Velocity
+When running a network, you have 3 options:
+* Installing TAB only on the proxy (recommended)
+* Installing TAB on all backend servers instead
+* Installing TAB everywhere and disabling features, so they don't conflict (not recommended)
+
+See below for more information regarding each way.
+
+## Proxy installation
+This is the recommended setup.
+Put the plugin into the plugins folder of the proxy server and restart it.  
+**Recommended**:
+Install [TAB-Bridge](https://github.com/NEZNAMY/TAB/wiki/TAB-Bridge) on your **backend servers** for PlaceholderAPI support and more.  
+**Recommended**:
+If you are using **Velocity**,
+install [VelocityScoreboardAPI](https://github.com/NEZNAMY/VelocityScoreboardAPI/) plugin **on the proxy** for scoreboard-related features to work.
+
+> [!NOTE]  
+> With proxy installation, use **/btab** command instead of **/tab**.
+
+Advantages of proxy installation compared to installing on all backend servers instead:
+* Can use the [Global player list](https://github.com/NEZNAMY/TAB/wiki/Feature-guide:-Global-playerlist) and [Layout](https://github.com/NEZNAMY/TAB/wiki/Feature-guide:-Layout) can work with all players connected to the proxy
+* Can use new content for new clients even if a backend server version is old (1.16+ RGB codes, 1.20.3+ scoreboard features)
+* Avoid [header/footer](https://github.com/NEZNAMY/TAB/wiki/Feature-guide:-Header-&-Footer#additional-note-1---not-resetting-on-server-switch) and [bossbar](https://github.com/NEZNAMY/TAB/wiki/Feature-guide:-Bossbar#additional-note-2---not-hiding-on-server-switch) not disappearing on server switch
+* Configuration files in a single place for easier editing / no need to use MySQL for syncing data
+
+
+Disadvantages compared to installing on all backend servers instead:
+* No [per-world player list](https://github.com/NEZNAMY/TAB/wiki/Feature-guide:-Per-world-playerlist) (can be achieved by installing the plugin on backend servers and disabling all features except the per-world player list)
+
+## Backend installation
+Just like when not running a network, install the plugin on all servers where you want the plugin. However, this setup is not as good (see advantages of proxy installation).
+
+## Mixed installation
+Mixed installation is absolutely not recommended and should be avoided.
+It requires you to disable features to make only 1 instance handle a single feature at a time,
+which most people fail miserably to do,
+resulting in issues such as header/footer flashing between proxy and backend configuration.
+With bridge, you are able to achieve almost anything with proxy installation.
+
+# Updating the plugin
+Updating the plugin is always as simple as replacing old jar with the new one.
+
+You do not need to reset your configuration files or make any manual changes to them.
+If any changes to configuration are made (changed / removed / added),
+TAB will automatically convert your existing configuration files to the latest format
+(most notably 2.9.2 → 3.0.0, but any other changes as well).
+
+Downgrading is completely unsupported, as an old plugin version cannot know what the future config format is / will be.
+Just like Minecraft itself.
+There is no reason for downgrading anyway, as every version is superior to older versions released before it.  
@@ -0,0 +1,15 @@
+# About
+This is collection if minecraft issues/bugs you may experience when using TAB, which are not TAB bugs and cannot be fixed with a plugin.
+
+# 1.5.x - 1.12.x - Unwanted space
+You may see unwanted space at the end of a line of text even if you didn't configure any.
+This is a client sided bug.
+To avoid it, add `&r` after ending bold segment (for example, prefix `&4&lAdmin&r&6`).
+
+# 1.15.x - Strikethrough and underline
+Using &m (strikethrough) and &n (underline) does not work in header,
+last line of the scoreboard and possibly other places
+([MC-180110](https://bugs.mojang.com/browse/MC-180110)).
+
+# 1.20 - 1.20.4 - Chat over tablist
+Visual bug rendering chat over the tablist ([MC-263256](https://bugs.mojang.com/browse/MC-263256)).
@@ -0,0 +1,206 @@
+# Content
+Combine the knowledge gathered by reading the wiki to get interesting results, most frequently asked ones listed here.
+* [Displaying kill / death counter in tablist](#displaying-kill--death-counter-in-tablist)
+* [Taking prefixes/suffixes from permission plugin](#taking-prefixessuffixes-from-permission-plugin)
+* [Showing player's version in tablist](#showing-players-version-in-tablist)
+* [Replicating Purpur's TPSBar](#replicating-purpurs-tpsbar)
+* [BedWars1058 compatibility](#bedwars1058-compatibility)
+* [Displaying AFK status in tablist](#displaying-afk-status-in-tablist)
+* [Showing combined online player count from multiple servers](#showing-combined-online-player-count-from-multiple-servers)
+  * [Option 1 - Using global playerlist](#option-1---using-global-playerlist)
+  * [Option 2 - Using PlaceholderAPI](#option-2---using-placeholderapi)
+
+# Displaying kill / death counter in tablist
+This example uses PlaceholderAPI placeholders.  
+Kills:
+```
+playerlist-objective:
+  enabled: true
+  value: "%statistic_player_kills%"
+```  
+Deaths:
+```
+playerlist-objective:
+  enabled: true
+  value: "%statistic_deaths%"
+```  
+**Note:** These values are taken from server stats. You can modify / reset them for each player in `<main world>/stats/<player uuid>.json` file.
+
+# Taking prefixes/suffixes from permission plugin
+Delete all groups from **groups.yml** and only keep this:
+```
+_DEFAULT_:
+  tabprefix: "%vault_prefix%"
+  tagprefix: "%vault_prefix%"    
+  tabsuffix: "%vault_suffix%"    
+  tagsuffix: "%vault_suffix%"
+```
+This requires Vault and a permission plugin to work.  
+If you have luckperms installed on the same server instance, you can use TAB's internal `%luckperms-prefix%` (and suffix) placeholders instead.  
+**Note:** If TAB is on bungeecord, and you want prefixes to be taken from backend servers, use `%vault_prefix%` (or `%luckperms_prefix%`) with [PlaceholderAPI support on bungeecord](https://github.com/NEZNAMY/TAB/wiki/TAB-Bridge).
+
+# Showing player's version in tablist
+Run `/tab group _DEFAULT_ tabsuffix " &8[&3%player-version%&8]"` or any other color combination you want. You can also include other placeholders with it. You can also modify it directly in **groups.yml** file instead. With the provided example command, you'll get the following result:  
+![image](https://github.com/NEZNAMY/TAB/assets/6338394/2327b482-e8da-4940-9aa8-ea2bdda64b6f)
+
+# Replicating Purpur's TPSBar
+*This guide was made purely for demonstration of TAB's functionality to show you can even do things like this with conditions. It is not meant to be used as a replacement for Purpur or any of its functions or discouraging users from using Purpur.*
+
+By default, Purpur's TPSBar shows server's TPS, MSPT and player ping.
+These change colors from green to red based on value.
+The easier way
+to achieve this is with [Placeholder output replacements](https://github.com/NEZNAMY/TAB/wiki/Feature-guide:-Placeholder-output-replacements-(premium-only)),
+however, it alters placeholders everywhere inside TAB,
+which would result in features like [Playerlist objective](https://github.com/NEZNAMY/TAB/wiki/Feature-guide:-Playerlist-Objective)
+to stop working correctly when %ping% is used,
+since it would contain color codes now.
+For that reason,
+we will use [Conditions](https://github.com/NEZNAMY/TAB/wiki/Feature-guide:-Conditional-placeholders) instead.
+
+When TPS is above 19, it displays as `<#55FF55>value</#00AA00>`. When above 15, `<#FFFF55>value</#FFAA00>`, otherwise `<#FF5555>value</#AA0000>`. This can be achieved with 2 conditions:
+```
+conditions:
+  tps:
+    conditions:
+      - "%tps%>=19"
+    yes: "<#55FF55>%tps%</#00AA00>"
+    no: "%condition:tps2%"
+  tps2:
+    conditions:
+      - "%tps%>=15"
+    yes: "<#FFFF55>%tps%</#FFAA00>"
+    no: "<#FF5555>%tps%</#AA0000>"
+```
+To use this, we will use `%condition:tps%`.  
+Now, repeat for mspt and ping. For mspt, purpur's intervals are <40, <50, 50+. For ping, it's <100, <200, 200+.
+
+Conditions for mspt and ping may look something like this:
+```
+conditions:
+  mspt:
+    conditions:
+      - "%mspt%<40"
+    yes: "<#55FF55>%mspt%</#00AA00>"
+    no: "%condition:mspt2%"
+  mspt2:
+    conditions:
+      - "%mspt%<50"
+    yes: "<#FFFF55>%mspt%</#FFAA00>"
+    no: "<#FF5555>%mspt%</#AA0000>"
+  ping:
+    conditions:
+      - "%ping%<100"
+    yes: "<#55FF55>%ping%</#00AA00>"
+    no: "%condition:ping2%"
+  ping2:
+    conditions:
+      - "%ping%<200"
+    yes: "<#FFFF55>%ping%</#FFAA00>"
+    no: "<#FF5555>%ping%</#AA0000>"
+```
+To use them, we will use `%condition:mspt%` and `%condition:ping%`. Purpur's TPSBar is using mspt as bossbar progress with range from 0 to 50. This can be achieved with PlaceholderAPI's math expansion: `%math_0_{tab_placeholder_mspt}*2%`. It always uses `GREEN` color and `NOTCHED_20` style. Let's put all of this together:
+```
+  bars:
+    tpsbar:
+      style: NOTCHED_20
+      color: GREEN
+      progress: "%math_0_{tab_placeholder_mspt}*2%"
+      text: "&7TPS&e: %condition:tps% &7MSPT&e: %condition:mspt% &7Ping&e: %condition:ping%&7ms"
+```
+
+The last step is to configure when should this bossbar be displayed. One way is to use bossbar announce/send command. Another is to use display conditions. An example can look like `display-condition: "permission:tab.tpsbar`. Now, only players with the permission will see the bossbar.
+
+# BedWars1058 compatibility
+## Sorting
+To sort teams through TAB, add the PLACEHOLDER_A_TO_Z sorting type with the %bw1058_player_team% placeholder. Example:
+```yml
+sorting-types:
+  - "PLACEHOLDER_A_TO_Z:%bw1058_player_team%"
+  - "GROUPS:admin,mod,default"
+  - "PLACEHOLDER_A_TO_Z:%player%"
+```
+## Team name in tablist/nametag
+To display the team name in the tablist, use this command: `/tab group _DEFAULT_ tabprefix %bw1058_player_team%`  
+The same goes for the nametag, but with tagprefix instead: `/tab group _DEFAULT_ tagprefix %bw1058_player_team%`
+
+To display only the first letter of the team, download this PlaceholderAPI expansion: https://api.extendedclip.com/expansions/bw1058plus/
+and use `%bw1058plus_team_letter%` instead, if you want the color as well, put `%bw1058plus_team_color%` right before.
+
+## Rank in lobby & Team name in game
+If you want to display the rank of the player while he's in the lobby or waiting lobby,
+BUT show the team name while in the game, then don't worry, there's a way.  
+You can create a condition which checks if the player's current team = nothing (which means the player isn't playing),
+and return either the rank or the team name depending on that condition.
+Example:
+```yml
+conditions:
+  rankOrTeam:
+    conditions:
+      - "%bw1058_player_team%="
+    yes: "%luckperms-prefix%"
+    no: "%bw1058_player_team%"
+```
+And then do `/tab group _DEFAULT_ tabprefix %condition:rankOrTeam%` and `/tab group _DEFAULT_ tagprefix %condition:rankOrTeam%` so it shows in your nametag and in your tablist name.
+
+# Displaying AFK status in tablist
+First, you'll need to get an AFK plugin. TAB does not track player AFK status. Then, find a PlaceholderAPI placeholder for your AFK plugin in their documentation, such as
+* `%essentials_afk%` for Essentials
+* `%cmi_user_afk_symbol%` for CMI
+* `%purpur_player_afk%` for Purpur (server software)
+
+Remember to install PlaceholderAPI and the respective expansion of your afk plugin.
+
+Then, use the placeholder in configuration wherever you want it.
+Assuming you want it for all players,
+use `_DEFAULT_` group keyword in **groups.yml** for default settings for all groups.
+Combined with other settings, it may look like this for tabsuffix:
+```
+_DEFAULT_:
+  tabsuffix: "%luckperms-suffix%%essentials_afk%"
+```
+Or running an in-game command: `/tab group _DEFAULT_ tabsuffix %luckperms-suffix%%essentials_afk%`.  
+This is not limited to displaying AFK status in suffix, you can also use it in tabprefix instead (or nametags).
+
+
+Finally, you will most likely need to set up [placeholder output replacements](https://github.com/NEZNAMY/TAB/wiki/Feature-guide:-Placeholder-output-replacements) for the placeholder, as lots of them, including the %essentials_afk% placeholder used as an example, return `yes` and `no` values, which you most likely want to customize.  
+As mentioned, by default, Essentials' afk placeholder returns `yes` / `no` (unless modified in PlaceholderAPI's config.yml). Other placeholders may return different values. To find out what a placeholder returned, use `/tab parse <player> <placeholder>`. Remember to include color codes as well.  
+An example customization may look like this:
+```
+placeholder-output-replacements:
+  "%essentials_afk%":
+    "yes": " &4&lAFK"
+    "no": "" # display nothing if not afk
+```
+Keep in mind that some placeholders don't need this.
+For example, CMI has 2 placeholders - %cmi_user_afk% that returns true/false,
+and %cmi_user_afk_symbol% that returns AFK text configured in CMI configuration.
+Therefore, if you decide to use the latter one, you don't need to set up replacements.
+
+# Showing combined online player count from multiple servers
+## Option 1 - Using global playerlist
+The first way is to install TAB on the proxy
+and enable [global playerlist](https://github.com/NEZNAMY/TAB/wiki/Feature-guide:-Global-playerlist).
+It allows you to create groups of servers that share playerlist.
+These groups can then be used to show player count on those servers using a placeholder.
+Using the following example:
+```
+global-playerlist:
+  enabled: true
+  server-groups:
+    lobbies:
+      - lobby1
+      - lobby2
+```
+Servers `lobby1` and `lobby2` will share playerlist. You will also be able to use placeholder formula `%playerlist-group_<group>%`, in this case `%playerlist-group_lobbies%`. It will show amount of players on `lobby1` and `lobby2` combined.
+
+Advantage of this is the natural compatibility with global playerlist's settings,
+which is also its disadvantage, since global playerlist has to be configured that way.
+When using [layout](https://github.com/NEZNAMY/TAB/wiki/Feature-guide:-Layout) feature,
+global playerlist is redundant and having it enabled only for the placeholder is inefficient.
+
+## Option 2 - Using PlaceholderAPI
+Unlike the first option, this one offers much more freedom, but also requires another plugin. You'll need to [download PlaceholderAPI and its expansions called math and bungee](https://github.com/NEZNAMY/TAB/wiki/Quick-PlaceholderAPI-startup-guide) (`/papi ecloud download bungee`, `/papi ecloud download math`, `/papi reload`).  
+First, you need placeholders for online count on specific servers. Bungee expansion does exactly that. The format is `%bungee_<server>%`. To merge the online counts, use math expansion. The syntax will be `%math_0_<expression>%`, where `expression` uses online counts from specific servers from bungee expansion. Finally, you'll end up with a placeholder like `%math_0_{bungee_lobby1}+{bungee_lobby2}%`. This placeholder will merge online counts from `lobby1` and `lobby2`.  
+Please note that by default, bungee expansion updates values only every 30 seconds. This can be changed in PlaceholderAPI's config. If the numbers still don't show correct value, check if the placeholder works correctly using `/papi parse me <placeholder>`. If not, this is not a TAB issue.
+
+Advantage of this is no requirement for a specific TAB feature to be enabled, which also includes no need to have TAB installed on the proxy. The downside is relying on 3rd party software. If TAB is on proxy, you'll also need [bridge plugin](https://github.com/NEZNAMY/TAB/wiki/TAB-Bridge).  
@@ -0,0 +1,77 @@
+* [About](#about)
+* [Availability](#availability)
+* [Enabling](#enabling)
+* [Configuration changes](#configuration-changes)
+* [Data conversion](#data-conversion)
+  * [Downloading from MySQL to files](#downloading-from-mysql-to-files)
+  * [Uploading from files to MySQL](#uploading-from-files-to-mysql)
+* [Synchronization frequency](#synchronization-frequency)
+
+# About
+By default, groups and users are stored in separate files (groups.yml and users.yml).  
+Enabling MySQL will use it as storage of groups and users instead of the files.
+
+`playerdata.yml` file (for toggling scoreboard/bossbar and remembering the decision)
+is not affected and will still be used instead of MySQL.
+It may be added in the future.
+
+All tables from TAB are prefixed with `tab_`, currently `tab_groups` for groups and `tab_users` for users.
+
+# Availability
+Before attempting to use the function, make sure your server software has an integrated MySQL driver.
+TAB does not contain it by itself.
+See the compatibility table below for current information about compatibility:
+
+| Platform   | Available |
+|------------|-----------|
+| Bukkit     | ✔         |
+| BungeeCord | ✔         |
+| Fabric     | ❌         |
+| Sponge     | ❌         |
+| Velocity   | ❌         |
+
+# Enabling
+Find this section in **config.yml**:
+```
+mysql:
+  enabled: false
+  host: 127.0.0.1
+  port: 3306
+  database: tab
+  username: user
+  password: password
+  useSSL: true
+```
+Enabling it will enable MySQL. The other settings are pretty straight forward.
+
+# Configuration changes
+Once enabled, configured values in groups.yml and users.yml will not be visible anymore,
+which is expected because your database is empty when created.
+This is not a bug.
+All you need to do is [upload your data to the database](#uploading-from-files-to-mysql).
+
+Since groups.yml and users.yml files will no longer be used, making any changes to them will take no effect. If you wish to perform any changes, you have 2 options:
+* Use in-game commands, which will upload changes to the database
+* Upload the file to the database after every change (will not work for removing though) (useful when enabling for the first time).
+
+# Data conversion
+## Downloading from MySQL to files
+This can be done using `/tab mysql download` command (permission is `tab.mysql.download`). It will download all data from the MySQL and save into groups.yml / users.yml.  
+This command requires the MySQL function enabled.  
+Existing data in files will not intentionally be deleted, but may get overwritten.
+
+## Uploading from files to MySQL
+This can be done using `/tab mysql upload` command (permission is `tab.mysql.upload`). It will upload all content from groups.yml and users.yml into MySQL.  
+This command requires the MySQL function enabled.  
+Existing data in the database will not intentionally be deleted, but may get overwritten.
+
+# Synchronization frequency
+When using files to store data, it's simple -
+groups.yml and users.yml files are loaded into memory and read from when needed.
+When a command is run to update something, it is updated in memory and saved into files as well.
+
+When using MySQL, the plugin has to keep data up to date with other servers, but at the same time not kill the server with requests all the time.  
+For writing, both groups and users, whenever a command is used to update something, the update is sent to the database immediately.  
+For reading, data is updated as following:
+* Groups - All data from groups table is loaded into memory on a load (server start, plugin reload). When a player joins in or any other action, values from memory are checked. Therefore, if a change is made on another server, it will not be visible until the plugin is reloaded.
+* Users - Nothing is loaded on a plugin load. Whenever a player joins, all data of that player is requested from the database. Therefore, if a player's data changes on another server, it is visible immediately when a player joins this one, without the need to reload the plugin.
@@ -0,0 +1,136 @@
+This guide will explain all primary ways you can reduce plugin's CPU usage besides the obvious things like "don't spam animations" or "disable features you don't want".  
+The usage can be checked at any time using [**/tab cpu**](https://github.com/NEZNAMY/TAB/wiki/Commands-&-Permissions#tab-cpu) command. If the numbers appear to be higher than they should be, check this guide for various ways to optimize the plugin. Most of these apply for all platforms, but some of them are only specific for some platforms.
+
+# Content
+* [#1 - [All platforms] Static text instead of placeholders](#1---all-platforms-static-text-instead-of-placeholders)
+* [#2 - [All platforms] Placeholder refresh intervals](#2---all-platforms-placeholder-refresh-intervals)
+* [#3 - [All platforms] Don't use RGB](#3---all-platforms-dont-use-rgb)
+* [#4 - [All platforms] Don't use animations](#4---all-platforms-dont-use-animations)
+* [#5 - [All platforms] Disable anti-override](#5---all-platforms-disable-anti-override)
+* [#6 - [All platforms] Disable tablist name formatting](#6---all-platforms-disable-tablist-name-formatting)
+* [#7 - [All platforms] Increase permission refresh interval](#7---all-platforms-increase-permission-refresh-interval)
+* [#8 - [BungeeCord / Velocity] Disable TAB expansion](#8---bungeecord--velocity-disable-tab-expansion)
+* [#9 - [BungeeCord / Velocity] Disable update-latency option in global playerlist](#9---bungeecord--velocity-disable-update-latency-option-in-global-playerlist)
+* [#10 - [BungeeCord] Disable ByteBuf deserialization](#10---bungeecord-disable-bytebuf-deserialization)
+
+# #1 - [All platforms] Static text instead of placeholders
+Static text doesn't need to be refreshed periodically, resulting in better performance.
+Some placeholders can be replaced with static text, such as placeholder for max player counts,
+since that value doesn't change at runtime.
+Another option is to configure prefixes per-group in config
+instead of using placeholders to take those values from your permission plugin.
+
+# #2 - [All platforms] Placeholder refresh intervals
+Some placeholders take a long time to process and result in high cpu usage. However, this can be optimized by configuring refresh interval of placeholders.
+
+This only works for PlaceholderAPI placeholders. Internal ones have an interval hardcoded already with values I found the most appropriate.
+
+To begin, find this part in your config
+```yml
+placeholderapi-refresh-intervals:
+  default-refresh-interval: 500
+  "%server_uptime%": 1000
+  "%server_tps_1_colored%": 1000
+  "%player_health%": 200
+  "%player_ping%": 1000
+  "%vault_prefix%": 1000
+  "%rel_factionsuuid_relation_color%": 500
+```
+Refresh interval is in milliseconds. It must be divisible by 50.
+
+`default-refresh-interval` is refresh interval for all unlisted PlaceholderAPI placeholders.
+
+Keep in mind that CPU measurement is reset every 10 seconds.
+This means that if you configure a higher refresh interval than 10000,
+there will be intervals when placeholder didn't refresh at all,
+making it look like the CPU is perfect, while on the next refresh it may be high.
+For this reason, if you want to cleanly track usage, keep the interval at 10000 at most.
+Using a higher interval will help if needed, but may lead to misleading info in cpu output.
+
+# #3 - [All platforms] Don't use RGB
+Though RGB colors look good, they require the text to be split into several components with `color` field used instead of the whole text pasted into the `text` field. This is a complicated process that takes quite some time. Sticking to legacy colors results in better performance.
+
+# #4 - [All platforms] Don't use animations
+While animations look cool, they also have a high resource usage.
+This is because they work by spamming updates every time an animation switches to a new frame.
+When animations are not used, no updates need to be sent (unless another placeholder changes value),
+not causing extra CPU usage.
+
+# #5 - [All platforms] Disable anti-override
+By default, TAB prevents other plugins from overriding it.
+This is because many server owners are not competent enough to configure their plugins correctly,
+such as disabling CMI collision handling which breaks nametags or even disabling team handling in paper.
+This obviously causes higher CPU usage.
+TAB logs all override attempts of teams into [anti-override.log](https://github.com/NEZNAMY/TAB/wiki/Action-logging#anti-overridelog) file.
+If you didn't get the file, it looks like you configured your plugins correctly.
+In that case, you can disable anti-override for teams in TAB.
+```
+scoreboard-teams:
+  anti-override: false
+```
+Tablist formatting is trickier, as override attempts are not logged because it would have a lot of false positives.
+You will need to try and see.
+
+```
+tablist-name-formatting:
+  anti-override: false
+```
+
+# #6 - [All platforms] Disable tablist name formatting
+As we already know from [Client-sided mechanics](https://github.com/NEZNAMY/TAB/wiki/Client%E2%80%90sided-mechanics#nametag-format-in-tablist) page,
+the nametag format appears in tablist if tablist name is not defined.
+You can take advantage of this to effectively disable one entire feature and its cpu usage,
+while not losing on anything.
+However, you can only do this if:
+* You are fine with nametag and tablist formats being identical, which also means all [nametag limitations](https://github.com/NEZNAMY/TAB/wiki/Feature-guide:-Nametags#limitations) will transfer to tablist as well
+* You don't have any plugin formatting the tablist names
+
+Whether you have another plugin attempting to handle them or not may not be easy to identify with a lot of plugins and not enough time spent configuring them. In that case, your best choice is to try it and see. If tablist names break, it means you have another plugin and cannot take advantage of this optimization option.
+
+# #7 - [All platforms] Increase permission refresh interval
+Plugin needs to constantly check permissions for:
+* Permission checks in conditions
+* Permission checks if sorting by permissions
+* Group retrieving from permission plugin (for sorting / per-group properties)
+* Prefix/suffix placeholders taking data from your permission plugin
+
+default value
+```
+permission-refresh-interval: 1000
+```
+Refreshes them every second.
+If you don't need any permission/group changes to take effect within a second,
+you can increase this value for better performance.
+
+# #8 - [BungeeCord / Velocity] Disable TAB expansion
+To maximize the performance of TAB's response to PlaceholderAPI request,
+values are tracked in advance and then quickly returned.
+This process takes resources and is especially heavy on proxy installation,
+where values must be constantly sent to bridge using plugin messages.  
+Disabling TAB's PlaceholderAPI expansion if you don't use it improves performance.  
+**config.yml**:
+```
+placeholders:
+  register-tab-expansion: false
+```
+# #9 - [BungeeCord / Velocity] Disable update-latency option in global playerlist
+When [Global playerlist](https://github.com/NEZNAMY/TAB/wiki/Feature-guide:-Global-playerlist) is enabled, you can enable / disable [update-latency](https://github.com/NEZNAMY/TAB/wiki/Feature-guide:-Global-playerlist#:~:text=other%20unlisted%20servers.-,update%2Dlatency,-false) option (open the link for detailed description of the option). Disabling this option massively improves performance.
+
+# #10 - [BungeeCord] Disable ByteBuf deserialization
+In order for anti-override to work properly, some packets must be manually deserialized due to BungeeCord not doing it. If you don't need it, you can disable those functions, which will also disable the deserialization completely. To do so, you must disable 2 functions (only having 1 disabled is not enough):  
+#1 - Anti-override for teams
+```
+scoreboard-teams:
+  anti-override: false
+```
+Whether you need anti-override or not depends on the configuration of your plugins.
+The easiest way is to have it enabled and see if you get `anti-override.log` file in TAB folder.
+If you don't, you don't need it.
+If you do, you'll need to do some configuring.
+[Here](https://github.com/NEZNAMY/TAB/wiki/Feature-guide:-Sorting-players-in-tablist#additional-note-3---compatibility-issues-with-other-plugins)
+are a few examples of software and their team names, which you may find helpful.
+
+#2 - Scoreboard detection of other plugins
+TAB checks for packets sent by other plugins, and if another plugin sends a scoreboard,
+TAB hides its own and resends it after the other plugin removes it.
+This check cannot be disabled if the scoreboard is enabled.
@@ -0,0 +1,241 @@
+# Content
+* [About](#about)
+* [Internal placeholders](#internal-placeholders)
+  * [Universal](#universal)
+  * [Backend only](#backend-only)
+  * [BungeeCord only](#bungeecord-only)
+* [PlaceholderAPI](#placeholderapi)
+* [Relational placeholders](#relational-placeholders)
+  * [About](#about-1)
+  * [Usage](#usage)
+* [Refreshing](#refreshing)
+  * [Refresh intervals](#refresh-intervals)
+  * [Sync refreshing](#sync-refreshing)
+* [Placeholder is not working](#placeholder-is-not-working)
+  * [Internal placeholder is not working](#internal-placeholder-is-not-working)
+  * [PlaceholderAPI placeholder is not working](#placeholderapi-placeholder-is-not-working)
+* [API](#api)
+  * [Server placeholders](#server-placeholders)
+  * [Player placeholders](#player-placeholders)
+  * [Relational placeholders](#relational-placeholders-1)
+
+# About
+TAB offers various placeholders to display the most common information. It also supports [PlaceholderAPI placeholders](https://github.com/PlaceholderAPI/PlaceholderAPI/wiki/Placeholders).
+
+# Internal placeholders
+
+Basic placeholders provided by the plugin. Most of these placeholders were added because they were requested by people who don't want to install another plugin just to show username. Some of them have configurable output in config.yml in `Placeholders` section. Unused placeholders do not affect performance in any way.
+
+Placeholders must be refreshed.
+All internal placeholders have a manually defined refresh interval,
+which I found the most optimal and cannot be changed.
+Time is in milliseconds.
+It is used for placeholders which are in fact constants (such as %player%),
+or fire an event each time they change, which can be listened to (such as %world%) and value updated.
+Refresh interval for conditions is set to be equal to the fastest refreshing placeholder used inside each condition.
+
+## Universal
+These placeholders are available on all platforms.
+
+| Identifier          | Refresh interval | Description                                                                                                                                                                                                                                                                                                                                          |
+|---------------------|------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
+| %online%            | 1000             | Total online player count on server where plugin is installed (excluding [vanished players](https://github.com/NEZNAMY/TAB/wiki/Additional-information#vanish-detection)). If the plugin is installed on a proxy, it will show total player count on the whole network.                                                                              |
+| %world%             | -1               | Name of world where player is                                                                                                                                                                                                                                                                                                                        |
+| %worldonline%       | 1000             | Amount of players in the same world (excluding [vanished players](https://github.com/NEZNAMY/TAB/wiki/Additional-information#vanish-detection)) as the player                                                                                                                                                                                        |
+| %ping%              | 500              | Player's ping to the server where TAB is installed. <br />**Note**: This value is measured by the server and TAB is only retrieving that value. If it's wrong, it's not a TAB issue.                                                                                                                                                                 |
+| %player%            | -1               | Player's name                                                                                                                                                                                                                                                                                                                                        |
+| %time%              | 500              | Current real time, output is configurable in **config.yml** in `time-format` option                                                                                                                                                                                                                                                                  |
+| %date%              | 60000            | Current date, output is configurable in **config.yml** in `date-format` option                                                                                                                                                                                                                                                                       |
+| %staffonline%       | 2000             | Amount of online players with `tab.staff` permission                                                                                                                                                                                                                                                                                                 |
+| %nonstaffonline%    | 2000             | Amount of online players without `tab.staff` permission                                                                                                                                                                                                                                                                                              |
+| %memory-used%       | 200              | Used RAM of server in MB                                                                                                                                                                                                                                                                                                                             |
+| %memory-max%        | -1               | Total RAM of server in MB                                                                                                                                                                                                                                                                                                                            |
+| %memory-used-gb%    | 200              | Used RAM of server in GB                                                                                                                                                                                                                                                                                                                             |
+| %memory-max-gb%     | -1               | Total RAM of server in GB                                                                                                                                                                                                                                                                                                                            |
+| %player-version%    | -1               | User-friendly version of player, such as `1.14.4`. For versions that share the same protocol version number, the higher one is returned (for example 1.20 & 1.20.1 -> 1.20.1 is returned)                                                                                                                                                            |
+| %player-version-id% | -1               | Network ID of player's version. You can see the full version map on [fan wiki](https://wiki.vg/Protocol_version_numbers) for all versions or [TAB's source code](https://github.com/NEZNAMY/TAB/blob/master/shared/src/main/java/me/neznamy/tab/shared/ProtocolVersion.java) for releases only. Useful for conditions to create per-version results. |
+| %luckperms-prefix%  | 1000             | Prefix from LuckPerms from the server where TAB is installed                                                                                                                                                                                                                                                                                         |
+| %luckperms-suffix%  | 1000             | Suffix from LuckPerms from the server where TAB is installed                                                                                                                                                                                                                                                                                         |
+| %displayname%       | 500              | Display name variable set by permission plugin, typically prefix + name + suffix                                                                                                                                                                                                                                                                     |
+| %group%             | 1000             | Returns player's primary group name. Created for internal functionality, but can be used as a display placeholder as well.                                                                                                                                                                                                                           |
+| %vanished%          | 1000             | Returns `true`/`false` based on player's vanish status. Created for internal functionality, but can be used as a display placeholder as well.                                                                                                                                                                                                        |
+| %bedrock%           | -1               | Returns `true`/`false` based on whether player is using Bedrock edition or not (Java)                                                                                                                                                                                                                                                                |
+| %%                  | -1               | Returns the `%` symbol. Useful to display `%` symbol without breaking all placeholders after it                                                                                                                                                                                                                                                      |
+
+## Backend only
+These placeholders only work when TAB is installed on a backend server (Bukkit / Sponge / Fabric), they don't work when TAB is on BungeeCord. If you have TAB installed on BungeeCord and wish to use these, use their [PlaceholderAPI](https://github.com/NEZNAMY/TAB/wiki/Quick-PlaceholderAPI-startup-guide) alternative with [Bridge plugin](https://github.com/NEZNAMY/TAB/wiki/TAB-Bridge) installed for PlaceholderAPI support on BungeeCord.
+| Identifier | Refresh interval | Description | PlaceholderAPI alternative |
+| ------------- | ------------- | ------------- | ------------- |
+| %health% | 100 | Player's health, rounded up to match Minecraft's heart display. | %player_health_rounded% |
+| %displayname% | 500 | Player's display name value set by permission plugin. | %player_displayname% |
+| %tps%               | 1000 | TPS of server from the last minute (measured by server, not available on Fabric as it doesn't measure the value) | %server_tps_1% |
+| %mspt%              | 1000 | Server's current milliseconds per tick (Paper / Sponge 8+ / Fabric only) | - |
+
+## BungeeCord only
+| Identifier                   | Refresh interval | Description                                                                                                                                                                   |
+|------------------------------|------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
+| %server%                     | -1               | Name of server where player is, defined in proxy's config.                                                                                                                    |
+| %serveronline%               | 1000             | Amount of online players on server where the player is (excluding vanished players)                                                                                           |
+| %online_\<server name\>%     | 1000             | Amount of online players on specified server (excluding vanished players)                                                                                                     |
+| %playerlist-group_\<group\>% | 1000             | Amount of online players in specified [global playerlist](https://github.com/NEZNAMY/TAB/wiki/Feature-guide:-Global-playerlist) group (therefore the feature must be enabled) |
+
+# PlaceholderAPI
+PlaceholderAPI is supported and relational placeholders are supported too.
+When parsing relational placeholders,
+TAB puts viewer as the first player argument and target player as the second argument.
+
+You can find most of the placeholders
+that PlaceholderAPI offers on [PlaceholderAPI wiki](https://github.com/PlaceholderAPI/PlaceholderAPI/wiki/Placeholders).
+Some plugins are not listed there, for those you'll need to check their own wiki for placeholders.
+
+TAB also offers its own placeholders into PlaceholderAPI. To enable TAB's expansion, set
+```
+placeholders:
+  register-tab-expansion: true
+```
+in **config.yml**.  
+Full list of placeholders:  
+| Identifier  | Description |
+| ------------- | ------------- |
+| %tab_tabprefix% | Current tabprefix with replaced placeholders |
+| %tab_tabsuffix% | Current tabsuffix with replaced placeholders |
+| %tab_tagprefix% | Current tagprefix with replaced placeholders |
+| %tab_tagsuffix% | Current tagsuffix with replaced placeholders |
+| %tab_customtabname% | Current customtabname with replaced placeholders |
+| %tab_tabprefix_raw% | Raw tabprefix containing raw placeholders |
+| %tab_tabsuffix_raw% | Raw tabsuffix containing raw placeholders |
+| %tab_tagprefix_raw% | Raw tagprefix containing raw placeholders |
+| %tab_tagsuffix_raw% | Raw tagsuffix containing raw placeholders |
+| %tab_customtabname_raw% | Raw customtabname containing raw placeholders |
+| %tab_scoreboard_name% | Returns name of player's currently displayed scoreboard or empty string if none is displayed due to no display condition being met |
+| %tab_scoreboard_visible% | "Enabled" if visible, "Disabled" if not |
+| %tab_bossbar_visible% | "Enabled" if visible, "Disabled" if not |
+| %tab_nametag_preview% | "Enabled" if previewing armor stands using /tab nametag preview, "Disabled" if not |
+| %tab_nametag_visibility% | "Enabled" if player can see nametags, "Disabled" if disabled using /tab nametag toggle |
+| %tab_replace_\<placeholder\>% | Applies [Placeholder output replacements](https://github.com/NEZNAMY/TAB/wiki/Feature-guide:-Placeholder-output-replacements) to a PlaceholderAPI placeholder (for example %tab_replace_essentials_vanished%) |
+| %tab_placeholder_\<placeholder\>% | returns value of tab's internal placeholder (such as %tab_placeholder_animation:name% for %animation:name%) |
+
+# Relational placeholders
+## About
+Unlike classic placeholders which take either 0
+(placeholders with the same output for all players) or 1 (per-player placeholders) players,
+relational placeholders take in 2 players.
+The first usage was to display relation between two players, specifically enemies / allies (red / green) for factions,
+allowing players to see faction names of other players colored based on relation.
+While the usage is not limited to this, the name of the 2-player placeholder type has been established as "relational"
+and will be called that everywhere.
+
+## Usage
+TAB does not offer any internal relational placeholders. However, it has full support for PlaceholderAPI placeholders. You can also register your own relational placeholders using the [API](#relational-placeholders-1). In PlaceholderAPI, all relational placeholder identifiers must start with `%rel_`. This rule is adopted and used in TAB as well (including those registered via API).
+
+When passing players into the function, first player is the player viewing the text, second player is the one text is being displayed on.  
+Code wise, the PlaceholderAPI request function becomes
+```
+public String onPlaceholderRequest(Player viewer, Player target, String identifier)
+```
+where `viewer` is the player looking and `target` is the player the value is being displayed on.
+
+When trying to use placeholders from other plugins, you will need to check their documentation and search for relational placeholders. If your plugin does not appear to offer any, you ran out of luck and TAB cannot do anything about it.  
+To properly distinguish viewer/target (if needed), your relational placeholder expansion must follow the same order as TAB does. Since PlaceholderAPI never created any convention regarding this, and instead it calls the players `one` and `two`, I had to decide and this is the decision.
+
+# Refreshing
+## Refresh intervals
+TAB is refreshing placeholders in intervals. For internal placeholders it's using values I found the most optimal and set directly in the plugin. Refresh intervals for PlaceholderAPI placeholders can be [configured](https://github.com/NEZNAMY/TAB/wiki/Optimizing-the-plugin#2---placeholder-refresh-intervals).
+
+## Sync refreshing
+By default, all placeholders are refreshed asynchronously,
+so they don't slow down the server, since reading should be a thread-safe operation.
+Some placeholders, however, require to be refreshed in the main thread,
+causing problems or throwing errors when refreshed asynchronously.
+For these, replace them with `%sync:<original placeholder>%` and they will be refreshed in the main thread,
+for example `%server_total_entities%` -> `%sync:server_total_entities%`.  
+Keep in mind that now you should configure a reasonable refresh interval for these placeholders to not cause TPS drops
+(with async placeholders it doesn't really matter).
+Configured refresh intervals and CPU usage of placeholders can be checked using `/tab cpu`.
+
+# Placeholder is not working
+When using a placeholder, you should know if it's a [TAB's internal placeholder](#internal-placeholders) or a [PlaceholderAPI placeholder](https://github.com/PlaceholderAPI/PlaceholderAPI/wiki/Placeholders). If you don't, that's the problem.
+
+> [!CAUTION]
+> Remember that using `%` symbol will mess up placeholder starts and ends, breaking all placeholders after it.
+> To make the symbol display correctly without messing up placeholders, use `%%` to display the symbol.  
+> **Example:** `Sale 100% OFF! %some_placeholder%` -> `Sale 100%% OFF! %some_placeholder%`.
+
+## Internal placeholder is not working
+All TAB's internal placeholders are listed above.
+Some of them are bukkit only (meaning they won't work on bungeecord) and some are bungee only.
+> [!IMPORTANT]
+> Trying to use a bukkit-only placeholder on bungeecord will not work.
+> If you want to use those,
+> [set up PlaceholderAPI support on bungeecord](https://github.com/NEZNAMY/TAB/wiki/TAB-Bridge)
+> and find their PlaceholderAPI equivalent.
+> For example, you can use %vault_prefix% instead of %vault-prefix%,
+> %player_health_rounded% instead of %health% and so on.
+
+## PlaceholderAPI placeholder is not working
+If you have TAB installed on bungeecord, make sure you [set up PlaceholderAPI support on bungeecord](https://github.com/NEZNAMY/TAB/wiki/TAB-Bridge) as there is no other way to retrieve data from technically a different server.
+
+> [!TIP]
+> Use `/papi parse me <placeholder>` to check if the placeholder is working.
+> If it does not work, the issue is not on TAB's end.
+
+# API
+*To get started with the API, see [Developer API](https://github.com/NEZNAMY/TAB/wiki/Developer-API) page.*
+
+For working with placeholders, you will need the `PlaceholderManager`. Get it using `TabAPI.getInstance().getPlaceholderManager()`.
+
+Placeholders have two attributes:
+* An identifier, which is used to uniquely identify the placeholder. This is also what's usually used for replacement. For example, in `%uptime%`, the identifier is `%uptime%`.
+* A refresh rate in milliseconds, which is how often the placeholder's refresh function will be called, to get a new value to display. Use `-1` to make the placeholder never refresh periodically. This can be used for either constants or placeholders that update on events, and you wish to update their value manually using functions in the respective placeholder interface.
+
+## Server placeholders
+Server placeholders are global to the entire plugin. Their values are not dependent on player.  
+Examples of server placeholders would be uptime and TPS placeholders.
+
+To register a new server placeholder, use `PlaceholderManager#registerServerPlaceholder(String, int, Supplier<Object>)`. The first two parameters are explained above, and the last parameter is a function that will be called to refresh the value of the placeholder.
+<details>
+  <summary>Example</summary>
+
+```
+TabAPI.getInstance().getPlaceholderManager().registerServerPlaceholder("%system-time%", 50, () -> System.currentTimeMillis());
+```
+
+This placeholder will show current system time and update every 50 milliseconds.
+</details>
+
+## Player placeholders
+Player placeholders are calculated on a per-player basis. These depend on the player that we want to get the value for.  
+Examples of player placeholders would be username and prefix.
+
+To register a new player placeholder, use `PlaceholderManager#registerPlayerPlaceholder(String, int, Function<TabPlayer, Object>)`. The first two parameters are explained above, and the last parameter is a function that will be called to refresh the value of the placeholder.
+<details>
+  <summary>Example</summary>
+
+```
+TabAPI.getInstance().getPlaceholderManager().registerPlayerPlaceholder("%player-uuid%", -1, player -> player.getUniqueId());
+```
+
+This placeholder will show player's UUID and never refreshes, since UUID doesn't change at runtime.
+</details>
+
+## Relational placeholders
+Relational placeholders are calculated using a pair of players, instead of a single one. These depend on the player pair that we want to get the value for. Their identifier must start with `rel_`.
+
+To register a new relational placeholder, use `PlaceholderManager#registerRelationalPlaceholder(String, int, BiFunction<TabPlayer, TabPlayer, Object>)`. The first two parameters are explained above, and the last parameter is a function that will be called to refresh the value of the placeholder.
+<details>
+  <summary>Example</summary>
+
+```
+TabAPI.getInstance().getPlaceholderManager().registerRelationalPlaceholder("%rel_staff_version%", 1000, (viewer, target) -> {
+    if (viewer.hasPermission("tab.staff")) {
+        return target.getVersion().getFriendlyName();
+    } else {
+        return "";
+    }
+});
+```
+
+This placeholder will show the version of players, but only to those, who have `tab.staff` permission.
+The first player in the method is viewer, the second player is target.
+The same order is applied when hooking into PlaceholderAPI as well.
+</details>
@@ -0,0 +1,29 @@
+# About
+This is a quick guide for [PlaceholderAPI](https://www.spigotmc.org/resources/placeholderapi.6245/) plugin, which is often referred to on the wiki, and we also get many assistance requests with TAB which turn out to be asking for help with PlaceholderAPI. Whether its documentation is not clear enough, missing information or users just don't read it isn't the topic here to judge, instead, a quick guide with everything needed is provided.
+
+# Installation
+PlaceholderAPI is a standalone bukkit plugin that can be installed just like any other plugin.
+It does not support BungeeCord.
+If you have TAB on BungeeCord and wish to use PlaceholderAPI placeholders,
+you'll need to install [Bridge](https://www.spigotmc.org/resources/83966) plugin on backend servers.
+Alongside other features, it forwards PlaceholderAPI support to the proxy.
+
+# Expansions
+To effectively scale and allow the level of modification it does,
+PlaceholderAPI is using placeholder packages called expansions.
+They are loaded into the plugin on startup.
+Each expansion can be created and modified independently of the main plugin's update frequency.
+Each expansion has a name, which is used to identify its placeholders.  
+The syntax is `%<expansion>_<placeholder>%`, where `<expansion>` is name of the expansion,
+for example `player` and `<placeholder>` is placeholder of the expansion, for example `health`,
+which returns player's health.
+The full placeholder syntax will then be `%player_health%`.
+
+Some plugins offer their own expansions,
+which are either integrated into the plugin itself or external on PlaceholderAPI cloud.
+Integrated expansions are not downloaded; instead, plugins register them automatically.
+
+You can download / update external expansions using `/papi ecloud download <expansion>`. After downloading it, run `/papi reload` to enable it.
+
+# Checking if placeholder is working
+To check if a placeholder is working, run `/papi parse <player> <placeholder>`. You can also use `me` as player, which parses placeholder for the player who ran the command. If the command outputs the identifier you entered and not the actual output, it means you either entered and invalid placeholder or you are missing an expansion (or you have an outdated version of the expansion), see above.  
@@ -0,0 +1,33 @@
+# About
+When TAB is installed on BungeeCord, the plugin has very limited access to information. It is unable to retrieve internal server data, as well as hook into backend plugins, because it's a different server.  
+Bridge is a backend plugin that sends this data to the proxy, allowing TAB to work better when installed on BungeeCord.  
+You can download it from [GitHub](https://github.com/NEZNAMY/TAB-Bridge/releases) or [Spigot](https://www.spigotmc.org/resources/83966).
+
+# Installation
+Installation is as simple as it can be.
+Put it into the plugins folder of your backend servers.
+Bridge is NOT a BungeeCord plugin!
+Bridge itself has no config file, as everything is configured in the main plugin.
+
+# Features
+* Forwarding PlaceholderAPI support to the proxy
+* Allow detection if player is invisible to make their nametag invisible (compensation for 1.8.x client sided bug)
+* Allow detection if a player is disguised to disable collision to prevent endless push
+* Forwarding permission groups of players if no permission plugin is installed on BungeeCord
+* Forwarding vanish status for compatibility with global playerlist / layout features
+* Forward player's world for %world% and per-world settings
+* Allow TAB's PlaceholderAPI expansion with TAB on BungeeCord
+* Forward player's gamemode for spectator fix feature to work
+
+# Compatibility
+Just like with Minecraft, when there is a change in the communication protocol,
+older software will not be compatible with the new one.
+You should always be running the latest versions of both TAB and Bridge.
+
+# Confirming it works
+You have many ways to verify TAB and Bridge are properly connected. Besides checking if the features above work, the easiest one is to run `/btab debug <player>`.  
+If it's properly connected, you'll get a message saying this:  
+![image](https://github.com/NEZNAMY/TAB/assets/6338394/3f8dd978-a8bd-4613-9ea1-a56340194859)  
+If it's not properly connected, you'll get this message:  
+![image](https://github.com/NEZNAMY/TAB/assets/6338394/a90018bc-2c3b-4bf5-b54c-56621178ce80)  
+If this is the case, it means Bridge is either not installed or versions are not compatible. Update both to the latest version.
@@ -0,0 +1,147 @@
+# ---------------------------------------
+# THIS PAGE IS A WORK IN PROGRESS
+# ---------------------------------------
+
+# About
+This page compares TAB to other plugins offering similar features based on various parameters.
+
+### Open issues
+Number of open issues on GitHub. Keep in mind this number shouldn't be taken 100% seriously, because:
+* People often open issues to ask for help instead of reporting an issue.
+* If nobody is using a plugin, nobody can find bugs. Bug not found doesn't mean it's not there.
+* Some issues may be feature requests, which may not be present elsewhere as those are not accepted.
+
+### Price
+The price to get the jar. Most plugins are free, some are paid.
+
+### Minecraft
+Supported Minecraft versions by the plugin.
+
+### Platforms
+Supported platforms by the plugin. Full tracked list includes:
+* Bukkit ![image](https://github.com/NEZNAMY/TAB/assets/6338394/e39f160b-f2f4-4ccc-84ad-583092741577)
+* Sponge ![image](https://github.com/NEZNAMY/TAB/assets/6338394/f3cc3194-6dfc-4b15-8d46-52144a4a0352)
+* Fabric ![image](https://github.com/NEZNAMY/TAB/assets/6338394/ffbf8384-fff5-4a32-8fc5-0768246e91c1)
+* Forge ![image](https://github.com/NEZNAMY/TAB/assets/6338394/268c1571-0087-466b-b502-ec16017ac1d6)
+* BungeeCord ![image](https://github.com/NEZNAMY/TAB/assets/6338394/99ae3191-7b35-4883-91a9-4edbb1e88ac9)
+* Velocity ![image](https://github.com/NEZNAMY/TAB/assets/6338394/53ad76a7-f61c-4b4f-8411-32ad5c473c4d)
+
+### Async
+Whether the plugin runs in server's main thread (sync) or in a different thread (async). If a plugin is running sync, it may slow down the server's TPS. All of these features can be done async.
+
+# Belowname
+| Attribute                         | [TAB](https://github.com/NEZNAMY/TAB)                                                                                                                                                                                                                                                                                                                                                                                                                                            |
+|-----------------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
+| **Open issues**                   | ![Issues](https://img.shields.io/github/issues/NEZNAMY/TAB)                                                                                                                                                                                                                                                                                                                                                                                                                      |
+| **Price**                         | ![image](https://github.com/NEZNAMY/TAB/assets/6338394/9bfa85bd-771c-4d78-ab15-be76665bd84a)                                                                                                                                                                                                                                                                                                                                                                                     |
+| **Minecraft**                     | 1.5+                                                                                                                                                                                                                                                                                                                                                                                                                                                                             |
+| **Platforms**                     | ![image](https://github.com/NEZNAMY/TAB/assets/6338394/e39f160b-f2f4-4ccc-84ad-583092741577) ![image](https://github.com/NEZNAMY/TAB/assets/6338394/f3cc3194-6dfc-4b15-8d46-52144a4a0352) ![image](https://github.com/NEZNAMY/TAB/assets/6338394/ffbf8384-fff5-4a32-8fc5-0768246e91c1) ![image](https://github.com/NEZNAMY/TAB/assets/6338394/99ae3191-7b35-4883-91a9-4edbb1e88ac9) ![image](https://github.com/NEZNAMY/TAB/assets/6338394/53ad76a7-f61c-4b4f-8411-32ad5c473c4d) |
+| **Async**                         | ✔                                                                                                                                                                                                                                                                                                                                                                                                                                                                                |
+| PlaceholderAPI support            | ✔                                                                                                                                                                                                                                                                                                                                                                                                                                                                                |
+| Configurable number               | ✔                                                                                                                                                                                                                                                                                                                                                                                                                                                                                |
+| Configurable text                 | ✔                                                                                                                                                                                                                                                                                                                                                                                                                                                                                |
+| 1.20.3+ NumberFormat support      | ✔                                                                                                                                                                                                                                                                                                                                                                                                                                                                                |
+| Conditionally disable the feature | If any specified condition is met                                                                                                                                                                                                                                                                                                                                                                                                                                                |
+
+# Bossbar
+| Attribute         | [TAB](https://github.com/NEZNAMY/TAB)                                                                                                                                                                                                                                                                                                                                                                                                                                            | [UltraBar](https://github.com/ryandw11/UltraBar)                                             | [AnimaBossBar](https://www.spigotmc.org/resources/bossbar-spigot-free-bossbar-plugin-1-9-1-18-1.59135/) |
+|-------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|----------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------|
+| **Open issues**   | ![Issues](https://img.shields.io/github/issues/NEZNAMY/TAB)                                                                                                                                                                                                                                                                                                                                                                                                                      | ![Issues](https://img.shields.io/github/issues/ryandw11/UltraBar)                            | -                                                                                                       |
+| **Price**         | ![image](https://github.com/NEZNAMY/TAB/assets/6338394/9bfa85bd-771c-4d78-ab15-be76665bd84a)                                                                                                                                                                                                                                                                                                                                                                                     | ![image](https://github.com/NEZNAMY/TAB/assets/6338394/9bfa85bd-771c-4d78-ab15-be76665bd84a) | ![image](https://github.com/NEZNAMY/TAB/assets/6338394/9bfa85bd-771c-4d78-ab15-be76665bd84a)            |
+| **Minecraft**     | 1.5+                                                                                                                                                                                                                                                                                                                                                                                                                                                                             | 1.12+                                                                                        | 1.9 - 1.18.1                                                                                            |
+| **Platforms**     | ![image](https://github.com/NEZNAMY/TAB/assets/6338394/e39f160b-f2f4-4ccc-84ad-583092741577) ![image](https://github.com/NEZNAMY/TAB/assets/6338394/f3cc3194-6dfc-4b15-8d46-52144a4a0352) ![image](https://github.com/NEZNAMY/TAB/assets/6338394/ffbf8384-fff5-4a32-8fc5-0768246e91c1) ![image](https://github.com/NEZNAMY/TAB/assets/6338394/99ae3191-7b35-4883-91a9-4edbb1e88ac9) ![image](https://github.com/NEZNAMY/TAB/assets/6338394/53ad76a7-f61c-4b4f-8411-32ad5c473c4d) | ![image](https://github.com/NEZNAMY/TAB/assets/6338394/e39f160b-f2f4-4ccc-84ad-583092741577) | ![image](https://github.com/NEZNAMY/TAB/assets/6338394/e39f160b-f2f4-4ccc-84ad-583092741577)            |
+| **Async**         | ✔                                                                                                                                                                                                                                                                                                                                                                                                                                                                                | ❌                                                                                            | ❌                                                                                                       |
+| Announcements     | ✔ (defined in config)                                                                                                                                                                                                                                                                                                                                                                                                                                                            | ✔ (defined at runtime)                                                                       | ✔ (defined at runtime)                                                                                  |
+| Toggle command    | ✔ (customizable)                                                                                                                                                                                                                                                                                                                                                                                                                                                                 | ❌                                                                                            | ❌                                                                                                       |
+| Display condition | Anything that has a placeholder                                                                                                                                                                                                                                                                                                                                                                                                                                                  | On join / death / command / in worldguard region                                             | ❌                                                                                                       |
+
+# Global Playerlist
+| Attribute       | [TAB](https://github.com/NEZNAMY/TAB)                                                                                                                                                     | [BungeeTabListPlus](https://github.com/CodeCrafter47/BungeeTabListPlus)                      | [Velocitab](https://github.com/WiIIiam278/Velocitab)                                         |
+|-----------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|----------------------------------------------------------------------------------------------|----------------------------------------------------------------------------------------------|
+| **Open issues** | ![Issues](https://img.shields.io/github/issues/NEZNAMY/TAB)                                                                                                                               | ![Issues](https://img.shields.io/github/issues/CodeCrafter47/BungeeTabListPlus)              | ![Issues](https://img.shields.io/github/issues/WiIIiam278/Velocitab)                         |
+| **Price**       | ![image](https://github.com/NEZNAMY/TAB/assets/6338394/9bfa85bd-771c-4d78-ab15-be76665bd84a)                                                                                              | ![image](https://github.com/NEZNAMY/TAB/assets/6338394/9bfa85bd-771c-4d78-ab15-be76665bd84a) | ![image](https://github.com/NEZNAMY/TAB/assets/6338394/9bfa85bd-771c-4d78-ab15-be76665bd84a) |
+| **Platforms**   | ![image](https://github.com/NEZNAMY/TAB/assets/6338394/99ae3191-7b35-4883-91a9-4edbb1e88ac9) ![image](https://github.com/NEZNAMY/TAB/assets/6338394/53ad76a7-f61c-4b4f-8411-32ad5c473c4d) | ![image](https://github.com/NEZNAMY/TAB/assets/6338394/99ae3191-7b35-4883-91a9-4edbb1e88ac9) | ![image](https://github.com/NEZNAMY/TAB/assets/6338394/53ad76a7-f61c-4b4f-8411-32ad5c473c4d) |
+
+# Header/Footer
+| Attribute       | [TAB](https://github.com/NEZNAMY/TAB)                                                                                                                                                                                                                                                                                                                                                                                                                                            | [TabList](https://github.com/montlikadani/TabList)                                                                                                                                                                                                                                     |
+|-----------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
+| **Open issues** | ![Issues](https://img.shields.io/github/issues/NEZNAMY/TAB)                                                                                                                                                                                                                                                                                                                                                                                                                      | ![Issues](https://img.shields.io/github/issues/montlikadani/TabList)                                                                                                                                                                                                                   |
+| **Price**       | ![image](https://github.com/NEZNAMY/TAB/assets/6338394/9bfa85bd-771c-4d78-ab15-be76665bd84a)                                                                                                                                                                                                                                                                                                                                                                                     | ![image](https://github.com/NEZNAMY/TAB/assets/6338394/9bfa85bd-771c-4d78-ab15-be76665bd84a)                                                                                                                                                                                           |
+| **Platforms**   | ![image](https://github.com/NEZNAMY/TAB/assets/6338394/e39f160b-f2f4-4ccc-84ad-583092741577) ![image](https://github.com/NEZNAMY/TAB/assets/6338394/f3cc3194-6dfc-4b15-8d46-52144a4a0352) ![image](https://github.com/NEZNAMY/TAB/assets/6338394/ffbf8384-fff5-4a32-8fc5-0768246e91c1) ![image](https://github.com/NEZNAMY/TAB/assets/6338394/99ae3191-7b35-4883-91a9-4edbb1e88ac9) ![image](https://github.com/NEZNAMY/TAB/assets/6338394/53ad76a7-f61c-4b4f-8411-32ad5c473c4d) | ![image](https://github.com/NEZNAMY/TAB/assets/6338394/e39f160b-f2f4-4ccc-84ad-583092741577) ![image](https://github.com/NEZNAMY/TAB/assets/6338394/f3cc3194-6dfc-4b15-8d46-52144a4a0352) ![image](https://github.com/NEZNAMY/TAB/assets/6338394/99ae3191-7b35-4883-91a9-4edbb1e88ac9) |
+
+# Layout
+| Attribute       | [TAB](https://github.com/NEZNAMY/TAB)                                                                                                                                                                                                                                                                                                                                                                                                                                            | [BungeeTabListPlus](https://github.com/CodeCrafter47/BungeeTabListPlus)                                                                                                                   |
+|-----------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
+| **Open issues** | ![Issues](https://img.shields.io/github/issues/NEZNAMY/TAB)                                                                                                                                                                                                                                                                                                                                                                                                                      | ![Issues](https://img.shields.io/github/issues/CodeCrafter47/BungeeTabListPlus)                                                                                                           |
+| **Price**       | ![image](https://github.com/NEZNAMY/TAB/assets/6338394/9bfa85bd-771c-4d78-ab15-be76665bd84a)                                                                                                                                                                                                                                                                                                                                                                                     | ![image](https://github.com/NEZNAMY/TAB/assets/6338394/9bfa85bd-771c-4d78-ab15-be76665bd84a)                                                                                              |
+| **Platforms**   | ![image](https://github.com/NEZNAMY/TAB/assets/6338394/e39f160b-f2f4-4ccc-84ad-583092741577) ![image](https://github.com/NEZNAMY/TAB/assets/6338394/f3cc3194-6dfc-4b15-8d46-52144a4a0352) ![image](https://github.com/NEZNAMY/TAB/assets/6338394/ffbf8384-fff5-4a32-8fc5-0768246e91c1) ![image](https://github.com/NEZNAMY/TAB/assets/6338394/99ae3191-7b35-4883-91a9-4edbb1e88ac9) ![image](https://github.com/NEZNAMY/TAB/assets/6338394/53ad76a7-f61c-4b4f-8411-32ad5c473c4d) | ![image](https://github.com/NEZNAMY/TAB/assets/6338394/e39f160b-f2f4-4ccc-84ad-583092741577) ![image](https://github.com/NEZNAMY/TAB/assets/6338394/99ae3191-7b35-4883-91a9-4edbb1e88ac9) |
+
+# Nametags
+| Attribute                         | [TAB](https://github.com/NEZNAMY/TAB)                                                                                                                                                                                                                                                                                                                                                                                                                                            | [NametagEdit](https://github.com/sgtcaze/NametagEdit)                                        |
+|-----------------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|----------------------------------------------------------------------------------------------|
+| **Open issues**                   | ![Issues](https://img.shields.io/github/issues/NEZNAMY/TAB)                                                                                                                                                                                                                                                                                                                                                                                                                      | ![Issues](https://img.shields.io/github/issues/sgtcaze/NametagEdit)                          |
+| **Price**                         | ![image](https://github.com/NEZNAMY/TAB/assets/6338394/9bfa85bd-771c-4d78-ab15-be76665bd84a)                                                                                                                                                                                                                                                                                                                                                                                     | ![image](https://github.com/NEZNAMY/TAB/assets/6338394/9bfa85bd-771c-4d78-ab15-be76665bd84a) |
+| **Minecraft**                     | 1.5+                                                                                                                                                                                                                                                                                                                                                                                                                                                                             | 1.7+                                                                                         |
+| **Platforms**                     | ![image](https://github.com/NEZNAMY/TAB/assets/6338394/e39f160b-f2f4-4ccc-84ad-583092741577) ![image](https://github.com/NEZNAMY/TAB/assets/6338394/f3cc3194-6dfc-4b15-8d46-52144a4a0352) ![image](https://github.com/NEZNAMY/TAB/assets/6338394/ffbf8384-fff5-4a32-8fc5-0768246e91c1) ![image](https://github.com/NEZNAMY/TAB/assets/6338394/99ae3191-7b35-4883-91a9-4edbb1e88ac9) ![image](https://github.com/NEZNAMY/TAB/assets/6338394/53ad76a7-f61c-4b4f-8411-32ad5c473c4d) | ![image](https://github.com/NEZNAMY/TAB/assets/6338394/e39f160b-f2f4-4ccc-84ad-583092741577) |
+| **Async**                         | ✔                                                                                                                                                                                                                                                                                                                                                                                                                                                                                | ❌                                                                                            |
+| Customization                     | Per-group<br />Per-player<br />Per-world<br />Per-server                                                                                                                                                                                                                                                                                                                                                                                                                         | Per-group<br />Per-player                                                                    |
+| PlaceholderAPI support            | ✔                                                                                                                                                                                                                                                                                                                                                                                                                                                                                | ✔                                                                                            |
+| Configurable collision            | ✔                                                                                                                                                                                                                                                                                                                                                                                                                                                                                | ✔                                                                                            |
+| Configurable nametag visibility   | ✔                                                                                                                                                                                                                                                                                                                                                                                                                                                                                | ❌                                                                                            |
+| Conditionally disable the feature | If any specified condition is met                                                                                                                                                                                                                                                                                                                                                                                                                                                | ❌                                                                                            |
+| Bonus                             | - Option to use armor stands to bypass<br />   all limits and support multiple lines<br />- Anti-override to avoid random plugins breaking it                                                                                                                                                                                                                                                                                                                                    | -                                                                                            |
+
+# Per world playerlist
+
+# Playerlist objective
+| Attribute                         | [TAB](https://github.com/NEZNAMY/TAB)                                                                                                                                                                                                                                                                                                                                                                                                                                            | [TabList](https://github.com/montlikadani/TabList)                                                                                                                                        |
+|-----------------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
+| **Open issues**                   | ![Issues](https://img.shields.io/github/issues/NEZNAMY/TAB)                                                                                                                                                                                                                                                                                                                                                                                                                      | ![Issues](https://img.shields.io/github/issues/montlikadani/TabList)                                                                                                                      |
+| **Price**                         | ![image](https://github.com/NEZNAMY/TAB/assets/6338394/9bfa85bd-771c-4d78-ab15-be76665bd84a)                                                                                                                                                                                                                                                                                                                                                                                     | ![image](https://github.com/NEZNAMY/TAB/assets/6338394/9bfa85bd-771c-4d78-ab15-be76665bd84a)                                                                                              |
+| **Platforms**                     | ![image](https://github.com/NEZNAMY/TAB/assets/6338394/e39f160b-f2f4-4ccc-84ad-583092741577) ![image](https://github.com/NEZNAMY/TAB/assets/6338394/f3cc3194-6dfc-4b15-8d46-52144a4a0352) ![image](https://github.com/NEZNAMY/TAB/assets/6338394/ffbf8384-fff5-4a32-8fc5-0768246e91c1) ![image](https://github.com/NEZNAMY/TAB/assets/6338394/99ae3191-7b35-4883-91a9-4edbb1e88ac9) ![image](https://github.com/NEZNAMY/TAB/assets/6338394/53ad76a7-f61c-4b4f-8411-32ad5c473c4d) | ![image](https://github.com/NEZNAMY/TAB/assets/6338394/e39f160b-f2f4-4ccc-84ad-583092741577) ![image](https://github.com/NEZNAMY/TAB/assets/6338394/f3cc3194-6dfc-4b15-8d46-52144a4a0352) |
+| Display any number                | ✔                                                                                                                                                                                                                                                                                                                                                                                                                                                                                | ✔                                                                                                                                                                                         |
+| Supports hearts display type      | ✔                                                                                                                                                                                                                                                                                                                                                                                                                                                                                | ✔                                                                                                                                                                                         |
+| 1.20.3+ NumberFormat support      | ✔                                                                                                                                                                                                                                                                                                                                                                                                                                                                                | ❌                                                                                                                                                                                         |
+| Conditionally disable the feature | When any specified condition is met                                                                                                                                                                                                                                                                                                                                                                                                                                              | Disable in worlds                                                                                                                                                                         |
+
+# Scoreboard
+| Attribute                             | [TAB](https://github.com/NEZNAMY/TAB)                                                                                                                                                                                                                                                                                                                                                                                                                                            | [RealScoreboard](https://github.com/joserodpt/RealScoreboard)                                    | [AnimatedScoreboard](https://www.spigotmc.org/resources/20848/)                                                                                                                             | [SternalBoard](https://github.com/ShieldCommunity/SternalBoard)                                                                                                                             | [KiteBoard](https://github.com/Niall7459/KiteBoard-Documentation)                                                                                                                           |
+|---------------------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
+| **Open issues**                       | ![Issues](https://img.shields.io/github/issues/NEZNAMY/TAB)                                                                                                                                                                                                                                                                                                                                                                                                                      | ![Issues](https://img.shields.io/github/issues/joserodpt/RealScoreboard)                         | -                                                                                                                                                                                           | ![Issues](https://img.shields.io/github/issues/ShieldCommunity/SternalBoard)                                                                                                                | ![Issues](https://img.shields.io/github/issues/Niall7459/KiteBoard-Documentation)                                                                                                           |
+| **Price**                             | ![image](https://github.com/NEZNAMY/TAB/assets/6338394/9bfa85bd-771c-4d78-ab15-be76665bd84a)                                                                                                                                                                                                                                                                                                                                                                                     | ![image](https://github.com/NEZNAMY/TAB/assets/6338394/9bfa85bd-771c-4d78-ab15-be76665bd84a)     | ![image](https://github.com/NEZNAMY/TAB/assets/6338394/9bfa85bd-771c-4d78-ab15-be76665bd84a)                                                                                                | ![image](https://github.com/NEZNAMY/TAB/assets/6338394/9bfa85bd-771c-4d78-ab15-be76665bd84a)                                                                                                | ![image](https://github.com/NEZNAMY/TAB/assets/6338394/1286a130-6173-4414-b5c6-43d79d75794d)                                                                                                |
+| **Minecraft**                         | 1.5+                                                                                                                                                                                                                                                                                                                                                                                                                                                                             | 1.13+                                                                                            | 1.8+                                                                                                                                                                                        | 1.7+                                                                                                                                                                                        | 1.8 - 1.20.1                                                                                                                                                                                |
+| **Platforms**                         | ![image](https://github.com/NEZNAMY/TAB/assets/6338394/e39f160b-f2f4-4ccc-84ad-583092741577) ![image](https://github.com/NEZNAMY/TAB/assets/6338394/f3cc3194-6dfc-4b15-8d46-52144a4a0352) ![image](https://github.com/NEZNAMY/TAB/assets/6338394/ffbf8384-fff5-4a32-8fc5-0768246e91c1) ![image](https://github.com/NEZNAMY/TAB/assets/6338394/99ae3191-7b35-4883-91a9-4edbb1e88ac9) ![image](https://github.com/NEZNAMY/TAB/assets/6338394/53ad76a7-f61c-4b4f-8411-32ad5c473c4d) | ![image](https://github.com/NEZNAMY/TAB/assets/6338394/e39f160b-f2f4-4ccc-84ad-583092741577)     | ![image](https://github.com/NEZNAMY/TAB/assets/6338394/e39f160b-f2f4-4ccc-84ad-583092741577)                                                                                                | ![image](https://github.com/NEZNAMY/TAB/assets/6338394/e39f160b-f2f4-4ccc-84ad-583092741577)                                                                                                | ![image](https://github.com/NEZNAMY/TAB/assets/6338394/e39f160b-f2f4-4ccc-84ad-583092741577)                                                                                                |
+| **Async**                             | ✔                                                                                                                                                                                                                                                                                                                                                                                                                                                                                | ✔                                                                                                | ✔                                                                                                                                                                                           | ✔                                                                                                                                                                                           | ✔                                                                                                                                                                                           |
+| Customizable toggle command           | ✔                                                                                                                                                                                                                                                                                                                                                                                                                                                                                | ❌                                                                                                | ❌                                                                                                                                                                                           | ❌                                                                                                                                                                                           | ❌                                                                                                                                                                                           |
+| 1.20.3+ NumberFormat support          | ✔                                                                                                                                                                                                                                                                                                                                                                                                                                                                                | ❌                                                                                                | ❌                                                                                                                                                                                           | ❌                                                                                                                                                                                           | ❌                                                                                                                                                                                           |
+| Max line length limit (<1.13 / 1.13+) | ![image](https://github.com/NEZNAMY/TAB/assets/6338394/b770a19b-9f1a-44c1-8164-394c788998b8) / ![image](https://github.com/NEZNAMY/TAB/assets/6338394/3c7c3e31-31e6-4bce-9453-b74b0cadd942)                                                                                                                                                                                                                                                                                      | - / ![image](https://github.com/NEZNAMY/TAB/assets/6338394/3c7c3e31-31e6-4bce-9453-b74b0cadd942) | ![image](https://github.com/NEZNAMY/TAB/assets/6338394/98d0f411-5b2c-4ab2-a167-8189d5c32a02) / ![image](https://github.com/NEZNAMY/TAB/assets/6338394/3c7c3e31-31e6-4bce-9453-b74b0cadd942) | ![image](https://github.com/NEZNAMY/TAB/assets/6338394/98d0f411-5b2c-4ab2-a167-8189d5c32a02) / ![image](https://github.com/NEZNAMY/TAB/assets/6338394/3c7c3e31-31e6-4bce-9453-b74b0cadd942) | ![image](https://github.com/NEZNAMY/TAB/assets/6338394/98d0f411-5b2c-4ab2-a167-8189d5c32a02) / ![image](https://github.com/NEZNAMY/TAB/assets/6338394/3c7c3e31-31e6-4bce-9453-b74b0cadd942) |
+
+| Attribute                             | [FeatherBoard](https://www.spigotmc.org/resources/featherboard.2691/)                                                                                                                                                                                                                    | [UltraScoreboards](https://www.spigotmc.org/resources/ultra-scoreboards.93726/)                                                                                                             | [QuickBoard](https://github.com/tadeas-drab/QuickBoard)                                                                                                                                     | [SimpleScore](https://github.com/r4g3baby/SimpleScore)                                                                                                                                      | [InfiniteScoreboard](https://www.spigotmc.org/resources/infinite-scoreboard.87425/)                                                                                                         |
+|---------------------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
+| **Open issues**                       | -                                                                                                                                                                                                                                                                                        | -                                                                                                                                                                                           | ![Issues](https://img.shields.io/github/issues/tadeas-drab/QuickBoard)                                                                                                                      | ![Issues](https://img.shields.io/github/issues/r4g3baby/SimpleScore)                                                                                                                        | -                                                                                                                                                                                           |
+| **Price**                             | ![image](https://github.com/NEZNAMY/TAB/assets/6338394/dd25c457-6b4e-4771-a366-3c5ec154f007)                                                                                                                                                                                             | ![image](https://github.com/NEZNAMY/TAB/assets/6338394/f2a536e5-4a56-4b5c-9e3d-a86d8761876e)                                                                                                | ![image](https://github.com/NEZNAMY/TAB/assets/6338394/9bfa85bd-771c-4d78-ab15-be76665bd84a)                                                                                                | ![image](https://github.com/NEZNAMY/TAB/assets/6338394/9bfa85bd-771c-4d78-ab15-be76665bd84a)                                                                                                | ![image](https://github.com/NEZNAMY/TAB/assets/6338394/9bfa85bd-771c-4d78-ab15-be76665bd84a)                                                                                                |
+| **Minecraft**                         | 1.7+                                                                                                                                                                                                                                                                                     | 1.8+                                                                                                                                                                                        | 1.8 - 1.16.1                                                                                                                                                                                | 1.8+                                                                                                                                                                                        | 1.8 - 1.19                                                                                                                                                                                  |
+| **Platforms**                         | ![image](https://github.com/NEZNAMY/TAB/assets/6338394/e39f160b-f2f4-4ccc-84ad-583092741577)                                                                                                                                                                                             | ![image](https://github.com/NEZNAMY/TAB/assets/6338394/e39f160b-f2f4-4ccc-84ad-583092741577) ![image](https://github.com/NEZNAMY/TAB/assets/6338394/99ae3191-7b35-4883-91a9-4edbb1e88ac9)   | ![image](https://github.com/NEZNAMY/TAB/assets/6338394/e39f160b-f2f4-4ccc-84ad-583092741577)                                                                                                | ![image](https://github.com/NEZNAMY/TAB/assets/6338394/e39f160b-f2f4-4ccc-84ad-583092741577)                                                                                                | ![image](https://github.com/NEZNAMY/TAB/assets/6338394/e39f160b-f2f4-4ccc-84ad-583092741577)                                                                                                |
+| **Async**                             | ✔                                                                                                                                                                                                                                                                                        | ❌                                                                                                                                                                                           | ❌                                                                                                                                                                                           | ❌                                                                                                                                                                                           | ✔                                                                                                                                                                                           |
+| Customizable toggle command           | ❌                                                                                                                                                                                                                                                                                        | ❌                                                                                                                                                                                           | ❌                                                                                                                                                                                           | ❌                                                                                                                                                                                           | ❌                                                                                                                                                                                           |
+| 1.20.3+ NumberFormat support          | ❌                                                                                                                                                                                                                                                                                        | ❌                                                                                                                                                                                           | ❌                                                                                                                                                                                           | ❌                                                                                                                                                                                           | ❌                                                                                                                                                                                           |
+| Max line length limit (<1.13 / 1.13+) | ![image](https://github.com/NEZNAMY/TAB/assets/6338394/09e5314f-ac46-40ec-b8c8-3ba54a5bf8fc)-![image](https://github.com/NEZNAMY/TAB/assets/6338394/b770a19b-9f1a-44c1-8164-394c788998b8) / ![image](https://github.com/NEZNAMY/TAB/assets/6338394/3c7c3e31-31e6-4bce-9453-b74b0cadd942) | ![image](https://github.com/NEZNAMY/TAB/assets/6338394/ed5c6f89-d700-41a2-b4dd-49ebc846d8c7) / ![image](https://github.com/NEZNAMY/TAB/assets/6338394/3c7c3e31-31e6-4bce-9453-b74b0cadd942) | ![image](https://github.com/NEZNAMY/TAB/assets/6338394/98d0f411-5b2c-4ab2-a167-8189d5c32a02) / ![image](https://github.com/NEZNAMY/TAB/assets/6338394/5db3ba81-3956-4b84-950f-6132d5a10c71) | ![image](https://github.com/NEZNAMY/TAB/assets/6338394/98d0f411-5b2c-4ab2-a167-8189d5c32a02) / ![image](https://github.com/NEZNAMY/TAB/assets/6338394/5db3ba81-3956-4b84-950f-6132d5a10c71) | ![image](https://github.com/NEZNAMY/TAB/assets/6338394/09e5314f-ac46-40ec-b8c8-3ba54a5bf8fc) / ![image](https://github.com/NEZNAMY/TAB/assets/6338394/5db3ba81-3956-4b84-950f-6132d5a10c71) |
+
+# Sorting
+| Attribute       | [TAB](https://github.com/NEZNAMY/TAB)                                                                                                                                                                                                                                                                                                                                                                                                                                            | [NametagEdit](https://github.com/sgtcaze/NametagEdit)                                        | [TabList](https://github.com/montlikadani/TabList)                                                                                                                                        | [Velocitab](https://github.com/WiIIiam278/Velocitab)                                         |
+|-----------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|----------------------------------------------------------------------------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|----------------------------------------------------------------------------------------------|
+| **Open issues** | ![Issues](https://img.shields.io/github/issues/NEZNAMY/TAB)                                                                                                                                                                                                                                                                                                                                                                                                                      | ![Issues](https://img.shields.io/github/issues/sgtcaze/NametagEdit)                          | ![Issues](https://img.shields.io/github/issues/montlikadani/TabList)                                                                                                                      | ![Issues](https://img.shields.io/github/issues/WiIIiam278/Velocitab)                         |
+| **Price**       | ![image](https://github.com/NEZNAMY/TAB/assets/6338394/9bfa85bd-771c-4d78-ab15-be76665bd84a)                                                                                                                                                                                                                                                                                                                                                                                     | ![image](https://github.com/NEZNAMY/TAB/assets/6338394/9bfa85bd-771c-4d78-ab15-be76665bd84a) | ![image](https://github.com/NEZNAMY/TAB/assets/6338394/9bfa85bd-771c-4d78-ab15-be76665bd84a)                                                                                              | ![image](https://github.com/NEZNAMY/TAB/assets/6338394/9bfa85bd-771c-4d78-ab15-be76665bd84a) |
+| **Minecraft**   | 1.8+                                                                                                                                                                                                                                                                                                                                                                                                                                                                             | 1.8+                                                                                         | 1.8+                                                                                                                                                                                      | 1.8+                                                                                         |
+| **Platforms**   | ![image](https://github.com/NEZNAMY/TAB/assets/6338394/e39f160b-f2f4-4ccc-84ad-583092741577) ![image](https://github.com/NEZNAMY/TAB/assets/6338394/f3cc3194-6dfc-4b15-8d46-52144a4a0352) ![image](https://github.com/NEZNAMY/TAB/assets/6338394/ffbf8384-fff5-4a32-8fc5-0768246e91c1) ![image](https://github.com/NEZNAMY/TAB/assets/6338394/99ae3191-7b35-4883-91a9-4edbb1e88ac9) ![image](https://github.com/NEZNAMY/TAB/assets/6338394/53ad76a7-f61c-4b4f-8411-32ad5c473c4d) | ![image](https://github.com/NEZNAMY/TAB/assets/6338394/e39f160b-f2f4-4ccc-84ad-583092741577) | ![image](https://github.com/NEZNAMY/TAB/assets/6338394/e39f160b-f2f4-4ccc-84ad-583092741577) ![image](https://github.com/NEZNAMY/TAB/assets/6338394/f3cc3194-6dfc-4b15-8d46-52144a4a0352) | ![image](https://github.com/NEZNAMY/TAB/assets/6338394/53ad76a7-f61c-4b4f-8411-32ad5c473c4d) |
+| **Async**       | ✔                                                                                                                                                                                                                                                                                                                                                                                                                                                                                | ❌                                                                                            | ✔                                                                                                                                                                                         | ✔                                                                                            |
+| Sorting options | Groups<br />Permissions<br />Placeholder alphabetically<br />Placeholder numerically<br />Pre-defined placeholder values                                                                                                                                                                                                                                                                                                                                                         | Groups                                                                                       | Groups                                                                                                                                                                                    | Placeholder alphabetically<br />Placeholder numerically                                      |
+
+# Tablist name formatting
+| Attribute       | [TAB](https://github.com/NEZNAMY/TAB)                                                                                                                                                                                                                                                                                                                                                                                                                                            | [TabList](https://github.com/montlikadani/TabList)                                                                                                                                                                                                                                     | [BungeeTabListPlus](https://github.com/CodeCrafter47/BungeeTabListPlus)                                                                                                                   | [SimpleTabList](https://github.com/TheYIMIR/SimpleTabList)                                   | [Velocitab](https://github.com/WiIIiam278/Velocitab)                                         |
+|-----------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|----------------------------------------------------------------------------------------------|----------------------------------------------------------------------------------------------|
+| **Open issues** | ![Issues](https://img.shields.io/github/issues/NEZNAMY/TAB)                                                                                                                                                                                                                                                                                                                                                                                                                      | ![Issues](https://img.shields.io/github/issues/montlikadani/TabList)                                                                                                                                                                                                                   | ![Issues](https://img.shields.io/github/issues/CodeCrafter47/BungeeTabListPlus)                                                                                                           | ![Issues](https://img.shields.io/github/issues/TheYIMIR/SimpleTabList)                       | ![Issues](https://img.shields.io/github/issues/WiIIiam278/Velocitab)                         |
+| **Price**       | ![image](https://github.com/NEZNAMY/TAB/assets/6338394/9bfa85bd-771c-4d78-ab15-be76665bd84a)                                                                                                                                                                                                                                                                                                                                                                                     | ![image](https://github.com/NEZNAMY/TAB/assets/6338394/9bfa85bd-771c-4d78-ab15-be76665bd84a)                                                                                                                                                                                           | ![image](https://github.com/NEZNAMY/TAB/assets/6338394/9bfa85bd-771c-4d78-ab15-be76665bd84a)                                                                                              | ![image](https://github.com/NEZNAMY/TAB/assets/6338394/9bfa85bd-771c-4d78-ab15-be76665bd84a) | ![image](https://github.com/NEZNAMY/TAB/assets/6338394/9bfa85bd-771c-4d78-ab15-be76665bd84a) |
+| **Minecraft**   | 1.8+                                                                                                                                                                                                                                                                                                                                                                                                                                                                             | 1.8+                                                                                                                                                                                                                                                                                   | 1.8+                                                                                                                                                                                      | 1.16+                                                                                        | 1.8+                                                                                         |
+| **Platforms**   | ![image](https://github.com/NEZNAMY/TAB/assets/6338394/e39f160b-f2f4-4ccc-84ad-583092741577) ![image](https://github.com/NEZNAMY/TAB/assets/6338394/f3cc3194-6dfc-4b15-8d46-52144a4a0352) ![image](https://github.com/NEZNAMY/TAB/assets/6338394/ffbf8384-fff5-4a32-8fc5-0768246e91c1) ![image](https://github.com/NEZNAMY/TAB/assets/6338394/99ae3191-7b35-4883-91a9-4edbb1e88ac9) ![image](https://github.com/NEZNAMY/TAB/assets/6338394/53ad76a7-f61c-4b4f-8411-32ad5c473c4d) | ![image](https://github.com/NEZNAMY/TAB/assets/6338394/e39f160b-f2f4-4ccc-84ad-583092741577) ![image](https://github.com/NEZNAMY/TAB/assets/6338394/f3cc3194-6dfc-4b15-8d46-52144a4a0352) ![image](https://github.com/NEZNAMY/TAB/assets/6338394/99ae3191-7b35-4883-91a9-4edbb1e88ac9) | ![image](https://github.com/NEZNAMY/TAB/assets/6338394/e39f160b-f2f4-4ccc-84ad-583092741577) ![image](https://github.com/NEZNAMY/TAB/assets/6338394/99ae3191-7b35-4883-91a9-4edbb1e88ac9) | ![image](https://github.com/NEZNAMY/TAB/assets/6338394/e39f160b-f2f4-4ccc-84ad-583092741577) | ![image](https://github.com/NEZNAMY/TAB/assets/6338394/53ad76a7-f61c-4b4f-8411-32ad5c473c4d) |
+| **Async**       | ✔                                                                                                                                                                                                                                                                                                                                                                                                                                                                                | ✔                                                                                                                                                                                                                                                                                      | ✔                                                                                                                                                                                         | ❌                                                                                            | ✔                                                                                            |
@@ -0,0 +1,48 @@
+## Easy to install
+Support for all possible Minecraft versions containing features the plugin is able to take advantage of.
+Support for multiple platforms (Bukkit, BungeeCord, Velocity, Fabric, Sponge),
+with everything contained in a single jar which you can download directly.
+No need to browse version history, ask what plugin version you need for your server version,
+visit random websites looking for the download button, or anything similar.
+The same jar supports all versions & platforms, and the latest plugin version will always work for you.
+
+## It works
+The plugin doesn't spam your console with errors, doesn't have compatibility issues with half of the plugins,
+and doesn't just decide to randomly stop working for no reason.
+It just works.
+Bug reports are fixed with the highest priority and preferred over adding new features.
+It's not unusual for a plugin of this size to have a 3-digit open issue count on GitHub.
+Meanwhile, TAB is always at 1-digit count.
+
+## Feature packed
+All the most requested features in a single plugin.
+No need to install many plugins, disable features, so they don't conflict with each other,
+or be forced to run your server on a version that all the plugins support in common.
+All features, all server versions in a single plugin.
+
+## Beyond the limits
+Mojang decided to put some kind of limitation on almost every feature TAB offers. Other developers simply say "Mojang limit, nothing we can do about it, goodbye". This is not the case here. With every limitation I find, I look for ways to bypass it, and I've found most of them. These bypasses require a ton of work involved, and it's much easier to say "not possible" than actually doing it.
+
+## Up to date
+The plugin is not abandoned.
+It is constantly getting updated to fix reported bugs,
+add support for new MC versions as they come out and get new optimizations.
+All that can help it run as smoothly as possible, whilst still working the way you want it to.
+
+## High performance
+Unlike with other plugins where "high performance"
+often means your CPU usage will be high, TAB has a very low CPU footprint.
+There is a [command](https://github.com/NEZNAMY/TAB/wiki/Commands-&-Permissions#tab-cpu) available
+that shows the entire plugin's CPU usage.
+Here you can see which part of TAB is occupying the most of your CPU.
+There are [many ways to optimize TAB](https://github.com/NEZNAMY/TAB/wiki/Optimizing-the-plugin)
+to get the most out of it,
+the most common being increasing refresh rates for individual placeholders if they're inefficient.
+This is done on a per-placeholder basis,
+instead of slowing down the refresh rate of an entire feature, which may break animations.
+Performance is also actively monitored on large servers, and observations show that it performs very well,
+meaning it will almost certainly perform even better on smaller servers.
+
+## Simple yet powerful configuration
+Compared to other plugins, each feature is easier to configure and actually offers more.  
+Want a simple result with simple configuration? No problem. Want a complicated result? No problem.  
@@ -0,0 +1,41 @@
+name: Build
+on:
+  push:
+    branches:
+      - master
+jobs:
+  build:
+    name: Build
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4 # https://github.com/actions/checkout/releases
+        with:
+          fetch-depth: 0 # Shallow clones should be disabled for a better relevancy of analysis
+      - name: Set up JDK 21
+        uses: actions/setup-java@v4 # https://github.com/actions/setup-java/releases
+        with:
+          distribution: 'temurin'
+          java-version: 21
+      - name: Cache Gradle
+        uses: actions/cache@v4.2.0 # https://github.com/actions/cache/releases
+        with:
+          path: |
+            ~/.gradle/caches
+            ~/.gradle/wrapper
+          key: ${{ runner.os }}-gradle-${{ hashFiles('**/*.gradle*', '**/gradle-wrapper.properties') }}
+          restore-keys: |
+            ${{ runner.os }}-gradle-
+      - name: Build and analyze
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} # Needed to get PR information, if any
+        run: ./gradlew clean build
+      - name: Rename JAR with Build Number
+        run: |
+          original_jar=$(find jar/build/libs -type f -name "TAB-*.jar")
+          new_name=$(echo "$original_jar" | sed "s/TAB-\(.*\)\.jar/TAB-\1+${{ github.run_number }}.jar/")
+          mv "$original_jar" "$new_name"
+      - name: Upload a Build Artifact
+        uses: actions/upload-artifact@v4.3.3 # https://github.com/actions/upload-artifact/releases
+        with:
+          name: Click here to download
+          path: jar/build/libs/TAB-*+${{ github.run_number }}.jar
@@ -33,5 +33,10 @@ hs_err_pid*
 .idea/

 # other
-.gitattributes
 *.iml
+run/
+
+# Gradle
+.gradle/
+build/
+!gradle/wrapper/gradle-wrapper.jar
@@ -0,0 +1,9 @@
+If this plugin has helped you in any way, and you would like to return something back 
+to make the plugin even better, there is a lot of ways to contribute:  
+* Open a **pull request** containing a new feature or a bug fix, which you believe many users will benefit from.
+* Make detailed high-quality **bug reports**. The difference between a bug getting fixed in 1 week vs 1 hour 
+is in quality of the report (typically providing correct steps to reproduce that actually work).
+* Test **experimental builds**, which can be found in [GitHub Actions](https://github.com/NEZNAMY/TAB/actions) for problems of any kind including bugs. 
+This way you will help make the actual releases more stable / help get stable releases sooner.
+* Help improve the wiki by opening a [Wiki change issue](https://github.com/NEZNAMY/TAB/issues/new?assignees=&labels=Wiki&template=wiki_change.yml), 
+where you can improve existing descriptions, add information you found missing, fix typos / grammar mistakes or add more examples.
@@ -1,4 +1,4 @@
-Apache License
+                                 Apache License
                           Version 2.0, January 2004
                        http://www.apache.org/licenses/

@@ -172,30 +172,3 @@ Apache License
      defend, and hold each Contributor harmless for any liability
      incurred by, or claims asserted against, such Contributor by reason
      of your accepting any such warranty or additional liability.
-
-   END OF TERMS AND CONDITIONS
-
-   APPENDIX: How to apply the Apache License to your work.
-
-      To apply the Apache License to your work, attach the following
-      boilerplate notice, with the fields enclosed by brackets "[]"
-      replaced with your own identifying information. (Don't include
-      the brackets!)  The text should be enclosed in the appropriate
-      comment syntax for the file format. We also recommend that a
-      file or class name and description of purpose be included on the
-      same "printed page" as the copyright notice for easier
-      identification within third-party archives.
-
-   Copyright [yyyy] [name of copyright owner]
-
-   Licensed under the Apache License, Version 2.0 (the "License");
-   you may not use this file except in compliance with the License.
-   You may obtain a copy of the License at
-
-       http://www.apache.org/licenses/LICENSE-2.0
-
-   Unless required by applicable law or agreed to in writing, software
-   distributed under the License is distributed on an "AS IS" BASIS,
-   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-   See the License for the specific language governing permissions and
-   limitations under the License.
@@ -1,46 +1,55 @@
-## Introduction  
-Here it is. After countless requests to go opensource, I did it to make those people quiet. It worked.  
-It's already been a year and I still can't see any positives of it. This way I just made it easier for everyone to make a plugin as good, so people can stop using it and switch to something better. Or just get premium version for free.  
-  
-  
-## Compiling
-Plugin can be compiled using maven. Once you've purchased the premium version, you can enable premium features by setting [this line to return true](https://github.com/NEZNAMY/TAB/blob/master/shared/src/main/java/me/neznamy/tab/shared/TAB.java#L78) and apply your code improvements. Enabling it without purchasing the plugin may result in the features not working correctly.  
-**No support is provided for self-compiled jars, only for official compilations.** If you compiled it yourself, it is highly likely you modified something, which might be the reason why is the plugin not working. If you didn't modify anything, you can just get the plugin from official download places.
-  
-  
-## Links
-Free version  
-    Spigot (releases): https://www.spigotmc.org/resources/57806/  
-    Pre-releases https://github.com/NEZNAMY/TAB/releases  
-Premium version  
-    Polymart (releases): https://polymart.org/resource/484  
-    MC-Market (releases): https://www.mc-market.org/resources/14009/  
-    Pre-releases on discord for verified buyers  
-Bukkit bridge https://www.spigotmc.org/resources/83966/  
-Wiki https://github.com/NEZNAMY/TAB/wiki  
-Discord invite link: https://discord.gg/EaSvdk6  
-  
-  
-## Downloads
-Official release: https://www.spigotmc.org/resources/57806/  
-Pre-releases: https://github.com/NEZNAMY/TAB/releases  
-  
-  
-## Maven Repository
-```
-<repositories>
-  <repository>
-    <id>jitpack.io</id>
-    <url>https://jitpack.io</url>
-  </repository>
-</repositories>
+# About
+TAB aims to be a superior all-in-one minecraft plugin for displaying information that outperforms all 
+similar plugins in terms of features, performance and compatibility.  
+More information can be found at [Why TAB?](https://github.com/NEZNAMY/TAB/wiki/Why-TAB%3F) wiki page.

-<dependencies>
-  <!-- TAB -->
-  <dependency>
-    <groupId>com.github.NEZNAMY</groupId>
-    <artifactId>TAB-API</artifactId>
-    <version>2.8.10</version>
-  </dependency>
-</dependencies>
- ```
+# Download
+### Releases
+You can download full releases from [GitHub releases](https://github.com/NEZNAMY/TAB/releases), 
+[SpigotMC](https://www.spigotmc.org/resources/57806/), [Modrinth](https://modrinth.com/plugin/tab-was-taken) or [BuiltByBit](https://builtbybit.com/resources/20631).
+
+### Dev builds
+Plugin's development is continuous and contains lots of small changes/fixes not worthy of being called a full
+update, therefore development builds are being created and eventually a full update is released when enough changes are made.  
+If you want to benefit from a recent change in the code before official release, you can download development builds
+from [GitHub actions](https://github.com/NEZNAMY/TAB/actions) (you must be logged into GitHub to be able to download it).  
+
+# Compiling
+Compilation requires JDK 21 and up.  
+To compile the plugin, run `./gradlew build` from the terminal.  
+Once the plugin compiles, grab the jar from `/jar/build/libs/` folder.  
+The universal jar contains all modules for all supported platforms.
+
+# Documentation
+You can find everything about the plugin on the [Wiki](https://github.com/NEZNAMY/TAB/wiki). This includes a detailed description
+of all features, as well as information regarding compatibility or limitations of each feature.  
+
+# Issues
+The [Issues](https://github.com/NEZNAMY/TAB/issues) section is an issue tracker for all the kind of problems covered in issue templates.
+Please refrain from attempting to use it to receive help with your server, such issues will be closed immediately.  
+When opening an issue, provide as much information as possible. The difference between a bug getting fixed in 1 week vs 1 hour
+is in quality of the report. Bug reports where steps to reproduce are "idk" have no value and will not help to get the bug fixed at all.  
+
+# Contributing
+See [CONTRIBUTING.md](https://github.com/NEZNAMY/TAB/blob/master/CONTRIBUTING.md)
+
+# Provided services
+The plugin is being used by a large amount of servers, which also means the demand for my attention is high. Unfortunately, 
+I am no longer able to keep up with the demand since I don't want to dedicate my whole existence to a free plugin. 
+In order to provide the best quality of all provided services, the amount of services provided may vary over time. 
+Here is the full list of potential services and their status:
+
+| Service type                  | Availability |
+|-------------------------------|--------------|
+| Updates for new MC versions   | ✔            |
+| Bug fixes                     | ✔            |
+| Wiki improvements             | ✔            |
+| Performance optimizations     | ✔            |
+| Feature requests              | ❌            |
+| Customer support<sup>1</sup>  | ✔            |
+| Free user support<sup>2</sup> | ❌*           |
+
+<sup>1</sup> - Unrestricted assistance with the plugin for those, who bought a copy of the plugin when it was purchasable.  
+<sup>2</sup> - Unlimited access to my free time for everyone in the world.  
+  
+*Instead, you can use [this fresh new community discord](https://discord.gg/YPqXt63YQj) made by a nice person who will provide this service.  
@@ -0,0 +1,2 @@
+# Security Policy
+If you found a security issue, send me a private message anywhere.
@@ -0,0 +1,7 @@
+dependencies {
+    compileOnlyApi("org.jetbrains:annotations:24.1.0")
+}
+
+tasks.javadoc {
+    enabled = project.hasProperty("enable-javadoc")
+}
@@ -0,0 +1,135 @@
+package me.neznamy.tab.api;
+
+import java.util.UUID;
+
+import lombok.NonNull;
+import lombok.Setter;
+import me.neznamy.tab.api.bossbar.BossBarManager;
+import me.neznamy.tab.api.event.EventBus;
+import me.neznamy.tab.api.placeholder.PlaceholderManager;
+import me.neznamy.tab.api.scoreboard.ScoreboardManager;
+import me.neznamy.tab.api.tablist.SortingManager;
+import me.neznamy.tab.api.tablist.HeaderFooterManager;
+import me.neznamy.tab.api.tablist.TabListFormatManager;
+import me.neznamy.tab.api.nametag.NameTagManager;
+import me.neznamy.tab.api.tablist.layout.LayoutManager;
+import org.jetbrains.annotations.NotNull;
+import org.jetbrains.annotations.Nullable;
+
+/**
+ * The primary API class to get instances of other API classes
+ */
+public abstract class TabAPI {
+
+    /** Instance of the API */
+    @Setter private static TabAPI instance;
+
+    /**
+     * Returns API instance. If instance was not set by the plugin, throws
+     * {@code IllegalStateException}. This is usually caused by shading the API
+     * into own project, which is not allowed. Another option is calling the method
+     * before plugin was able to load.
+     *
+     * @return  API instance
+     * @throws  IllegalStateException
+     *          If instance is {@code null}
+     */
+    public static @NotNull TabAPI getInstance() {
+        if (instance == null) throw new IllegalStateException("The API instance is null. This can have 2 possible causes: \n" +
+                "#1 - API was called before TAB was loaded. This means your plugin was loaded before TAB was. To make sure your " +
+                "plugin loads after TAB, add it as a depend or soft depend of your plugin.\n" +
+                "#2 - You shaded TAB's classes into your plugin, instead of only using them. This is not allowed. To verify this " +
+                "is your case, unzip your plugin and check for TAB's classes. If they are there, you will need to fix your compiler " +
+                "to not include them, such as scope provided for maven compilation.");
+        return instance;
+    }
+
+    /**
+     * Returns player object from given UUID
+     *
+     * @param   id
+     *          Player UUID
+     * @return  player object from given UUID
+     */
+    public abstract @Nullable TabPlayer getPlayer(@NonNull UUID id);
+
+    /**
+     * Returns player object from given name
+     *
+     * @param   name
+     *          Player name
+     * @return  player object from given name
+     */
+    public abstract @Nullable TabPlayer getPlayer(@NonNull String name);
+
+    /**
+     * Returns collection of all online players. Will return empty list if plugin is disabled (due to a broken configuration file for example).
+     *
+     * @return  collection of online players
+     */
+    public abstract @NotNull TabPlayer[] getOnlinePlayers();
+
+    /**
+     * Return BossBar manager instance if the feature is enabled. If not, returns {@code null}.
+     *
+     * @return  BossBar manager
+     */
+    public abstract @Nullable BossBarManager getBossBarManager();
+
+    /**
+     * Returns scoreboard manager instance if the feature is enabled. If not, returns {@code null}.
+     *
+     * @return  scoreboard manager
+     */
+    public abstract @Nullable ScoreboardManager getScoreboardManager();
+
+    /**
+     * Returns team manager instance if the feature is enabled. If not, returns {@code null}.
+     *
+     * @return  team manager
+     */
+    public abstract @Nullable NameTagManager getNameTagManager();
+
+    /**
+     * Returns header/footer manager instance if the feature is enabled. If not, returns {@code null}.
+     *
+     * @return  Header/footer manager
+     */
+    public abstract @Nullable HeaderFooterManager getHeaderFooterManager();
+
+    /**
+     * Returns PlaceholderManager instance
+     *
+     * @return  PlaceholderManager instance
+     */
+    public abstract @NotNull PlaceholderManager getPlaceholderManager();
+
+    /**
+     * Returns TabList name format manager instance if the feature is enabled. If not, returns {@code null}.
+     *
+     * @return  TabList name format manager
+     */
+    public abstract @Nullable TabListFormatManager getTabListFormatManager();
+
+    /**
+     * Returns Layout manager instance if the feature is enabled. If not, returns {@code null}.
+     *
+     * @return  Layout manager
+     */
+    public abstract @Nullable LayoutManager getLayoutManager();
+
+    /**
+     * Returns Sorting manager instance if at least one feature capable of sorting players is enabled.
+     * If not, returns {@code null}.
+     *
+     * @return  Sorting manager
+     */
+    public abstract @Nullable SortingManager getSortingManager();
+
+    /**
+     * Gets the event bus for registering listeners for TAB events.
+     *
+     * @return  the event bus
+     */
+    public abstract @Nullable EventBus getEventBus();
+}
@@ -0,0 +1,126 @@
+package me.neznamy.tab.api;
+
+import lombok.NonNull;
+import org.jetbrains.annotations.NotNull;
+import org.jetbrains.annotations.Nullable;
+
+import java.util.UUID;
+
+/**
+ * An interface representing a player
+ */
+@SuppressWarnings("unused") // API class
+public interface TabPlayer {
+
+    /**
+     * Returns player's name
+     *
+     * @return  Player's name
+     */
+    @NotNull
+    String getName();
+
+    /**
+     * Returns player's UUID
+     *
+     * @return  Player's UUID
+     */
+    @NotNull
+    UUID getUniqueId();
+
+    /**
+     * Returns platform-specific entity
+     *
+     * @return  platform's player object
+     */
+    @NotNull
+    Object getPlayer();
+
+    /**
+     * Returns true once the player is successfully loaded (onJoin method ran through all methods)
+     *
+     * @return  {@code true} if player is fully loaded, {@code false} otherwise
+     */
+    boolean isLoaded();
+
+    /**
+     * Returns player's primary permission group. If group has been changed using
+     * {@link #setTemporaryGroup(String)}, returns that value. Otherwise, returns group
+     * detected by standard group assign logic
+     *
+     * @return  player's primary permission group
+     */
+    @NotNull
+    String getGroup();
+
+    /**
+     * Temporarily overrides player's group and applies all changes coming from new group.
+     * This includes all properties and sorting, if used.
+     * Set to {@code null} to reset back.
+     *
+     * @param   group
+     *          New group to use
+     * @see     #hasTemporaryGroup()
+     */
+    void setTemporaryGroup(@Nullable String group);
+
+    /**
+     * Returns {@code true} if a temporary group was applied to the player using {@link #setTemporaryGroup(String)}.
+     * If no group was set, returns {@code false}
+     *
+     * @return  {@code true} if group is set, {@code false} if not
+     * @see     #setTemporaryGroup(String)
+     */
+    boolean hasTemporaryGroup();
+
+    /**
+     * Changes expected profile name of the player. This adapts all name-bound features
+     * to use this new profile name if another plugin changed profile name of the player. <p>
+     * Automatic profile name change detection is available on Bukkit, BungeeCord and Fabric,
+     * therefore using this is redundant there. This function is only needed on Sponge and Velocity,
+     * where the detection is not available. <p>
+     * Warning: This function does NOT change player's profile name, it only updates the tracked
+     * name inside the plugin.
+     *
+     * @param   profileName
+     *          New expected profile name
+     */
+    void setExpectedProfileName(@NonNull String profileName);
+
+    /**
+     * Returns player's expected profile name. This defaults to player's username, but may
+     * get changed by other plugins and then detected by TAB.
+     *
+     * @return  Player's expected profile name
+     */
+    @NotNull
+    String getExpectedProfileName();
+
+
+    /**
+     * Returns name of the server the player is connected to.
+     * This requires TAB on proxy.
+     * On backend installation, this method returns {@code "N/A"}.
+     *
+     * @return  Player's server on proxy or {@code "N/A"} on backend installation
+     */
+    @NotNull
+    String getServer();
+
+    /**
+     * Returns name of the world the player is in.
+     * On proxy installation, TAB-Bridge must be installed to forward this info to the proxy.
+     * Otherwise, it will return {@code "N/A"}.
+     *
+     * @return  Player's world or {@code "N/A"} on proxy installation without TAB-Bridge installed
+     */
+    @NotNull
+    String getWorld();
+
+    /**
+     * Returns {@code true} if this player is a bedrock player, {@code false} if not.
+     *
+     * @return  {@code true} if this player is a bedrock player, {@code false} if not
+     */
+    boolean isBedrockPlayer();
+}
@@ -0,0 +1,30 @@
+package me.neznamy.tab.api.bossbar;
+
+/**
+ * An enum representing all available BossBar colors.
+ * Calling ordinal() will return color's network ID.
+ */
+@SuppressWarnings("unused") // API class
+public enum BarColor {
+
+    /** Pink color */
+    PINK,
+
+    /** Blue color */
+    BLUE,
+
+    /** Red color */
+    RED,
+
+    /** Green color */
+    GREEN,
+
+    /** Yellow color */
+    YELLOW,
+
+    /** Purple color */
+    PURPLE,
+
+    /** White color */
+    WHITE
+}
@@ -0,0 +1,24 @@
+package me.neznamy.tab.api.bossbar;
+
+/**
+ * An enum representing all available BossBar styles.
+ * Calling ordinal() will return style's network ID.
+ */
+@SuppressWarnings("unused") // API class
+public enum BarStyle {
+
+    /** Fully solid line */
+    PROGRESS,
+
+    /** Line segmented into 6 parts */
+    NOTCHED_6,
+
+    /** Line segmented into 10 parts */
+    NOTCHED_10,
+
+    /** Line segmented into 12 parts */
+    NOTCHED_12,
+
+    /** Line segmented into 20 parts */
+    NOTCHED_20
+}
@@ -0,0 +1,213 @@
+package me.neznamy.tab.api.bossbar;
+
+import java.util.List;
+import java.util.UUID;
+
+import lombok.NonNull;
+import me.neznamy.tab.api.TabPlayer;
+import org.jetbrains.annotations.NotNull;
+
+/**
+ * An interface representing a BossBar line.
+ * <p>
+ * It uses 1.9+ BossBar feature, allowing configurable styles
+ * and colors, as well as display several bars at once. Limit of maximum 
+ * displayed BossBars depends on client resolution and GUI scale, up to
+ * 9 concurrent BossBars displayed at once.
+ */
+public interface BossBar {
+
+    /**
+     * Returns name of this BossBar. If it was defined in config, returns
+     * the name specified in config. If it was made using the API, returns
+     * randomly generated ID given to this BossBar when creating.
+     *
+     * @return  name of BossBar
+     */
+    @NotNull String getName();
+
+    /**
+     * Returns randomly generated uuid of this BossBar used internally to match
+     * the BossBar in client with packets or with Bukkit API BossBar instances.
+     *
+     * @return  uuid of this BossBar
+     */
+    @NotNull UUID getUniqueId();
+
+    /**
+     * Changes BossBar title to specified string, supporting placeholders.
+     * <p>
+     * If title contains new placeholders not used before, they are registered using
+     * standard registration logic and refreshed periodically. No need to call
+     * this method to try to keep placeholder values up to date.
+     * <p>
+     * If specified title is equal to the current one, nothing happens.
+     *
+     * @param   title
+     *          New title to display in this BossBar
+     */
+    void setTitle(@NonNull String title);
+
+    /**
+     * Changes BossBar progress to specified string, supporting placeholders.
+     * The string must be a string version of a float value, or a placeholder that
+     * outputs a float value with range 0-100.
+     * <p>
+     * If progress contains new placeholders not used before, they are registered using
+     * standard registration logic and refreshed periodically. No need to call
+     * this method to try to keep placeholder values up to date.
+     * <p>
+     * If specified progress is equal to the current one, nothing happens.
+     *
+     * @param   progress
+     *          New progress to use in this BossBar
+     */
+    void setProgress(@NonNull String progress);
+
+    /**
+     * Changes BossBar progress to specified value ranging from 0 to 100.
+     * <p>
+     * If specified progress is equal to the current one, nothing happens.
+     *
+     * @param   progress
+     *          New progress to use in this BossBar
+     */
+    void setProgress(float progress);
+
+    /**
+     * Changes BossBar color to specified string, supporting placeholders.
+     * The string must be a string version of one of the supported values,
+     * or a placeholder that outputs one of them.
+     * <p>
+     * If color contains new placeholders not used before, they are registered using
+     * standard registration logic and refreshed periodically. No need to call
+     * this method to try to keep placeholder values up to date.
+     * <p>
+     * If specified color is equal to the current one, nothing happens.
+     *
+     * @param   color
+     *          New color to use in this BossBar
+     */
+    void setColor(@NonNull String color);
+
+    /**
+     * Changes BossBar color to specified enum constant.
+     * <p>
+     * If specified color is equal to the current one, nothing happens.
+     *
+     * @param   color
+     *          New color to use in this BossBar
+     */
+    void setColor(@NonNull BarColor color);
+
+    /**
+     * Changes BossBar style to specified string, supporting placeholders.
+     * The string must be a string version of one of the supported values,
+     * or a placeholder that outputs one of them.
+     * <p>
+     * If style contains new placeholders not used before, they are registered using
+     * standard registration logic and refreshed periodically. No need to call
+     * this method to try to keep placeholder values up to date.
+     * <p>
+     * If specified style is equal to the current one, nothing happens.
+     *
+     * @param   style
+     *          New style to use in this BossBar
+     */
+    void setStyle(@NonNull String style);
+
+    /**
+     * Changes BossBar style to specified enum constant.
+     * <p>
+     * If specified style is equal to the current one, nothing happens.
+     *
+     * @param   style
+     *          New style to use in this BossBar
+     */
+    void setStyle(@NonNull BarStyle style);
+
+    /**
+     * Returns current title of the BossBar in raw format. If it contains placeholders,
+     * their raw identifiers are used in the result.
+     *
+     * @return  title of the BossBar
+     */
+    @NotNull String getTitle();
+
+    /**
+     * Returns progress of the BossBar as a string, which is either entered string
+     * containing placeholders or entered number converted to string
+     *
+     * @return  entered progress as a string
+     */
+    @NotNull String getProgress();
+
+    /**
+     * Returns color of the BossBar as a string, which is either entered string
+     * containing placeholders or entered enum value converted to string
+     *
+     * @return  entered color as a string
+     */
+    @NotNull String getColor();
+
+    /**
+     * Returns style of the BossBar as a string, which is either entered string
+     * containing placeholders or entered enum value converted to string
+     *
+     * @return  entered style as a string
+     */
+    @NotNull String getStyle();
+
+    /**
+     * Registers this BossBar to specified player.
+     * <p>
+     * If the player already sees this BossBar, nothing happens.
+     *
+     * @param   player
+     *          Player to register this BossBar to
+     */
+    void addPlayer(@NonNull TabPlayer player);
+
+    /**
+     * Unregisters this BossBar from specified player.
+     * <p>
+     * If the player does not see this BossBar, nothing happens.
+     *
+     * @param   player
+     *          Player to unregister this BossBar from
+     */
+    void removePlayer(@NonNull TabPlayer player);
+
+    /**
+     * Returns list of players who can see this BossBar.
+     * <p>
+     * The returned list can only be used to read. Writing
+     * will not work properly. For adding/removing players see {@link #addPlayer(TabPlayer)}
+     * and {@link #removePlayer(TabPlayer)}.
+     *
+     * @return  List of players seeing this BossBar
+     */
+    @NotNull List<TabPlayer> getPlayers();
+
+    /**
+     * Returns {@code true} if this bossbar is visible to specified player based on
+     * display condition or adding via {@link #addPlayer(TabPlayer)}, {@code false} if not.
+     * <p>
+     * This may return {@code true} even if player cannot physically see the bossbar due to
+     * having it disabled via toggle command or {@link BossBarManager#toggleBossBar(TabPlayer, boolean)}
+     * (or {@link BossBarManager#setBossBarVisible(TabPlayer, boolean, boolean)}).
+     *
+     * @param   player
+     *          Player to check
+     * @return  {@code true} if player is allowed to see this Boss Bar, {@code false} if not.
+     */
+    boolean containsPlayer(@NonNull TabPlayer player);
+
+    /**
+     * Returns {@code true} if this boss bar is configured as announcement-only bar,
+     * {@code false} if not.
+     *
+     * @return  {@code true} if bar is announcement only, {@code false} if not
+     */
+    boolean isAnnouncementBar();
+}
@@ -0,0 +1,157 @@
+package me.neznamy.tab.api.bossbar;
+
+import java.util.List;
+import java.util.Map;
+
+import lombok.NonNull;
+import me.neznamy.tab.api.TabAPI;
+import me.neznamy.tab.api.TabPlayer;
+import org.jetbrains.annotations.NotNull;
+import org.jetbrains.annotations.Nullable;
+
+/**
+ * An interface allowing work with BossBars such as creating, sending
+ * and toggling.
+ * <p>
+ * Instance can be obtained using {@link TabAPI#getBossBarManager()}.
+ * This requires the BossBar feature to be enabled in config, otherwise the method will
+ * return {@code null}.
+ */
+@SuppressWarnings("unused") // API class
+public interface BossBarManager {
+
+    /**
+     * Creates BossBar with specified parameters and registers it to BossBar manager,
+     * allowing to retrieve it later.
+     * 
+     * @param   title
+     *          Title to display, supports placeholders
+     * @param   progress
+     *          Progress to use. Must be between 0 and 100
+     * @param   color
+     *          Color to use
+     * @param   style
+     *          Style to use
+     * @return  The newly created BossBar
+     */
+    @NotNull BossBar createBossBar(@NonNull String title, float progress, @NonNull BarColor color, @NonNull BarStyle style);
+
+    /**
+     * Creates BossBar with specified parameters and registers it to BossBar manager,
+     * allowing to retrieve it later.
+     * 
+     * @param   title
+     *          Title to display, supports placeholders
+     * @param   progress
+     *          Progress to use. Must be a string version of a number, or
+     *          a placeholder that returns a number
+     * @param   color
+     *          Color to use. Must be a string version of one of enum constants, or
+     *          a placeholder that returns one of them
+     * @param   style
+     *          Style to use. Must be a string version of one of enum constants, or
+     *          a placeholder that returns one of them
+     * @return  The newly created BossBar
+     */
+    @NotNull BossBar createBossBar(@NonNull String title, @NonNull String progress, @NonNull String color, @NonNull String style);
+
+    /**
+     * Returns registered BossBar with given name. For BossBars from config it is the name
+     * they were created with, for API BossBars their randomly generated name, which can be
+     * retrieved using {@link me.neznamy.tab.api.bossbar.BossBar#getName()}.
+     * Returns {@code null} if no such BossBar exists.
+     * 
+     * @param   name
+     *          Name of registered BossBar
+     * @return  BossBar with specified name
+     */
+    @Nullable BossBar getBossBar(@NonNull String name);
+
+    /**
+     * Returns a map of all registered BossBars. This includes both BossBars from config
+     * and those registered via API.
+     * <p>
+     * Map key is BossBar's name available in {@link me.neznamy.tab.api.bossbar.BossBar#getName()},
+     * map value is the BossBar interface.
+     *
+     * @return  all registered BossBars
+     */
+    @NotNull Map<String, BossBar> getRegisteredBossBars();
+
+    /**
+     * Toggles BossBar for this player and sends toggle message if {@code sendToggleMessage} is true.
+     * 
+     * @param   player
+     *          Player to toggle BossBar for
+     * @param   sendToggleMessage
+     *          {@code true} if toggle message should be sent, {@code false} if not
+     * @see     #hasBossBarVisible(TabPlayer)
+     * @see     #setBossBarVisible(TabPlayer, boolean, boolean)
+     */
+    void toggleBossBar(@NonNull TabPlayer player, boolean sendToggleMessage);
+
+    /**
+     * Returns true if player can see BossBars, false if toggled via command or API.
+     * 
+     * @param   player
+     *          Player to check toggle status of
+     * @return  {@code true} if visible, {@code false} if disabled (toggled)
+     * @see     #toggleBossBar(TabPlayer, boolean)
+     * @see     #setBossBarVisible(TabPlayer, boolean, boolean)
+     */
+    boolean hasBossBarVisible(@NonNull TabPlayer player);
+
+    /**
+     * Sets BossBar visibility of player to set value. If value did not change, nothing happens.
+     * If visibility changed, toggle message is sent if {@code sendToggleMessage} is {@code true}.
+     * 
+     * @param   player
+     *          Player to set BossBar visibility of
+     * @param   visible
+     *          {@code true} if BossBar should be visible, {@code false} if not
+     * @param   sendToggleMessage
+     *          {@code true} if toggle message should be sent if value changed, {@code false} if not
+     * @see #toggleBossBar(TabPlayer, boolean)
+     * @see #hasBossBarVisible(TabPlayer)
+     */
+    void setBossBarVisible(@NonNull TabPlayer player, boolean visible, boolean sendToggleMessage);
+
+    /**
+     * Temporarily displays registered BossBar to player for specified amount of time in seconds.
+     *
+     * @param   player
+     *          Player to show BossBar to
+     * @param   bossBar
+     *          Name of registered BossBar to show
+     * @param   duration
+     *          In seconds for how long should BossBar be displayed
+     * @throws  IllegalArgumentException
+     *          if no BossBar with specified name exists
+     * @see     #announceBossBar(String, int)
+     * @see     #getAnnouncedBossBars()
+     */
+    void sendBossBarTemporarily(@NonNull TabPlayer player, @NonNull String bossBar, int duration);
+
+    /**
+     * Temporarily displays registered BossBar to all players for specified amount of time in seconds.
+     *
+     * @param   bossBar
+     *          Name of registered BossBar to show
+     * @param   duration
+     *          In seconds for how long should BossBar be displayed
+     * @throws  IllegalArgumentException
+     *          if no BossBar with specified name exists
+     * @see     #sendBossBarTemporarily(TabPlayer, String, int)
+     * @see     #getAnnouncedBossBars()
+     */
+    void announceBossBar(@NonNull String bossBar, int duration);
+
+    /**
+     * Returns list of BossBars which are currently being announced.
+     *
+     * @return  list of currently active BossBar announcements
+     * @see     #sendBossBarTemporarily(TabPlayer, String, int)
+     * @see     #announceBossBar(String, int)
+     */
+    @NotNull List<BossBar> getAnnouncedBossBars();
+}
@@ -0,0 +1,56 @@
+package me.neznamy.tab.api.event;
+
+import lombok.NonNull;
+
+/**
+ * The event bus. This is used to register event listeners/handlers for
+ * handling events that may be fired by TAB.
+ */
+@SuppressWarnings("unused") // API class
+public interface EventBus {
+
+    /**
+     * Scans the given listener for any method that is annotated with
+     * {@link Subscribe} and registers it as a listener to this event bus.
+     *
+     * <p>All methods in this class that are annotated with {@link Subscribe}
+     * must meet the following criteria:
+     * <ul>
+     *     <li>It must be <strong>public</strong>.</li>
+     *     <li>It must <strong>not</strong> be abstract.</li>
+     *     <li>It must have exactly <strong>one</strong> parameter.</li>
+     *     <li>Its single parameter must be <strong>an event</strong>.</li>
+     * </ul>
+     * If a method does not meet the above criteria, an exception <strong>will</strong>
+     * be thrown.
+     *
+     * @param listener the listener to register
+     * @throws RuntimeException if a method does not meet the criteria
+     */
+    void register(@NonNull Object listener);
+
+    /**
+     * Registers the given handler to this event bus.
+     *
+     * @param type the class type of the event
+     * @param handler the handler to register
+     * @param <E> the type of the event
+     */
+    <E extends TabEvent> void register(@NonNull Class<E> type, @NonNull EventHandler<E> handler);
+
+    /**
+     * Scans the given listener for any method that is annotated with
+     * {@link Subscribe} and unregisters it from this event bus.
+     *
+     * @param listener the listener to unregister
+     */
+    void unregister(@NonNull Object listener);
+
+    /**
+     * Unregisters the given handler from this event bus.
+     *
+     * @param handler the handler to unregister
+     * @param <E> the type of the event
+     */
+    <E extends TabEvent> void unregister(@NonNull EventHandler<E> handler);
+}
@@ -0,0 +1,18 @@
+package me.neznamy.tab.api.event;
+
+/**
+ * A handler for an event. This allows listening for events in a more
+ * functional style.
+ *
+ * @param <E> the type of event this handler handles
+ */
+@FunctionalInterface
+public interface EventHandler<E> {
+
+    /**
+     * Called when the given event is fired from an event bus.
+     *
+     * @param event the event to handle
+     */
+    void handle(E event);
+}
@@ -0,0 +1,14 @@
+package me.neznamy.tab.api.event;
+
+import java.lang.annotation.ElementType;
+import java.lang.annotation.Retention;
+import java.lang.annotation.RetentionPolicy;
+import java.lang.annotation.Target;
+
+/**
+ * Subscribes to a {@link TabEvent}.
+ */
+@Target(ElementType.METHOD)
+@Retention(RetentionPolicy.RUNTIME)
+public @interface Subscribe {
+}
@@ -0,0 +1,10 @@
+package me.neznamy.tab.api.event;
+
+/**
+ * An event that may be fired by TAB when something occurs.
+ *
+ * <p>This is a marker interface. All events <strong>must</strong> implement this
+ * interface.
+ */
+public interface TabEvent {
+}
@@ -0,0 +1,26 @@
+package me.neznamy.tab.api.event.player;
+
+import me.neznamy.tab.api.TabPlayer;
+import me.neznamy.tab.api.event.TabEvent;
+import org.jetbrains.annotations.NotNull;
+
+/**
+ * Called when the player has been fully loaded by TAB.
+ */
+public interface PlayerLoadEvent extends TabEvent {
+
+    /**
+     * Gets the player that was loaded.
+     *
+     * @return  the player that was loaded
+     */
+    @NotNull TabPlayer getPlayer();
+
+    /**
+     * Returns {@code true} if player was loaded because they joined,
+     * {@code false} if the player was loaded because tab reload command was executed
+     *
+     * @return  {@code true} if player joined, {@code false} if plugin was reloaded
+     */
+    boolean isJoin();
+}