Better Marriage

ByGilloDaby
Mods

Better Marriage A modern, immersive wedding system for Hytale. Propose, marry, and manage relationships with dynamic UI, ceremonies, contracts, couple features (TP, chat, home), rewards, guestbooks, and powerful admin tools for cinematic in-game weddings.

Description

💍 Better Marriage

A modern, immersive marriage and wedding system for Hytale servers.

✨ About

Better Marriage adds a complete relationship gameplay loop to your server:

Proposal and acceptance flow
Interactive priest-led ceremonies
Contract drafting and signing
Smart /marry UI that changes based on player marriage state
Couple utilities (chat, TP, home, info)
Ceremony rewards, gifts, guestbook, and post-ceremony summaries
Powerful admin and cinematic wedding tools in-game

No external database setup required. Everything runs with local plugin data files.

🖥️ User-Friendly UI

The plugin is designed to be driven directly from /marry, without command spam.

When not married (/marry → SINGLE_SETUP UI):

Create proposal from UI
Open proposal inbox from UI
Open ceremony setup from UI
Open contract editor from UI

Contract editor (in-UI workflow):

Set participants
Add and remove clauses
Set and cycle split
Choose start music and party music
Validate contract before ceremony
Export draft summary

When married (/marry → HOME UI):

Relation page
Quests and objectives pages
Anniversary pages
Contract details page
Ceremony summary page
Gift chest page
Guestbook page
Settings page (admin)

Result: players can do almost everything directly inside the /marry UI, including contract setup and post-marriage couple management.

🚀 Core Features

Multi-ring support for proposals (including custom rings)
Ring consume toggle on successful marriage
Optional altar requirement
Optional priest requirement
Interactive ceremony script (consent, vows, ring moment, declaration)
Ceremony countdown and anti-disruption safeguards
Wedding tiers (poor, medium, rich) with configurable costs
Optional BetterSkyblock economy integration
Contract system:
- participant selection
- cost split
- clauses
- signatures
- validation before ceremony
Couple objective system (create, edit, complete, history)
Anniversary system (yearly or monthly) with reward claim logic
Couple gift chest and gift history
Ceremony guestbook entries
Ceremony hype system (/wedding hype and /wedding blessing)
Hype HUD + feed HUD during ceremony
Wedding music control UI
Cinematic setup tools (positions, cameras, yaw controls, test mode)

🎮 Player Commands

/marry
/marry menu
/marry menu relation
/marry menu quests
/marry menu anniversary
/marry menu contract
/marry menu guestbook
/marry propose <player>
/marry accept
/marry deny
/marry partner
/marry info
/marry list
/marry tp
/marry sethome
/marry home
/marry chat <message>
/marry chest
/marry chest history
/marry chest take <slot>
/marry guestbook
/marry divorce
/marry stopwedding

🎉 Wedding Commands

Base:

/wedding
/wedding assist
/wedding start
/wedding contract
/wedding hype
/wedding blessing
/wedding gift [message]

Admin / Ceremony setup:

/wedding playsound
/wedding firework
/wedding altar pos1
/wedding altar pos2
/wedding sethome
/wedding teleportback
/wedding pos<1..10> <player1|player2>
/wedding pos <1..10> <player1|player2>
/wedding cam<1..10>
/wedding cam <1..10>
/wedding camstart [index]
/wedding camend [index]
/wedding look <yaw> [player|all]
/wedding posyaw <yaw>
/wedding test <player1> <player2>
/wedding forcestart

🛠️ Priest & Admin Commands

Priest flow:

/marry ceremony <player1> <player2> [poor|medium|rich]
/marry ceremony confirm

Admin flow:

/marry adminmenu
/marry altar <set|remove|list>
/marry forceceremony <player1> <player2> [poor|medium|rich]
/marry admin force <player1> <player2>
/marry admin divorce <player>
/marry admin info <player>
/marry reload

🔐 Permissions

Main:

bettermarriage.use
bettermarriage.priest
bettermarriage.altar
bettermarriage.contract
bettermarriage.admin

Optional role-gated permissions:

bettermarriage.role.priest
bettermarriage.role.moderator

Notes:

If role-priest-permission-required: true, ceremony start also requires bettermarriage.role.priest (or admin).
Admin permission bypasses most restrictions.

💎 Multi-Ring System

Better Marriage accepts multiple ring items as valid proposal rings.

Included ring item IDs:

Marriage_Ring
Ring_Copper
Ring_Iron
Ring_Silver
Ring_Gold
Ring_Thorium
Ring_Cobalt
Ring_Mithril
Ring_Adamantite
Ring_Prisma
Ring_Onyxium

Default ore-based recipes:

Ring_Copper → Ore_Copper
Ring_Iron → Ore_Iron
Ring_Silver → Ore_Silver
Ring_Gold → Ore_Gold
Ring_Thorium → Ore_Thorium
Ring_Cobalt → Ore_Cobalt
Ring_Mithril → Ore_Mithril
Ring_Adamantite → Ore_Adamantite
Ring_Prisma → Ore_Prisma
Ring_Onyxium → Ore_Onyxium

⚙️ Configuration Highlights (config.yaml)

Proposal and ring:

proposal-expiration-seconds
proposal-cooldown-seconds
proposal-require-ring
ring-consume-on-marriage

Ceremony:

priest-required
allow-direct-marriage-without-priest
altar-radius
ceremony-enabled
ceremony-countdown-seconds
ceremony-animation-duration-seconds
ceremony-particle-type
ceremony-sound-start
ceremony-sound-finish

Economy and tiers:

wedding-tier-default
wedding-tier-poor-cost
wedding-tier-medium-cost
wedding-tier-rich-cost
wedding-economy-betterskyblock-enabled

Wedding area and cinematic setup:

wedding-home-*
wedding-teleportback-*
wedding-altar-zone-*
wedding-posstart-*
wedding-posend-*
wedding-pos-<1..10>-player<1|2>-*
wedding-camstart-*
wedding-camend-*
wedding-cam-<1..10>-*

Couple systems:

anniversary-enabled
anniversary-mode
anniversary-reward-credits
partner-online-notification
teleport-cooldown-seconds
divorce-*
contract-item-enabled
contract-command-enabled

Role gates:

role-priest-permission-required
role-contract-editor-permission-required

📦 Installation

Build or download the BetterMarriage jar
Drop it into your server mods folder
Restart server
Use /marry to open the main UI
Configure config.yaml and messages.yaml

🧭 Typical Ceremony Workflow

Player A uses /marry propose <playerB>
Player B uses /marry accept
Priest runs /marry ceremony <playerA> <playerB> [tier]
Priest confirms with /marry ceremony confirm
Players use:
- /wedding start
- /wedding contract
- /wedding hype or /wedding blessing
- /wedding gift [message]
Ceremony completes and data is saved automatically

🧪 Troubleshooting

"No permission" → check bettermarriage.use
"Need altar" → /marry altar set
"Priest required" → give bettermarriage.priest
"Missing role permission" → adjust config or permissions
"Contract required" → complete contract in UI

📁 Data Folder

mods/GilloDaby_BetterMarriage/

Main files:

config.yaml
messages.yaml
marriages.db
altars.db
contracts.db
objectives.db
objective_history.db
anniversary_rewards.db
couple_homes.db
couple_gift_chest.db
couple_gift_history.db
couple_guestbook.db
couple_ceremony_summary.db
proposals.json
pending_ceremonies.json

🔥 Current State

Better Marriage is stable and includes:

Full marriage roleplay system
UI-driven experience
Cinematic wedding tools
Persistent couple progression

Ongoing updates focus on balance, new interactions, and QoL improvements.