Server Setup

Server Setup

This page is for server owners: installing mcRPG, what the config files do, and how data is stored.

Requirements

• Paper Minecraft 26.3. Any older versions are untested... but may work.
• Java: whatever your Minecraft version needs. mcRPG itself needs Java 17 or newer.
• Optional: PlaceholderAPI, WorldGuard.

Don't run mcRPG and mcMMO on the same server. mcRPG is a fork of mcMMO, so they'd both apply their skills to every action.

Installing

1. Download the latest release from the releases page, or build it yourself (see the README).
2. Put it in your server's plugins folder.
3. Restart the server. mcRPG creates plugins/mcRPG/ with its config files.

Always restart after changing a config file. /reload and plugin reloaders aren't supported.

mcRPG can't import mcMMO data. Every player starts at level 0 with no Specializations. mcRPG uses its own folder, database file, table prefix and block-tracking folder, so it never touches mcMMO's data.

Config files

All in plugins/mcRPG/:

File	What's in it
config.yml	Main settings: language, database, Specializations and passives, ability cooldowns and durations, turning skills on or off, level caps, bonus drops
experience.yml	The XP curve, the Specialization multipliers, a global XP multiplier, XP for every action in every skill, mob multipliers, anti-exploit switches
advanced.yml	Ability tuning: chances, damage bonuses, Salvage Mastery, Blast Mining and more
skillranks.yml	The level each ability rank unlocks at
gui.yml	Icons for the Specialization and skills menus
treasures.yml	Excavation treasures
fishing_treasures.yml	Fishing and Shake treasures
potions.yml	Alchemy's potions and Concoctions ingredients
repair.vanilla.yml / salvage.vanilla.yml	What can be repaired and salvaged, with what, and each item's XP multiplier
level_up_commands.yml	Run commands when players reach certain levels
sounds.yml	Sounds
custom_item_support.yml	How custom items work with Repair and Salvage
coreskills.yml, itemweights.yml, persistent_data.yml, hidden.yml	Less common settings
upgrades_overhaul.yml	Internal. Don't edit.

Specialization settings

In experience.yml:

Specialization:
    Multipliers:
        Primary: 1.25
        Secondary: 1.0
        Unselected: 0.35

In config.yml:

Setting	Default	What it does
Specialization.Login_Reminder	true	Remind players on login until they've chosen both Specializations
Specialization.Choose.GUI_Confirmation	true	Show a confirmation screen when choosing in the menu
Specialization.Abandon.Confirm_Timeout_Seconds	30	How long players have to type confirm after /abandonspecialization
Specialization.Abandon.XP_Kept_Percent	10	Share of its total XP each skill keeps when its category is abandoned
Specialization.Passives.Enabled	true	Turn category passives on or off
Specialization.Passives.Unlock_Level_Sum	25	Combined skill levels a category needs for its passive
Specialization.Passives.Leather_Mastery.Bonus_Armor / Bonus_Toughness	9 / 2	Full-set bonus (a quarter per piece)
Specialization.Passives.Chainmail_Mastery.Bonus_Armor / Bonus_Toughness	8 / 9
Specialization.Passives.Copper_Mastery.Bonus_Armor / Bonus_Toughness	5 / 0
Specialization.Passives.Wooden_Mastery.Mining_Speed_Bonus	50	Percent faster block breaking with wooden tools
Specialization.Passives.<Passive>.Durability_Loss_Reduction	50	Percent chance each point of wear is ignored

Other useful settings

Setting	Where	Default
Language	config.yml → General.Locale	en_US
How often data is saved	config.yml → General.Save_Interval	10 minutes
Power Level cap	config.yml → General.Power_Level_Cap	0 (none)
Level cap per skill	config.yml → Skills.<Skill>.Level_Cap	0 (none)
Ability cooldowns and durations	config.yml → Abilities	240 s cooldown (Blast Mining 60 s)
Global XP multiplier	experience.yml → Experience_Formula.Multiplier.Global	1.0
XP from spawner, egg and portal mobs	experience.yml → Experience_Formula	0
Hardcore mode (level loss on death)	config.yml → Hardcore	Off
Sidebar scoreboards	config.yml → Scoreboard	Off

Data storage

FlatFile (default) stores everything in plugins/mcRPG/flatfile/mcrpg.users. It's fine for small servers. Leaderboards refresh every 10 minutes.

MySQL is better for 50+ players online at once, big data files, or several servers sharing data. Turn it on under MySQL in config.yml. Tables start with mcrpg_ (configurable). Leaderboards refresh every minute.

Switch between them with /rpgconvert database <flatfile|sql> (use the type you're switching from).

PlaceholderAPI

With PlaceholderAPI installed, placeholders start with mcrpg_:

Placeholder	Shows
%mcrpg_level_<skill>%	The player's level in a skill
%mcrpg_xp_<skill>%	XP toward the next level
%mcrpg_xp_needed_<skill>%	XP the next level needs in total
%mcrpg_xp_remaining_<skill>%	XP still to go
%mcrpg_rank_<skill>%	Leaderboard rank in a skill
%mcrpg_xprate_<skill>%	The player's XP multiplier for a skill from their Specializations: 1.25, 1.0 or 0.35
%mcrpg_power_level%	Power Level
%mcrpg_primary_specialization%	Primary Specialization's category (empty if none)
%mcrpg_secondary_specialization%	Secondary Specialization's category (empty if none)
%mcrpg_mctop_<skill>:<position>%	The level at a leaderboard position. Use overall for Power Level.
%mcrpg_mctop_name_<skill>:<position>%	The player at a leaderboard position

WorldGuard

mcRPG adds three WorldGuard flags: mcrpg (turn mcRPG off in a region), mcrpg-xp (turn XP gain off) and mcrpg-hardcore (turn Hardcore penalties off).

Names that differ from mcMMO

What	mcMMO	mcRPG
Plugin folder	plugins/mcMMO/	plugins/mcRPG/
FlatFile data	flatfile/mcmmo.users	flatfile/mcrpg.users
MySQL table prefix	mcmmo_	mcrpg_
Block tracking folder (in each world)	mcmmo_regions	mcrpg_regions
Commands	/mcstats, /mmoedit...	/rpgstats, /rpgsetlevel...
Permissions	mcmmo.*	mcrpg.*
Placeholders	%mcmmo_...%	%mcrpg_...%
WorldGuard flags	mcmmo, mcmmo-xp, mcmmo-hardcore	mcrpg, mcrpg-xp, mcrpg-hardcore
bStats	On	Off