How to get started

Information to ensure NMarry works correctly and efficiently on your Minecraft server.

Requirements

• Spigot or Paper (Recommended) You need a Spigot-based server software. Paper or Purpur are highly recommended for maximum compatibility with modern chat components (MiniMessage).

• Minecraft Version The minimum supported version is 1.21.

• Storage (SQLite) By default, the plugin uses a high-performance SQLite database via HikariCP to save marriages, XP, and backpacks. This system is asynchronous, meaning it won't lag your main server thread.

Dependencies

To unlock the full potential of NMarry, you should consider the following integrations:

Optional Dependencies (Soft-Dependencies):

• Vault Essential if you want to charge players for getting married, divorced, or setting a shared home.

• PlaceholderAPI Highly recommended to display partner names, love levels, and marriage status in your Tablist, Scoreboards, or Chat.

• FancyNpcs / Citizens Required if you enable the "Priest" feature, allowing players to only marry when near a specific NPC.

Installation

• Download & Drop: Place the NMarry.jar file inside your server's /plugins/ folder.

• Start Server: Start or restart your server. Upon the first startup, the plugin will automatically generate its main folder (/plugins/NMarry/).

• Files Generated: The following configuration files will be created for you to customize:

  • config.yml: Main settings, economy prices, and database options.

  • messages.yml: All player-facing text (supports Hex colors and MiniMessage).

  • levels.yml: Progression rewards and XP requirements.

  • menu.yml: Customization for the interactive Marriage GUI.

• Reload: If you make changes to the files, use /marryadmin reload to apply them instantly without restarting the server.