LPCF - Chat Formatter

<p align="center"> <img src="https://raw.githubusercontent.com/Fuzss/modresources/main/pages/commons/headers/about.png" alt="About"> </p> <p align="center"> <img src="https://i.imgur.com/5QElRqJ.png" alt="LPCF Chat Formatting" width="400"> </p> <p align="center"> <a href="https://nightbeam.dev/support"> <img src="https://i.imgur.com/R9eqHGA.png" alt="Support Nightbeam Studio" width="400"> </a> </p> <p align="center"> <strong>LPCF</strong> is a modern Folia-compatible chat formatting plugin built around LuckPerms metadata. It provides configurable global, group-specific, and track-specific chat formats with MiniMessage rendering, classic Minecraft formatting support, optional PlaceholderAPI integration, and Folia-safe message rendering and delivery. </p> <p align="center"> <a href="https://discord.gg/TJc3CxR4jK"> <img src="https://img.shields.io/static/v1?label=&message=Discord&color=ECEBE6&labelColor=2F4858&style=for-the-badge&logo=discord&logoColor=white" alt="Discord"> </a> <a href="https://www.youtube.com/@nightbeamstudio"> <img src="https://img.shields.io/static/v1?label=&message=YouTube&color=ECEBE6&labelColor=2F4858&style=for-the-badge&logo=youtube&logoColor=white" alt="YouTube"> </a> <a href="https://github.com/MeherBenSalem"> <img src="https://img.shields.io/static/v1?label=&message=GitHub&color=ECEBE6&labelColor=2F4858&style=for-the-badge&logo=github&logoColor=white" alt="GitHub"> </a> <a href="https://www.curseforge.com/members/nightbeamstudio/projects"> <img src="https://img.shields.io/static/v1?label=&message=CurseForge&color=ECEBE6&labelColor=2F4858&style=for-the-badge&logo=curseforge&logoColor=white" alt="CurseForge"> </a> <a href="https://modrinth.com/organization/nightbeam"> <img src="https://img.shields.io/static/v1?label=&message=Modrinth&color=ECEBE6&labelColor=2F4858&style=for-the-badge&logo=modrinth&logoColor=white" alt="Modrinth"> </a> </p> # Features | Feature | Description | | --- | --- | | LuckPerms Metadata | Uses LuckPerms prefix, suffix, username color, message color, and stacked metadata placeholders | | Global Chat Format | Configure a default chat format used across the server | | Group Formats | Define custom formats for specific LuckPerms groups | | Track Formats | Define formats based on LuckPerms tracks | | Format Priority | Resolves group format first, then track format, then the default format | | MiniMessage Rendering | Supports modern MiniMessage tags in formats and metadata | | Legacy Formatting | Supports classic ampersand and section-sign Minecraft formatting | | RGB Hex Colors | Supports `&#RRGGBB` and legacy `&x&R&R&G&G&B&B` hex formatting | | Chat Color Permissions | Control whether players can use formatting codes in their messages | | Item Placeholder | Optional `` placeholder with item name and hover details | | PlaceholderAPI | Optional PlaceholderAPI integration | | Paper & Folia | Built for Paper/Folia with `folia-supported: true` and Folia-safe scheduling | <p align="center"> <a href="https://builtbybit.com/creators/nightbeamstudio.617578/"> <img src="https://i.imgur.com/IeI5PsC.png" alt="Upgrade to Premium" width="350"> </a> </p> # Chat Formatting LPCF provides a configurable chat formatting system designed to work directly with LuckPerms metadata. Server owners can define a global format and override it for specific groups or tracks. ## Format Priority LPCF resolves chat formats in the following order: 1. Group-specific format 2. Track-specific format 3. Default global format This makes it possible to create different chat appearances for ranks, staff groups, progression tracks, or other LuckPerms structures while retaining a reliable default format. # LuckPerms Metadata LPCF integrates with **LuckPerms** as a required dependency. Supported LuckPerms metadata placeholders include: * `{prefix}` * `{suffix}` * `{prefixes}` * `{suffixes}` * `{username-color}` * `{message-color}` These values can be combined with LPCF's additional chat placeholders to build complete chat layouts. # Additional Placeholders LPCF supports: * `{message}` * `{name}` * `{displayname}` * `{world}` These placeholders can be mixed with LuckPerms metadata and formatting tags inside configured chat formats. # MiniMessage Support LPCF supports **MiniMessage** tags inside configured formats and metadata values. This allows modern component-based formatting to be used alongside LuckPerms metadata while still supporting classic Minecraft formatting. # Legacy Minecraft Formatting LPCF supports traditional Minecraft ampersand formatting. ## Color Codes * `&0` through `&9` * `&a` through `&f` ## Style Codes * `&k` * `&l` * `&m` * `&n` * `&o` * `&r` — Reset ## RGB Hex Colors LPCF recognizes: * `&#RRGGBB` * `&x&F&F&A&A&0&0` Legacy section-sign formatting (`§`) is also recognized when present. # Chat Message Permissions | Permission | Description | | --- | --- | | `lpcf.colorcodes` | All