Skip to content

readme.md

Latest commit

 

History

History
141 lines (102 loc) · 4.73 KB

readme.md

File metadata and controls

141 lines (102 loc) · 4.73 KB
Raw

LPC Banner

Available on Modrinth

Discord Latest Release

LPC – LuckPerms Chat Formatter ✨

A flexible chat formatting plugin with MiniMessage support for LuckPerms

Modern chat formatting powered by MiniMessage, full LuckPerms metadata support, group/track formats, and PlaceholderAPI!

🔧 Requirements

✅ Features

  • Full MiniMessage formatting support
  • Group and track-specific chat formats
  • Optional support for PlaceholderAPI
  • Supports [ITEM] placeholder in chat
  • Customizable reload message
  • No legacy color codes – modern MiniMessage only

🧑‍💼 Permissions

Command / Feature Permission Description
/lpc reload lpc.reload Reloads the config
MiniMessage colors lpc.colorcodes Allows using MiniMessage codes
[ITEM] Placeholder lpc.itemplaceholder Enables the [ITEM] placeholder

⚙️ Configuration (config.yml)

# LPC Configuration

# Main chat format (MiniMessage!)
chat-format: "{prefix}{name}<dark_gray> »<reset> {message}"

# Format per group (optional)
group-formats:
#  default: "<gray>[User]</gray> {name}<dark_gray> »<reset> {message}"
#  admin: "<red>[Admin]</red> {name}<dark_gray> »<reset> {message}"

# Format per track (optional)
track-formats:
#  staff_track: "<gold>[Staff]</gold> {name}<dark_gray> »<reset> {message}"
#  donator_track: "<aqua>[Donator]</aqua> {name}<dark_gray> »<reset> {message}"

# Enable the [ITEM] placeholder
use-item-placeholder: true

# Reload message
reload-message: "<green>LPC configuration reloaded successfully!"

🪄 Available Placeholders

Placeholder Description
{message} The chat message
{name} Player's name
{displayname} Display name / nickname
{world} Player's current world
{prefix} Highest priority prefix
{suffix} Highest priority suffix
{prefixes} Sorted list of all prefixes
{suffixes} Sorted list of all suffixes
{username-color} Username color from meta
{message-color} Message color from meta

ℹ️ Important: All color values (prefix, suffix, etc.) must be in MiniMessage format – no legacy codes (&a, §b, etc.)

📸 Previews

Chat Format Example
Chatformat

[ITEM] Placeholder Example
Item Placeholder

🚀 Installation

  1. Stop your server
  2. Place the LPC.jar into your /plugins folder
  3. Start the server to generate configuration files
  4. Edit the config.yml to your liking
  5. Use /lpc reload to apply your changes ✅

📌 Notes

  • Not affiliated with LuckPerms – Please do not contact the LuckPerms author for support!
  • Legacy formatting version available at: GitHub LPC

⚙ Support:

LuckPerms Software Planned Support
Paper/Spigot 1.8.8-1.21 🔧 Planned
Paper/Spigot 1.21-latest ✅ Supported
Fabric 26.1 🔧 Planned
NeoForge 26.1 🔧 Planned
Forge 26.1 🔧 Planned
Hytale beta ❌ Unplanned
Velocity 3.x 🔧 Planned
Sponge 12 🔧 Planned
Nukkit ❌ Unplanned
Bungeecord 🔧 Planned
Bukkit-Legacy 1.7.10 ❌ Unplanned