# Rp Essentials<\/p>\n
**Rp Essentials** is a comprehensive server-side utility mod built for immersive Roleplay servers running Minecraft 1.21.1 on NeoForge. It provides a complete suite of RP tools: proximity-based name obfuscation, a profession and license system, a warn system, connection tracking, private messaging, schedule automation, staff moderation tools, advanced chat formatting, world border warnings, named zones, Death RP, and deep LuckPerms integration. All configurable in real-time without restarts.<\/p>\n
> Current version: **4.1.9**: See CHANGELOG for the full history.<\/p>\n
—<\/p>\n
## Requirements<\/p>\n
| Dependency | Version | Side | Required |
\n|:———–|:——–|:—–|:———|
\n| Minecraft | 1.21.1 | Both | \u2705 |
\n| NeoForge | 21.1.219+ | Both | \u2705 |
\n| LuckPerms | Any | Server | \u2b1c Optional |
\n| ImmersiveMessages | neoforge-1.21.1:1.0.18 | Client | \u2b1c Optional |
\n| TxniLib | neoforge-1.21.1:1.0.24 | Client | \u2b1c Optional |<\/p>\n
> ImmersiveMessages and TxniLib are only required on the **client** if you use `zoneMessageMode = IMMERSIVE`. The server runs fine without them.<\/p>\n
—<\/p>\n
## Installation<\/p>\n
1. Download the latest `rpessentials-X.X.X.jar` from the releases page.
\n2. Place the JAR in your server’s `mods\/` folder.
\n3. *(Optional)* Install LuckPerms for prefix\/suffix and group-based staff permissions.
\n4. Start the server: all config files are generated automatically under `config\/rpessentials\/`.
\n5. Edit the relevant config files (see ‘Configuration’ below).
\n6. Reload in-game with `\/rpessentials config reload` or restart the server.<\/p>\n
—<\/p>\n
## Features<\/p>\n
### Proximity Obfuscation<\/p>\n
Prevents metagaming by hiding player identities based on distance:<\/p>\n
– Player names in the TabList and above heads are replaced with `?????` beyond a configurable range (default: 8 blocks).
\n– **Tab list player head hidden for obfuscated players:** The skin icon next to an obfuscated player’s name in the tab list is hidden, preventing skin-based identification. Non-obfuscated players, staff, whitelisted players, and always-visible players are unaffected.
\n– **Sneak Stealth Mode:** Crouching players are only detectable at 2 blocks (configurable).
\n– **Nametag Hiding:** Optionally hide all player nametags above heads server-wide.
\n– **Whitelist:** Players who always see all names clearly.
\n– **Blacklist:** Players who are always hidden regardless of distance (stealth staff, NPCs).
\n– **Always Visible List:** Players who are never obfuscated to anyone.
\n– **Spectator Blur:** Players in spectator mode are automatically hidden from the TabList.
\n– LuckPerms rank prefixes are always hidden during obfuscation to prevent rank-based metagaming.
\n– Staff with `opsSeeAll` see both nickname and real name simultaneously: `Nickname (RealName)`.<\/p>\n
### Nickname System<\/p>\n
Persistent RP nicknames fully integrated across all mod systems:<\/p>\n
– Set custom nicknames with full `\u00a7` and `&` color code support.
\n– Nicknames appear in the TabList, above heads, in chat, and in private messages.
\n– Stored persistently in `world\/data\/rpessentials\/nicknames.json`.
\n– `\/whois` allows staff to reverse-lookup any nickname to its real MC username and UUID.<\/p>\n
### Nametag System<\/p>\n
Realistic nametag behavior integrated with the nickname system:<\/p>\n
– **Block occlusion:** Nametags are hidden when a block is between the viewer and the target. Implemented by switching `Font.DisplayMode` from `SEE_THROUGH` to `NORMAL`, activating the GPU depth test, same technique as the Realistic Nametag mod. No raycast, no performance overhead.
\n– **Server nickname on nametag:** The nametag displays the nickname set on the server (via `\/rpessentials nick`), with the LuckPerms prefix and full color code support. Never uses a locally cached nickname.
\n– **Global hide toggle:** All nametags can be hidden server-wide via `hideNametags = true` in `rpessentials-core.toml` or `\/rpessentials config set hideNametags true\/false`.<\/p>\n
### Profession & License System<\/p>\n
A complete job restriction system for RP servers:<\/p>\n
– Define unlimited professions with custom names and color codes.
\n– Physical **license items** are given to players, carrying profession metadata and issuance date.
\n– **RP Licenses:** Decorative-only licenses for events, with a printed expiration date and no actual permissions.
\n– **Restriction types:** crafting, block breaking, item usage, equipment (armor\/weapons), and attacks.
\n– **Global restrictions** apply to all players by default, with **per-profession overrides** for licensed players.
\n– Wildcard pattern support: `minecraft:*_pickaxe` blocks an entire item category.
\n– Restriction messages shown via action bar with anti-spam cooldown.
\n– Tooltips display required professions on restricted items (client-side packet sync).
\n– **License Audit Log:** Every `GIVE`, `REVOKE`, and `GIVE_RP` action is permanently logged to `world\/data\/rpessentials\/license-audit.json`.
\n– **Temp License Registry:** RP licenses are tracked in `world\/data\/rpessentials\/licenses-temp.json`.
\n– Revoked license items are automatically removed from the player’s inventory.
\n– Whitelisted players are exempt from all profession restrictions (configurable).
\n– Granting or revoking a license automatically adds or removes the corresponding vanilla scoreboard tag (tag name = profession ID).<\/p>\n
### Warn System<\/p>\n
Full staff warning system for moderation:<\/p>\n
– Issue **permanent** or **temporary** warns to any online player.
\n– The warned player receives an immediate in-chat notification with the reason and duration.
\n– On every login, players are notified of their active warn count and invited to run `\/mywarn`.
\n– `\/mywarn` lets any player view their own active warns with reason, issuer, date, and remaining time.
\n– Configurable staff broadcast on every warn add and warn remove.
\n– Automatic purge of expired temp-warns on player login (configurable).
\n– Warn IDs are auto-incremental integers, recalculated after every deletion to avoid gaps.
\n– Data stored in `world\/data\/rpessentials\/warns.json`.<\/p>\n
### Last Connection Tracking<\/p>\n
Automatic recording of player connection history:<\/p>\n
– Records last login and last logout for every player.
\n– Data stored in `world\/data\/rpessentials\/lastconnection.json`: human-readable `UUID (McUsername)` key format.
\n– Staff can look up any player’s last connection time, even for offline players.
\n– List view shows the N most recent connections sorted by date.<\/p>\n
### Private Messaging<\/p>\n
Custom `\/msg` system fully replacing vanilla messaging:<\/p>\n
– `\/msg ### Advanced Chat<\/p>\n Full chat formatting system:<\/p>\n – Customizable player name format with LuckPerms prefix\/suffix support (`$prefix $name $suffix`). ### Join \/ Leave Messages<\/p>\n – Fully customizable join and leave messages with `{player}` and `{nickname}` placeholders. ### Welcome Message<\/p>\n – Configurable multi-line welcome message sent to players on login. ### Server Schedule<\/p>\n Automated server opening and closing management with per-day support:<\/p>\n – Each day of the week (`MONDAY` through `SUNDAY`) has its own `enabled`, `open`, and `close` fields. ### Death Hours<\/p>\n An optional schedule layer that activates Death RP during configured time slots, independently of the global Death RP toggle. Supports cross-midnight ranges. Disabled by default.<\/p>\n ### HRP Hours<\/p>\n An optional schedule layer for out-of-roleplay (HRP) period management:<\/p>\n – Two tiers: tolerated (noted but not punished) and allowed (fully free). ### Death RP<\/p>\n Permanent death system for RP servers:<\/p>\n – Global toggle enabling or disabling the system in real-time. ### World Border & Named Zones<\/p>\n – Distance-based warning triggered by proximity to spawn (independent of the vanilla world border). ### Staff Moderation Tools<\/p>\n Silent staff commands with full logging:<\/p>\n – Silent gamemode, teleport, and effect commands: invisible to other players. ### Teleportation Platforms<\/p>\n – Define named platforms across dimensions with custom coordinates. ### Roles<\/p>\n – Assign predefined roles to players via `\/rpessentials setrole`. ### Auto-Unwhitelist<\/p>\n Automatic removal of inactive players from the whitelist:<\/p>\n – Configurable inactivity threshold (days). ### Staff Permission System<\/p>\n Multi-layered staff detection for maximum reliability:<\/p>\n – Scoreboard tags (`admin`, `modo`, `staff`, `builder`: configurable). ### Fully Configurable Messages<\/p>\n Every player-facing string in the mod is exposed as a configurable value via `oneria-messages.toml`:<\/p>\n – Full English translation of all messages out of the box. —<\/p>\n ## Commands<\/p>\n > **Permissions:** `OP 2` = OP level \u2265 2; `Staff` = staff role detected by the mod’s permission system; `Everyone` = all players.<\/p>\n ### Configuration
\n– `\/r
\n– Messages formatted with nicknames, LuckPerms prefixes\/suffixes, and color codes.
\n– Clickable “Click to reply” button in received messages.
\n– Console-to-player messaging supported.<\/p>\n
\n– Full message template with timestamp and color support (`$time | $name: $msg`).
\n– Global chat message color configuration (16 Minecraft colors available).
\n– Timestamp system with customizable Java `SimpleDateFormat`.
\n– **Real-time Markdown support:**
\n – `**text**` \u2192 **Bold**
\n – `*text*` \u2192 *Italic*
\n – `__text__` \u2192 Underline
\n – `~~text~~` \u2192 Strikethrough
\n– `\/colors` displays all available colors and formatting codes with a visual preview.
\n– Full integration with the nickname system, nicknames appear in chat automatically.<\/p>\n
\n– Full color code support.
\n– Can be disabled entirely.<\/p>\n
\n– Optional sound effect with configurable volume and pitch.
\n– `{player}` and `{nickname}` variable support.
\n– Integrates with the schedule system to display server status.<\/p>\n
\n– Disabled days are treated as fully closed.
\n– Automated warnings at 45, 30, 10, and 1 minute before closing.
\n– Smart kick system that only affects non-staff players.
\n– Staff receives notifications when the server opens or closes.
\n– The kick message displays the next open day and its hours (placeholders: `{day}`, `{open}`, `{close}`).
\n– `\/rpessentials schedule` and `\/schedule` display the full week at a glance with the current day highlighted.
\n– Aliases: `\/schedule` and `\/horaires`.<\/p>\n
\n– Broadcast message sent once per slot start to all connected players.
\n– Configurable display mode: `CHAT`, `ACTION_BAR`, `TITLE`, `IMMERSIVE`.
\n– Disabled by default, entirely ignored when `enableHrpHours = false`.<\/p>\n
\n– Per-player overrides to enable, disable, or reset to the global state.
\n– On RP death: a broadcast is sent to all connected players with the deceased’s nickname and real name.
\n– A configurable sound is played to all players on RP death.
\n– Optional automatic whitelist removal on RP death (`whitelistRemove`).
\n– All messages and sounds are fully configurable for both global and per-player toggles.<\/p>\n
\n– Configurable message with `{distance}` and `{player}` placeholders.
\n– **Named Zones:** Define circular zones with center coordinates, radius, and custom entry\/exit messages.
\n– Configurable display mode for zone messages: `IMMERSIVE`, `CHAT`, `ACTION_BAR`.<\/p>\n
\n– All actions logged to console and broadcast to other online staff (configurable).
\n– Target notification disabled by default (stealth mode).<\/p>\n
\n– Staff can teleport themselves or other players to any platform.
\n– `\/setplatform` command to create or update a platform without editing the config file.<\/p>\n
\n– Automatically removes all existing role tags, adds the new tag, and sets the corresponding LuckPerms group.
\n– Roles configurable in `rpessentials-core.toml` under `[Roles]`. Format: `roleId;lpGroup`.
\n– Full tab-completion of available roles.
\n– Requires OP level 3.<\/p>\n
\n– Runs once per day at midnight.
\n– Requires `enableLastConnection = true`.
\n– Staff members online at the time receive a clickable cancel button to immediately re-whitelist the player.
\n– Optional extra commands executed per removed player. Placeholders: `{player}`, `{uuid}`.
\n– Disabled by default.<\/p>\n
\n– Minimum OP level bypass (configurable from 0 to 4).
\n– LuckPerms group integration (configurable).
\n– Results cached for better performance (30-second cache).
\n– Automatic cache invalidation on logout.<\/p>\n
\n– `\u00a7` and `&` color code support in all values.
\n– Reloadable at runtime with `\/rpessentials config reload` (no restart required).
\n– Organized into clear sections: `[System]`, `[Private Messaging]`, `[Warn System]`, `[Last Connection]`, `[Death RP]`, `[Whois]`, `[Player List]`, `[Help]`, `[Profession Restrictions]`.<\/p>\n
\n| Command | Permission | Description |
\n|:——–|:———–|:————|
\n| `\/rpessentials config reload` | OP 2 | Reload all configs and clear caches. |
\n| `\/rpessentials config status` | OP 2 | Display current status of all mod systems. |
\n| `\/rpessentials config set