## xMarriage - A Complete and Fun Marriage System

一个允许玩家控制生物生成的Spigot插件。
Tired of boring and simple marriage plugins? **xMarriage** takes relationships on your server to a whole new level, integrating not just a wedding system, but also a ton of interactive features and perks that encourage team play. It's the ultimate plugin for your server's couples!
Designed to be **lightweight, powerful, and fully customizable**, all messages can be translated and support hex color codes (RRGGBB) for seamless integration with your server's aesthetic.
## 💖 Main Features
* **Intuitive Marriage System:** Proposals with timeouts, an accept/deny system, and divorce.
* **Couple's Chest:** A shared double chest inventory (`/marry chest`) exclusively for the couple to store their treasures!
* **Teleport to Partner:** Is your partner in trouble or exploring far away? Use `/marry tp` to get to their side instantly! (Configurable with cooldowns).
* **Gifting System:** Surprise your partner! Gift them the item you're holding in your hand with `/marry gift`.
* **Interactive Kiss:** Use `/marry kiss` when you're near your partner to spawn a beautiful heart particle effect between you both.
* **Proximity Perks:** Playing together has its rewards! Receive positive potion effects (like Regeneration) when you are close to your partner. (Fully configurable).
* **Couple's Home:** Set a shared home with `/marry sethome` and travel there anytime with `/marry home`.
* **Private Chat:** Toggle an exclusive chat channel with `/marry chat` or send a quick message with the `/mc ` command.
* **Gender Selection:** Allows players to set their gender (`/marry gender`), which is displayed in the marriage info.
* **Fully Configurable:** From potion effects to cooldowns and **EVERY MESSAGE** in the plugin, everything can be customized to your liking.
## 📖 Commands
### Player Commands
* `/marry ` - Send a marriage proposal.
* `/marry accept` - Accept a proposal.
* `/marry deny` - Deny a proposal.
* `/marry info` - View information about your current marriage.
* `/marry divorce` - End your marriage.
* `/marry gender ` - Set your gender.
* `/marry chat` - Toggle the couple's private chat.
* `/marry sethome` - Set the couple's home at your location.
* `/marry home` - Teleport to the couple's home.
* `/marry chest` - Open the shared chest.
* `/marry gift` - Gift the item in your hand to your partner.
* `/marry kiss` - Give your partner a kiss if they are nearby.
* `/marry tp` - Teleport to your partner's location.
* `/mc ` - Send a quick private message to your partner.
* `/marry daily` - Claim daily rewards for being couples.
### Admin Commands
* `/marry reload` - Reloads the `config.yml` and `language.yml` files.
## 🔑 Permissions
* `xmarriage.admin` - Permission to use the `/marry reload` command.
* `xmarriage.teleport` - Permission to use `/marry tp`. (Granted to everyone by default).
## ⚙️ Easy Configuration
The plugin includes two files for easy customization:
* **config.yml:** Enable/disable features, change the proximity perk distance and effect, adjust cooldowns, and more!
* **language.yml:** Translate 100% of the messages that players see! Use standard Minecraft color codes and hex colors to perfectly match your server.
## ⚙️ Config.yml
```yaml
# _
# __ __ /\/\ __ _ _ __ _ __(_) __ _ __ _ ___
# \ \/ // \ / _` | '__| '__| |/ _` |/ _` |/ _ \
# > /\/\ \ (_| | | | | | | (_| | (_| | __/
# /_/\_\/ \/\__,_|_| |_| |_|\__,_|\__, |\___|
# |___/ 1.0.1
# Priest NPC name. (The system works by commands) - Coming soon
priest-npc-name: "Priest"
# Effects when getting married
marriage-effects:
sound: "ENTITY_PLAYER_LEVELUP"
particle: "HEART"
# Perks for being close to your partner
proximity-perks:
enabled: true
distance: 10
effect: "REGENERATION"
amplifier: 0
# Particles for being close to your partner
proximity-particles:
enabled: true
distance: 5
particle: "HEART"
# Cooldowns in seconds
cooldowns:
teleport: 60
# Daily reward for couples
daily-reward:
enabled: true
amount: 250.0
cooldown-hours: 24
# Available gender types
gender-types:
male: "EB7FFMale"
female: "F3C2FFFemale"
other: " B83FFNon-binary"
# Here you define the text that the placeholders will display.
placeholders:
# Text for %xmarriage_status%
status-married: "AEFF88Married"
status-single: "FFABABSingle"
# Text for %xmarriage_partner_name% when there is no partner
no-partner: "Nobody"
```
## 🔑 Messanges ;)
```yaml
# Help messages for the /marry command
marry-command:
help:
- ""
- "FE8787&l xMarriage &f- Command list:"
- ""
- "FEC5FF /marry &7- &fPropose marriage to a player."
- "FEC5FF /marry accept &7- &fAccept a proposal."
- "FEC5FF /marry info &7- &fShows information about your marriage."
- "FEC5FF /marry daily &7- &fClaim your daily couple reward."
- "FEC5FF /marry chat &7- &fToggle couple chat on/off."
- "FEC5FF /marry chest &7- &fOpen the shared chest."
- "FEC5FF /marry gift &7- &fGift the item in your hand to your partner."
- "FEC5FF /marry kiss &7- &fKiss your partner."
- "FEC5FF /marry sethome &7- &fSet your marriage home."
- "FEC5FF /marry home &7- &fGo to your marriage home."
- "FEC5FF /marry tp &7- &fTeleport to your partner."
- "FEC5FF /marry divorce &7- &fDivorce your partner."
- "FEC5FF /mc &7- &fSend a quick message to your partner."
- ""
usage: "FF6492Correct usage: /marry "
player-not-found: "FF6492Player E09191 &cis not online."
no-permission: "FF4A4AYou do not have permission to execute this command."
must-be-player: "This command can only be executed by a player."
# Proposal system
proposal:
sent: "FFF73You have proposed to D5FF5Fa3! They have 60 seconds to accept."
received:
- ""
- "FFC0E6&lMarriage Proposal!FF334C ❤"
- "D5FF5F &fhas proposed to you."
- "&fType AEFF88/marry accept &fto accept or FF9999/marry deny &fto reject."
- ""
no-pending-proposal: "FF6492You do not have any pending marriage proposals."
accepted-self: "FFF73You have accepted D5FF5F's &aproposal."
accepted-other: "D5FF5F &ahas accepted your marriage proposal!"
denied-self: "FF6492You have rejected E09191's &cproposal."
denied-other: "E09191 &chas rejected your marriage proposal."
expired: "FF9999's marriage proposal has expired."
# General marriage system messages
marriage:
already-married-self: "FFF1A6You are already married."
already-married-other: "FFF1A6Player E09191 &eis already married."
not-married: "FF6492You are not married."
cant-marry-yourself: " F7DFFYou can’t marry yourself. Love yourself, but not that much!"
# Success and status messages
status:
married-broadcast: "&7 &7 &7 FFF73&lCONGRATULATIONS!&r D5FF5F &fand D5FF5F &fare now married. FF334C❤ &7 &7 &7"
divorced-self: "&7 &7 FF334C&lI'M SORRY!&r &fYou have divorced FF9999c. FF334C💔 &7 &7"
divorced-partner: "&7 &7 FF334C&lI'M SORRY!&r FF9999 &fhas divorced you. FF334C💔 &7 &7"
divorce-broadcast: "&7 &7 FF9999 &fand FF9999 &fhave divorced. FF334C💔 &7 &7"
# Couple chat
chat:
enabled: "FFF73Marriage chat has been enabled."
disabled: "FF6492Marriage chat has been disabled."
format: "E788FF[F4CAFFCoupleE788FF] FFD4EE&7: &f"
partner-offline: "FF6492Your partner is not online."
# Quick Private Chat (/mc)
private-chat:
usage: "FF6492Usage: /mc "
partner-offline: "FF6492Your partner is not online to receive the message."
# Gender
gender:
set: "FFF1A6Your gender has been set to ."
not-valid:
- "FF5A5AThe gender '' is not valid."
- "FFF73Available genders: "
# Marriage home
home:
set: "FFF1A6Your marriage home has been set."
not-set: "FF6492You have not set a marriage home yet."
teleport: "FFF1A6Traveling to your home..."
# /marry info command
info:
header: "FE8787&l Your Marriage Information:"
partner: "FFF27D&lPartner: &f &7()"
status: "FFF27D&lStatus: &f"
gender: "FFF27D&lGender: "
no-gender: "&7Not set"
home-set: "FFF27D&lHome: &fSet"
home-not-set: "FFF27D&lHome: &cNot set"
footer: ""
not-married-info: "FF6492You are not currently married."
# Marriage Chest
chest:
opening: "A6FFD5Opening marriage chest..."
title: "FF8FAB&lCouple's Chest ❤"
# Teleport
teleport:
success: "D4A6FFYou have been teleported to your partner!"
cooldown: "FF9E9EWait! You must wait FFC4C4 &eseconds to use this command again."
partner-not-online: "FF9E9EYour partner is not online."
# Gifts
gift:
nothing-in-hand: "FF9E9EYou don’t have anything in your hand to gift."
sent: "A6FFD5You have gifted E4FF8A- &ato your partner!"
received:
- ""
- "FFB2F3&lYou have received a gift! ❤"
- "F8E4A0
&ahas gifted you E4FF8A- &a."
- ""
# Kiss
kiss:
self: "FFB2F3You have kissed
... FF8FAB❤"
partner: "FFB2F3 has kissed you! FF8FAB❤"
too-far: "FF9E9EYour partner is too far away to be kissed."
# Daily Reward
daily:
success: "A6FFD5You have claimed your daily reward of &e$&a!"
not-married: "FF9E9EOnly married couples can claim this reward."
cooldown: "FF9E9EYou have already claimed your reward! Come back in &e