RolePlay Engine

🎭 RolePlay Engine (RPEngine)

RolePlay Engine (RPEngine) is a comprehensive, feature-packed RolePlay framework for NeoForge designed to bring deep immersion, rich character customization, and realistic communication to your Minecraft server.

Whether you are hosting a hardcore RP project or a casual roleplay community, RPEngine provides all the tools you need—from customizable character sheets and dynamic chat degradation to trained messenger birds and global RP events.

⚠️ Note: RPEngine is a hybrid mod (required on both Client and Server) to handle custom network packets, interactive GUIs, and chat notifications.

---

✨ Key Features

📜 Interactive Character Cards

• In-Game Editor: Press K (rebindable) or type /card to open a clean, multi-field character profile editor.
• Flexible Profile Fields: Set your character's First/Last Name, Age, Gender, Occupation, Height, Weight, and Backstory.
• Custom Freeform Fields: Include up to 3 custom fields defined by the player (e.g., Alignment, Fears, Rank).
• **EasyRight-click any player to instantly view their public RP profile! as *"Stranger"* until introduced via /introduce.

---

💬 Advanced & Immersive Chat Mechanics

• **Dynamic Distance DegradWords fade out or lose letters the further away you are from the speaker.Hear that someone is whispering nearby without spoiling the actual message text! dedicated channel for server-wide roleplay narrative events and global story arcs.
• Inline Emotes: Text wrapped in asterisks (e.g., *nods quietly*) inside normal speech is automatically styled as an action emote.
• Character Name Pings: Get notified with an audio cue when your RP character's name is mentioned in chat.
• Smart No-Listener Notifications: Discreetly notifies you if no one heard your message (can be configured to show in chat, above hotbar, or disabled).

---

🎲 Complete Roleplay Commands

Command	Description
/card	Opens the Character Card editor
/local, /global	Toggle or send one-time messages in Local / OOC channels
/grp	Global RolePlay channel for server-wide events
/y	Shout/Yell to increase your chat range
/whisper	Whisper quietly to nearby players
/me, /do, /try	Core RP action commands (/try features customizable success chance)
/roll [dice]	Advanced dice rolling engine with d20 critical hits/fails (e.g., /roll 2d6+3)
/bird <player> <text>	Send a messenger bird (Parrot) carrying a physical letter to offline or distant players
/introduce	Reveal your character's name to a target player
/rp spy	Admin command to monitor local chat across the map

---

🕊️ Carrier Birds (Postal System)

Send physical letters across the world using trained parrots!

• If the recipient is online, a parrot physically flies to their location to deliver the message.
• If the recipient is offline, letters are safely stored in the postal queue until their next login.

---

⚙️ Deep Configuration

• Server Config (config/rpengine-server.toml):

  • Fully customizable channel ranges, HEX colors, format templates, and cooldowns.
  • Speech distortion settings, name uniqueness enforcement, and custom dice formulas.
  • Admin op-level settings and privacy field toggles.
  • Configurable notifyNobodyHeard display mode (Chat, Hotbar, or Disabled).

• Client Config (config/rpengine-client.toml & Mods Menu):

  • Toggle individual channel visibility.
  • Sound notifications for character mentions and whispers.
  • Optional timestamps for chat messages.

---

🛠️ Installation & Setup

1. Place rpengine.jar into the mods folder of both your server and client.
2. Launch the game, bind your keybinds in the Controls menu, and customize config/rpengine-server.toml to fit your server's theme!

---

Found a bug or have a feature request? Feel free to open an issue or contribute to the project!