Mermaids.dev

Config

What each section of the Marriage config controls. Config version 5, editable in game.

On this page

Up to date for v2.2.0, config version 5.

There are over a hundred values now, so this page lists what each section controls rather than every key. Two things make that enough:

  • Every value has its description sitting right next to it in the config file.
  • Every value is editable in game, on the Marriage menu’s Admin page – edits are pending until you press Save. You need marriage.admin.

Your existing config is upgraded in place. Nothing you have already set is changed.

Sections

SectionWhat it controls
GeneralRequire-Ring-To-Marry, Consume-Ring-On-Marry, Announce-Marriages, Announce-Divorces, Use-Permissions-For-Commands.
Requests & DivorceRequest-Expiry-Seconds, Divorce-Confirm-Seconds.
Divorce WeightEnable-Divorce-Waiting-Period, Divorce-Waiting-Hours, Divorce-Uncontested-Factor, Remarry-Cooldown-Seconds.
MenuEnable-Menu, Grant-Menu-Permission.
PvP ProtectionEnable-Partner-Pvp-Protection, Default-Pvp-Protection, Pvp-Protection-Message.
Partner RegenerationEnable-Partner-Regen, Regen-Radius-Blocks, Regen-Interval-Seconds, Regen-Amount-Per-Interval.
Gifts, Teleport & MessagesEnable-Gift, Gift-Range-Blocks, Gift-Cooldown-Seconds, Enable-Partner-Tp, Tp-Cooldown-Seconds, Enable-Partner-Msg.
The BondEnable-Bond, Bond-Max-Level, Bond-Xp-Per-Level, and the XP rates for time married, time together, gifts and co-op kills. Turn Enable-Bond off and every enabled perk is simply available from the wedding day.
Anniversaries & HoneymoonEnable-Anniversaries, Announce-Anniversaries, the four Anniversary-Reward-Item-* values, Enable-Honeymoon, Honeymoon-Hours, Honeymoon-Xp-Multiplier.
Bond DecayEnable-Bond-Decay (off by default), its grace period, drain rate and floor.
VowsEnable-Vows, Vow-Perk-Discount, and each vow’s bonus. Plus Enable-Renew-Vows, Renew-Min-Days, Renew-Bond-Xp.
Ring TiersEnable-Ring-Tiers, Engrave-Rings, and the XP multiplier and perk discount for the Gold and Diamond bands.
The PerksEach of the seven has its own Enable- switch and a -Bond-Level. Set a level to 0 to hand that perk out on the wedding day.
Channel, Letters, Plate & RecordsEnable-Couple-Channel, Enable-Love-Letters, Love-Letter-Max-Length, Enable-Partner-Hud, Partner-Hud-Range-Blocks, Enable-Records.
EmotesEnable-Emotes, range, broadcast radius, cooldown, and the particle and sound for each emote.