Marriage

Want players to be able to Marry? Now you can with Marriage, this plugin allows the user to marry other users!

And it goes somewhere. A marriage grows a bond that deepens the longer it lasts, unlocks perks as it does, and is shaped by the vow the couple swears. All of it from one in-game menu.

Built for Hytale server 0.5.x. No other mods required - drop it in and it works. Upgrading from an older version? Existing marriages and your config carry over, nothing to re-run.

===--===--===--===--===--===--===--===--===--===--===--===--===--===--===--===--===

Features:

• Two players can marry each other, with requests that expire on their own.
• A rose-themed Marriage menu (/marriage) that does everything the commands do - propose, answer a proposal, teleport, gift, write letters, set your home, open your chest, divorce. Players never have to type a command.
• A bond that deepens with every hour married, every minute spent together, every gift and every kill made side by side - and unlocks perks as it grows.
• Seven bond perks: death alerts, your partner on the map, a shared home, the bond of pain, last stand, the Hope Chest, and respawning at your partner.
• A vow - Hearth, Blade or Wandering - deciding which perks reach you first. Renew your vows later to deepen the bond, reset the decay, upgrade your band and swear anew.
• Anniversaries at 1, 7, 30 and 365 days, with gifts you can actually hold - and a honeymoon for the first day.
• Divorce with weight - mutual is instant, one-sided waits, and the other partner may agree or contest. Plus a remarry cooldown and a remembered history.
• Ring tiers - Copper, Gold and Diamond bands. A finer band deepens the bond faster and opens perks sooner, and a kept band is engraved with both names.
• Love Letters you write, seal, gift and read - the words live on the item itself.
• A persistent couple chat channel, gifts, emotes (hug, kiss, dance), and a partner plate showing their health while they are near.
• A global married list including offline couples, plus a Records page - longest marriage, most generous, most divorced.
• Partner PvP protection and partner regeneration, both configurable.
• Full admin tooling: force marry, force divorce and force info (offline players included), plus an in-game config editor.
• A public API (MarriageAPI) with lookups, bond reads, cancellable events, and admin operations for other mods.
• Over 100 config values, permissions, and English + Chinese localization.

===--===--===--===--===--===--===--===--===--===--===--===--===--===--===--===--===

Commands, Config, and Permissions:

Commands Extra Info:

Permissions Extra Info:

Config Extra Info:

Config version 5. There are over 100 values now, so rather than list them all: every value has its Description sitting right next to it in the config file, and every one is editable in game on the menu's Admin page (edits are pending until you press Save). Your existing config is upgraded in place.

===--===--===--===--===--===--===--===--===--===--===--===--===--===--===--===--===

Works With Cultivation:

Running Cultivation too? Its Partnered Cultivation (双修) gives married couples a faster Qi rate while they meditate together - and Marriage now shows it. A Dual Cultivation page appears in the menu by itself, with your Qi multiplier, how close you must sit, the realm you need, and whether the two of you are dual cultivating right now. On a server without Cultivation the page simply never appears.

===--===--===--===--===--===--===--===--===--===--===--===--===--===--===--===--===

For Mod Developers:

MarriageAPI (plugin.siren.API) gives you isMarried, getPartner, getMarriage stats (married since, gifts, teleports, love notes, bond level and progress, time together), getAllMarriages including offline couples, server totals, bond reads (getBondLevel, getBondProgress, addBondXp, hasPerk) and marry/divorce operations. MarriageEvents lets you listen to - and cancel - marriages, divorces and gifts, and hear about bond level changes, anniversaries and shared homes. MarriageUIRegistry lets your mod add its own pages to the Marriage menu.

===--===--===--===--===--===--===--===--===--===--===--===--===--===--===--===--===

Support the Creator of Marriage:

You can support me by using my creator code SIREN at checkout.

Marriage is free and will always stay free. If you would like to support its development, my store -- The Treasure Pavilion -- is at https://xianxia.dev/store/.

===--===--===--===--===--===--===--===--===--===--===--===--===--===--===--===--===

===--===--===--===--===--===--===--===--===--===--===--===--===--===--===--===--===

===--===--===--===--===--===--===--===--===--===--===--===--===--===--===--===--===