mi-allcards¶

mi-allcards is an identity and documents system with a React wallet. It issues ID cards and licenses, runs vehicle registration (STNK) and a civil registry (marriage, divorce, household), supports fake IDs and disguises, and does real name changes. Every read is cached, so a 2000 player server does not pay a query per wallet open.

Install¶

ensure mi-allcards

Depends on ox_lib, ox_inventory, oxmysql and qbx_core or mi_core.

Dependencies (oxmysql, ox_lib, mi_core, ox_inventory) are standard; /onesync is a server policy, not a resource to ensure. It ships server/migrate.lua, so its tables auto-create on first boot, no manual SQL import.

Config¶

Top-level knobs (shared/config/init.lua):

local Config = {
    walletItem    = 'wallet', -- ox_inventory item that opens the wallet on use
    walletCommand = 'wallet', -- chat command to open the wallet
    walletKeybind = nil,      -- e.g. 'F7' (nil = no keybind)

    idCardSettings = {
        closeKey  = 'Backspace',
        autoClose = { status = false, time = 3000 },
    },

    rateLimit = {
        read  = { 30, 10000 }, -- wallet/list/tab fetches
        write = { 8, 10000 },  -- issue/renew/marry/forge/etc
    },

    cache = {
        walletTtl    = 30000, -- per-player wallet card list
        vehiclesTtl  = 60000, -- owned-vehicles lookup for STNK
        householdTtl = 60000, -- marriage/household lookups
    },
}

Civil registry and samsat (shared/config/registry.lua):

return {
    officeCoords    = vec3(-540.0, -204.0, 38.2), -- civil registry / samsat desk
    marriageJob     = 'government', -- '' = any nearby player may officiate
    samsatJob       = 'government', -- '' = self-serve vehicle registration
    maxGiveDistance = 3.0,
    divorceCommand  = 'divorce',
}

Name change (shared/config/namechange.lua). Consumes one item and overwrites the real charinfo:

return {
    item = 'name_change', -- consumed only on a successful change

    fields = { -- set any to false to lock that field server-wide
        firstname = true, lastname = true, gender = true,
        birthdate = true, nationality = true,
    },

    badWords = { 'fart', 'bitch', 'fuck', 'kontol', 'nigger', 'admin', 'server' },

    logging = { webhook = '', username = 'mi-allcards Name Change' }, -- paste your own webhook
}

The card and license catalogue, badges, the photo booth, the fake-ID quiz, and disguise data live in the other shared/config/*.lua modules (cards.lua, badges.lua, booth.lua, fakeid.lua, quiz.lua), which are larger data tables. Wallet colours are in theme.lua.

Testing (shared/config/testing.lua) is the /giveallcards helper. Leave enabled = true while you set the resource up and the command hands a player one of every registered document at once; set it to false on a live server and the command is never registered.

return {
    enabled    = true,
    command    = 'giveallcards', -- /giveallcards [id]  (no id = yourself)
    restricted = 'group.admin',  -- ox_lib restricted takes the GROUP principal, not the bare ace

    skipDuplicates = true, -- do not re-issue a document the target already holds
    grantLicenses  = true, -- also flag the police licenses those cards grant
    giveWalletItem = true, -- hand over Config.walletItem as well

    exclude = {},          -- card types to skip, e.g. { fake_id = true }

    -- Placeholder photo stamped on every test card. '' = no photo: the wallet faces fall back
    -- to an icon, but an id-face card cannot be SHOWN to another player without one.
    mugShot = '',

    -- Dummy values for documents that normally come from samsat / the civil registry.
    sample  = { plate = 'MI44RGI', vehicleModel = 'sultanrs', vehicleColor = 'Midnight Black',
                spouseName = 'Jane Doe', witnessName = 'Officer Smith' },

    -- Persona minted onto the test fake_id; using that item flips you into this identity.
    persona = { firstname = 'John', lastname = 'Smith', birthdate = '01/01/1990',
                sex = 'Male', nationality = 'American', citizenid = 'FK00001' },
}

Exports¶

All server-side unless noted. Other resources verify cards, read identity, and issue documents through these.

Export	Signature	What it does
HasCard	`HasCard(src, cardType, opts)`	True if the player holds a valid card of that type. `opts.mustBeGenuine` rejects fakes
HasValidLicense	`HasValidLicense(src, licenseKey, opts)`	True if the player holds a valid license
GetCard	`GetCard(src, cardType, opts)`	The card metadata, or nil
GetMetaLicense	`GetMetaLicense(src, itemTable)`	Read a license item's metadata
CreateMetaLicense	`CreateMetaLicense(src, itemTable)`	Issue a real license item
CreateFakeMetaLicense	`CreateFakeMetaLicense(src, itemTable, fakeinfo)`	Issue a forged license
CreateIdCardFromMugshot / CreateCardFromMugshot	`(src, cardType, options)`	Issue an ID card using the player's mugshot
GetMaritalStatus	`GetMaritalStatus(src)`	Returns 'single', 'married', or 'divorced'
GetMaritalLabel	`GetMaritalLabel(src)`	Returns 'Single', 'Married', or 'Divorced'
GetSpouse	`GetSpouse(src)`	The player's married partner
GetHousehold	`GetHousehold(src)`	The player's household record
IssueStnk	`IssueStnk(src, plate)`	Issue a vehicle registration (STNK) for a plate
GetEffectiveIdentity	`GetEffectiveIdentity(src)`	The identity a disguised player currently presents
IsDisguised	`IsDisguised(src)`	True while a disguise persona is active
SetDisguise	`SetDisguise(src, persona)`	Apply a disguise persona
GetDisplayName (client)	`GetDisplayName(serverId)`	The effective display name for a player (honours disguise)

Commands¶

Command	Access	Does
`/wallet`	everyone	Open the ID wallet UI
`/divorce`	everyone	File for divorce from the civil registry
`/giveallcards [id]`	group.admin	Hand a player (or yourself) every registered document. Only registered while `testing.enabled` is true.

The first two command names are configurable (Config.walletCommand, Config.registry.divorceCommand), the third is Config.testing.command.

Statebags¶

The resource publishes two replicated player statebags, one for disguises and one for the ID booth.

Statebag	Scope	Set when	Read by
`aliasId`	player	Set to `{ name, cid }` when a disguise persona is applied (`SetDisguise`), cleared to `nil` when the disguise is removed.	Any resource that should show a disguised player's presented name and fake id instead of their real identity.
`inIdCardZone`	player	Set `true` while the player stands in the ID card booth zone, `false` on exit.	Any resource that gates an action to the ID booth area.

See the state reference for the core statebags and GlobalState.