# PlaceholderAPI Integration

### Available Placeholders

Use the identifier `nmarry` followed by the specific variable you wish to display.

| **Placeholder**       | **Description**                                           | **Output Example**         |
| --------------------- | --------------------------------------------------------- | -------------------------- |
| `%nmarry_partner%`    | Displays the partner's name or a default "Single" status. | `Tommasino` or `Nobody`    |
| `%nmarry_status%`     | Shows the marriage status with custom colors.             | `❤ Married` or `💔 Single` |
| `%nmarry_level%`      | Displays the current Love Level of the couple.            | `15`                       |
| `%nmarry_xp%`         | Shows the total relationship Experience Points.           | `3450`                     |
| `%nmarry_is_married%` | Boolean check to see if the player is married.            | `true` or `false`          |

***

### Configuration

You can customize the text displayed for single or unknown partners directly in the `config.yml` file:

YAML

```
placeholders:
  status:
    married: "<#E91E63>❤ Married"
    single: "<gray>💔 Single"
  partner:
    none: "Nobody"       # Shown when the player is single
    unknown: "Unknown"   # Shown if the partner's name is not found
```

### How to use

1. Ensure you have PlaceholderAPI installed on your server.
2. NMarry will automatically register its expansion on startup.
3. Use the placeholders in any compatible plugin (DeluxeMenus, TAB, FeatherBoard, etc.).

> 💡 Tip: If the placeholders do not appear, make sure the NMarry plugin is properly enabled in the console.