> For the complete documentation index, see [llms.txt](https://code-after-sex.gitbook.io/script-documentation/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://code-after-sex.gitbook.io/script-documentation/cas-wedding/marriage.md).

# Marriage Records and Anniversaries

Marriage records in the RedM Wedding & Marriage System: engagement and marriage status, days married, anniversaries, the six bond levels and anniversary gifts.

`/marriage` opens a character's marriage records anywhere. Holding **R** at the county clerk opens the same records. What they show depends on where the character stands.

| Status       | The records show                                                                                                     |
| ------------ | -------------------------------------------------------------------------------------------------------------------- |
| **Single**   | How to get engaged: buy a ring and use it beside the one you love                                                    |
| **Engaged**  | Who they are promised to, since when, with which ring, and the booked ceremony. **Break off the engagement** ends it |
| **Married**  | The marriage, the bond, anniversary gifts, the certificate and any divorce case                                      |
| **Divorced** | Who the marriage was to, when it was dissolved, and how many days until they may marry again                         |

## Breaking off an engagement

Either partner can choose **Break off the engagement**. Both become single straight away and the other partner is told. The ring stays wherever it is. A couple with a ceremony booked must cancel the booking at the clerk first.

## Married life

The records of a married couple show:

* who they are married to, since when, where, and the certificate number,
* **days married**, **months married** and **days to the next anniversary**,
* their **bond** level and how far it is to the next,
* the **anniversary gifts**, with the ones ready to claim,
* **View Certificate** and **File for divorce**.

## The bond

A married couple's bond grows in two ways:

* **Time together.** Every 10 minutes, a couple who are both online and within 30 m of each other gain 10 bond XP.
* **Anniversary gifts.** Claiming a gift adds its bond XP.

The bond is shared by the couple. It has six levels:

| Level | Name      | Bond XP |
| ----- | --------- | ------- |
| 1     | Newlywed  | 0       |
| 2     | Devoted   | 300     |
| 3     | Faithful  | 800     |
| 4     | Steadfast | 1,300   |
| 5     | Kindred   | 2,000   |
| 6     | Evergreen | 3,000   |

```lua
Config.Marriage.Bond = { TickMinutes = 10, Distance = 30.0, Xp = 10 }
```

| Setting       | Effect                              |
| ------------- | ----------------------------------- |
| `TickMinutes` | How often time together is rewarded |
| `Distance`    | How close the couple must be (m)    |
| `Xp`          | Bond XP per reward                  |

Levels are set in `Config.Marriage.Levels`. Add or remove levels freely. Names come from the language file (`cfg_level_1` and so on), or give a level a `name`:

```lua
Config.Marriage.Levels = {
    { xp = 0 },
    { xp = 300 },
    { xp = 800, name = "Sweethearts" },
    ...
}
```

## Anniversary gifts

A married couple can claim a gift from the county as their marriage reaches each milestone:

| Gift              | Days married | Reward | Bond XP |
| ----------------- | ------------ | ------ | ------- |
| First Week        | 7            | $5     | 100     |
| First Month       | 30           | $15    | 250     |
| Second Month      | 60           | $25    | 400     |
| First Season      | 90           | $40    | 600     |
| Half a Year       | 180          | $60    | 900     |
| Paper Anniversary | 365          | $100   | 1,500   |

Days are counted in real days from the wedding. Each spouse claims their own gift with **Claim**, and each claim adds its bond XP to the couple's bond.

```lua
Config.Marriage.Milestones = {
    { id = "m7", days = 7, money = 5, art = "provision_ro_flower_queens", xp = 100 },
    ...
}
```

| Field            | Effect                                                                                     |
| ---------------- | ------------------------------------------------------------------------------------------ |
| `id`             | A unique id. Claimed gifts are stored by it, so do not change it once couples have claimed |
| `days`           | Days married before it can be claimed                                                      |
| `money`          | Cash paid on claiming                                                                      |
| `item`, `count`  | An inventory item given on claiming, optional. Claiming is refused if it does not fit      |
| `xp`             | Bond XP added on claiming                                                                  |
| `art`            | The picture shown for it, a file in `web/dist/tex/items/` without `.png`                   |
| `name`, `reward` | Write the gift's name or reward text yourself instead of the language file's               |

## The year on documents

```lua
Config.DisplayYear = 1899
```

Dates on certificates, the register, the records and the divorce papers use the real day and month with this year, so everything reads as the 1890s. The certificate and divorce case numbers use it too. Set it to `nil` to show the real year.