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:

command:">Command:	description:">Description:	permission:">Permission:
/marriage	Opens the Marriage menu - everything below has a button in it.	marriage (granted automatically)
/marry	The marry command line.
/marry player {Username}	Send a marry request, or accept one they already sent you.	May require: marriage.marry
/marry partner	See who you're married to and for how long.
/marry bond	See how deep your bond runs and which perks it has unlocked.
/marry list	Every married couple on the server, online or not.
/marry tp	Teleport to your partner.	May require: marriage.tp
/marry msg {msg}	Send a private message to your partner.	May require: marriage.msg
/marry channel	Toggle the couple channel - everything you type goes to your partner.	May require: marriage.msg
/marry gift	Give the item stack you are holding to your partner.	May require: marriage.gift
/marry letter	Open the Love Letter in your hand, to write it or to read it.
/marry home	Travel to the home you and your partner share.	May require: marriage.home
/marry sethome	Make where you stand your shared home.	May require: marriage.home
/marry clearhome	Forget your shared home.	May require: marriage.home
/marry chest	Open the Hope Chest you share - from anywhere, both at once.	May require: marriage.chest
/marry renew	Renew your vows. Both of you must ask.
/marry hug, kiss, dance	Emotes, with hearts and a sound for anyone close enough to see.
/marry divorce	File for divorce, or agree to one already filed. Works while your partner is offline.	May require: marriage.divorce
/marriage requirering {true/false}	Toggle whether a ring is required to marry.	Require: marriage.admin.requirering
/marriage force marry {Username} {Username}	Marry two online players outright - no proposal, no ring.	Require: marriage.admin.force
/marriage force divorce {Username}	End a player's marriage, online or not.	Require: marriage.admin.force
/marriage force info {Username}	Everything the server knows about that player's marriage. Works offline.	Require: marriage.admin.force

Permissions Extra Info:

permission:">Permission:	description:">Description:
marriage	Allows the player to open the Marriage menu. Granted to the default groups automatically once (config: Grant-Menu-Permission).
marriage.marry	Allows /marry player, when config option Use-Permissions-For-Commands is set as true.
marriage.divorce	Allows /marry divorce, when config option Use-Permissions-For-Commands is set as true.
marriage.tp	Allows /marry tp, when config option Use-Permissions-For-Commands is set as true.
marriage.msg	Allows /marry msg and /marry channel, when config option Use-Permissions-For-Commands is set as true.
marriage.gift	Allows /marry gift, when config option Use-Permissions-For-Commands is set as true.
marriage.home	Allows /marry home, sethome and clearhome, when config option Use-Permissions-For-Commands is set as true.
marriage.chest	Allows /marry chest, when config option Use-Permissions-For-Commands is set as true.
marriage.admin	Shows the Admin page inside the Marriage menu (in-game config editor), and a Divorce control on the Married Couples list.
marriage.admin.requirering	Allows /marriage requirering.
marriage.admin.force	Allows /marriage force marry, force divorce and force 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.

section:">Section:	what_it_controls:">What it controls:
General	"Require-Ring-To-Marry", "Consume-Ring-On-Marry", "Announce-Marriages", "Announce-Divorces", "Use-Permissions-For-Commands".
Requests & Divorce	"Request-Expiry-Seconds", "Divorce-Confirm-Seconds".
Divorce Weight	"Enable-Divorce-Waiting-Period", "Divorce-Waiting-Hours", "Divorce-Uncontested-Factor", "Remarry-Cooldown-Seconds".
Menu	"Enable-Menu", "Grant-Menu-Permission".
PvP Protection	"Enable-Partner-Pvp-Protection", "Default-Pvp-Protection", "Pvp-Protection-Message".
Partner Regeneration	"Enable-Partner-Regen", "Regen-Radius-Blocks", "Regen-Interval-Seconds", "Regen-Amount-Per-Interval".
Gifts, Teleport & Messages	"Enable-Gift", "Gift-Range-Blocks", "Gift-Cooldown-Seconds", "Enable-Partner-Tp", "Tp-Cooldown-Seconds", "Enable-Partner-Msg".
The Bond	"Enable-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 & Honeymoon	"Enable-Anniversaries", "Announce-Anniversaries", the four "Anniversary-Reward-Item-*" values, "Enable-Honeymoon", "Honeymoon-Hours", "Honeymoon-Xp-Multiplier".
Bond Decay	"Enable-Bond-Decay" (off by default), its grace period, drain rate and floor.
Vows	"Enable-Vows", "Vow-Perk-Discount", and each vow's bonus. Plus "Enable-Renew-Vows", "Renew-Min-Days", "Renew-Bond-Xp".
Ring Tiers	"Enable-Ring-Tiers", "Engrave-Rings", and the XP multiplier and perk discount for the Gold and Diamond bands.
The Perks	Each 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 & Records	"Enable-Couple-Channel", "Enable-Love-Letters", "Love-Letter-Max-Length", "Enable-Partner-Hud", "Partner-Hud-Range-Blocks", "Enable-Records".
Emotes	"Enable-Emotes", range, broadcast radius, cooldown, and the particle and sound for each emote.

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

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/.

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