Configuration

config/config.lua

Only the common ones are listed below.

General#

Debug = false,
AutoRunSQL = true,
DeveloperMode = false,

• Debug: prints logs. Use true while installing, false on live
• AutoRunSQL: creates missing tables on start
• DeveloperMode: for testing only, turn off on live

Interaction#

UseTarget = true,
UseInventoryShop = true,
ItemImagePath = 'nui://ox_inventory/web/images/%s.png',

• UseTarget = true → ox_target / qb-target
• UseTarget = false → press E text
• ItemImagePath → your inventory image path

qb-inventory example:

ItemImagePath = 'nui://qb-inventory/html/images/%s.png',

Surname#

SurnameChange = {
    enable = false,
    restoreOnDivorce = true,
},

• enable = true → wife surname changes on marriage
• restoreOnDivorce = true → old surname comes back on divorce

For Qbox/QB you must follow INSTALL/integrations.md.

Rings#

• RingItems = rings sold in the jewelry shop
• WornRings = rings worn after marriage
• RingReplacement = price to replace a lost ring

To change prices, edit price inside RingItems.

Certificate#

MarriageCertificate = 'marriage_certificate',
CertificateReplacement = {
    enable = true,
    price = 250,
},

Bouquet#

WeddingBouquet = {
    enable = true,
    item = 'wedding_bouquet',
    prop = 'resmon_bouquet',
    removeControl = 73, -- X
    throw = {
        enable = true,
        requireMarried = false,
        requireWife = false,
        key = 'Y',
        throwControl = 38, -- E
        cancelControl = 177, -- Backspace
        maxDistance = 25.0,
        power = 18.0,
        pickupDistance = 2.0,
    },
},

How it works:

• use the item to put the bouquet in hand
• press key to aim
• press E to throw
• another player picks it up

If only the bride should throw:

requireMarried = true,
requireWife = true,

Locations#

Change these for your map:

• JewelryShop.coords
• WeddingHalls[1].coords
• WeddingRegistrar.coords
• WeddingPlanner.ped.coords

Wedding halls also have confetti / fireworks / music points. If you move the hall, move those too.

Planner#

WeddingPlanner = {
    enable = true,
    minAdvanceHours = 1,
    maxBookings = 1,
    enforceCeremonyTime = true,
    earlyStartMinutes = 15,
},

• enforceCeremonyTime = true → ceremony must match the booked time
• Anytime slot (free = true) has no time limit

Ceremony panel#

CeremonyPanel = {
    enable = true,
    openKey = 'M',
    defaultVolume = 0.5,
    syncRadius = 80.0,
},

Default open key is M. Music needs xsound.

Partner tracker#

PartnerTracker = {
    enable = true,
    updateInterval = 750,
    blip = { enable = true },
    drawMarker = { enable = true },
    ui = { enable = true },
},

Married players toggle it from the worn ring menu.

Rewards#

MarriageRewards = {
    enable = true,
    xpPerDay = 10,
    xpPerLevel = 500,
},

Level rewards are in the rewards table. Type can be:

• item
• money

Divorce#

EnableDivorce = true,

Set false to disable divorce.

Before going live#

1. Debug = false
2. items are installed
3. locations are correct
4. xsound is running
5. surname is either off, or integrations are done