Skip to content

01. Installation

Finerus edited this page Aug 16, 2026 · 4 revisions

Requirements

Dependency Version Side Required
Minecraft 1.21.1 Both Yes
NeoForge 21.1.219+ Both Yes
RpImmersion 1.0.0 Both Optional
LuckPerms Any Server Optional
Curios 9.5.1-1.21.1 Both Optional
ImmersiveMessages neoforge-1.21.1:1.0.18 Client Optional
TxniLib neoforge-1.21.1:1.0.24 Client Optional

ImmersiveMessages and TxniLib are only needed on the client if any display mode is set to IMMERSIVE (zone messages, Death RP toggles, HRP hours, and so on). The server always runs fine without them, falling back to ACTION_BAR.

Steps

  1. Download the latest rpessentials-X.X.X.jar from the releases page (curseforge or modrinth).
  2. Place the JAR in your server's mods/ folder.
  3. Optionally install LuckPerms for prefix/suffix display and group based staff detection.
  4. Start the server. All six config files are generated automatically under config/rpessentials/:
    • rpessentials-core.toml
    • rpessentials-chat.toml
    • rpessentials-schedule.toml
    • rpessentials-moderation.toml
    • rpessentials-professions.toml
    • rpessentials-messages.toml
    • rpessentials-rp.toml
  5. Edit the files you need, then reload with /rpessentials config reload, most of the time the modification are hot-reloaded (=no need to reload manually). See Configuration Files for what each file contains, and Config Manager GUI to edit values without touching the files directly.

Optional integrations

  • LuckPerms: without it, staff detection falls back to scoreboard tags and OP level, and prefix/suffix display is simply skipped. With it, roles, groups and permission nodes are fully used.
  • Curios: the license item can occupy a dedicated Curios slot if the Curios API is present on the server.
  • ImmersiveMessages (and TxniLib): Add immersive ways to show messages to the players.

Clone this wiki locally