Описание
LPCF 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.
# 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 `[ITEM]` 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 |
# 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` | Allows players to use color and style formatting in chat message text |
| `lpcf.itemplaceholder` | Allows players to use the `[ITEM]` placeholder in chat |
| `lpcf.reload` | Allows access to `/lpcf reload` |
Without `lpcf.colorcodes`, formatting codes inside player message text are stripped.
Server-defined prefixes, suffixes, and formats can still retain their configured styling.
# [ITEM] Placeholder
LPCF includes an optional **`[ITEM]`** placeholder.
When an authorized player uses `[ITEM]` in chat, LPCF reads the item currently held in their main hand and inserts it into the message.
## Item Features
* Uses the player's main-hand item
* Uses the custom item display name when available
* Replaces `[ITEM]` inside the chat message
* Adds a hover event with item details
* Controlled through `lpcf.itemplaceholder`
This gives players a simple way to show items directly in chat.
# PlaceholderAPI Integration
**PlaceholderAPI** integration is optional.
When PlaceholderAPI is installed, LPCF can integrate with it while continuing to use LuckPerms as its required metadata provider.
# Paper & Folia Support
LPCF is designed for modern **Paper and Folia** environments.
Platform support includes:
* `folia-supported: true`
* Folia-safe scheduling
* Safe message rendering
* Safe message delivery
* LuckPerms integration
* Optional PlaceholderAPI integration
Message rendering and delivery are routed through Folia-safe scheduling rather than assuming a traditional single-threaded server environment.
# Command
| Command | Description | Permission |
| --- | --- | --- |
| `/lpcf reload` | Reload LPCF configuration | `lpcf.reload` |
# Example
A typical configuration could use:
* Prefix: `&lOWNER `
* Player: `_NAIZO`
* Separator: `»`
* Message: `wow`
LPCF recognizes the legacy `&l` code and renders the prefix with bold styling while applying the configured chat format.
# Configuration
LPCF can be configured with:
* Default global chat format
* Group-specific formats through `group-formats`
* Track-specific formats through `track-formats`
* LuckPerms metadata placeholders
* Standard LPCF placeholders
* MiniMessage formatting
* Legacy Minecraft formatting
* RGB colors
# Why Choose LPCF?
1. **LuckPerms Focused** — Built around LuckPerms metadata and common rank-formatting workflows.
2. **Folia Compatible** — Uses Folia-safe scheduling for chat rendering and delivery.
3. **Modern & Legacy Formatting** — Supports MiniMessage alongside classic ampersand, section-sign, and RGB formatting.
4. **Flexible Format Resolution** — Configure global, group-specific, and track-specific layouts.
5. **Controlled Player Formatting** — Permissions determine whether players can use formatting codes in chat.
6. **Item Sharing** — `[ITEM]` lets players display their held item directly in chat.
7. **PlaceholderAPI Ready** — Optional integration fits servers already using PlaceholderAPI.
# Compatibility
* Paper
* Folia
* LuckPerms
* MiniMessage
* Legacy Minecraft formatting
* PlaceholderAPI when installed
# Requirements
LPCF requires:
* A supported **Paper or Folia** server
* **LuckPerms**
Optional:
* **PlaceholderAPI**
# Community & Support
* Discord: [https://discord.gg/TJc3CxR4jK](https://discord.gg/TJc3CxR4jK)
* GitHub: https://github.com/MeherBenSalem
* Website: [https://nightbeam.dev](https://nightbeam.dev/)
* Store: [https://nightbeam.dev/store](https://nightbeam.dev/store)
* CurseForge: [https://www.curseforge.com/members/nightbeamstudio/projects](https://www.curseforge.com/members/nightbeamstudio/projects)
* Modrinth: [https://modrinth.com/organization/nightbeam](https://modrinth.com/organization/nightbeam)
If you encounter a bug or have a feature request, please join the Discord community or report it through the appropriate project page.
# License
LPCF is licensed under the Apache License 2.0.
You are free to use, modify, and redistribute LPCF in accordance with the terms of the Apache License 2.0.