> ## Documentation Index
> Fetch the complete documentation index at: https://pumpkings.mintlify.site/llms.txt
> Use this file to discover all available pages before exploring further.

# PumpkinMsg: Private Messaging for Minecraft Networks

> PumpkinMsg adds cross-platform private messaging, SocialSpy, CmdSpy, ignore, and togglemsg to Paper and Velocity using a single JAR.

PumpkinMsg is a high-performance private messaging plugin built for Minecraft networks. A single JAR file auto-detects whether it is running on a Paper server or a Velocity proxy, so you never need to manage separate builds for different parts of your infrastructure. It ships with rich MiniMessage formatting, deep LuckPerms integration, and a dual spy system that gives your moderation team full visibility into player conversations and commands.

## Key Features

<CardGroup cols={2}>
  <Card title="Private Messaging" icon="message">
    Players use `/msg` and `/reply` to start private conversations across your entire network. Tab-completion suggests online player names in real time.
  </Card>

  <Card title="Ignore System" icon="ban">
    `/ignore` lets any player block messages from a specific user. Toggling the command a second time removes the block.
  </Card>

  <Card title="Toggle Messages" icon="toggle-off">
    `/togglemsg` lets players disable all incoming private messages in one step — useful for streamers or busy staff.
  </Card>

  <Card title="SocialSpy" icon="eye">
    Staff members with the right permission can watch every private conversation on the network, or narrow the feed to a single player.
  </Card>

  <Card title="Command Spy" icon="terminal">
    CmdSpy surfaces the commands players run, with optional per-server filtering and automatic masking of sensitive commands like `/login`.
  </Card>

  <Card title="LuckPerms Prefixes" icon="shield">
    The spy format automatically pulls each player's LuckPerms prefix, so moderators see rank information alongside every intercepted message.
  </Card>

  <Card title="PlaceholderAPI" icon="brackets-curly">
    On Paper servers, any PlaceholderAPI placeholder is valid inside format strings, letting you embed ranks, levels, or custom variables.
  </Card>

  <Card title="MiniMessage Formatting" icon="paintbrush">
    Every format string supports the full MiniMessage spec — hex colors, RGB gradients, hover events, and click actions.
  </Card>
</CardGroup>

## Platform Support

PumpkinMsg 1.3 targets **Paper 1.20+** and **Velocity**. The same JAR works on both platforms; the plugin detects its environment at startup and loads the correct adapter automatically.

<Note>
  Java 17 or newer is required on all platforms. The plugin stores all user data in lightweight flat files inside the plugin data folder — no database setup is needed.
</Note>

## Injection Safety

Player-provided message text is treated as a plain-text literal — not as a raw MiniMessage string. This means players cannot inject color codes, gradients, or click events into their messages, regardless of what they type.
