Config

Basic configuration for the NProbleM Business Cards Script. Suitable for documentation use.

NMConfig = {}

-- Framework selection: 'esx' or 'qb'
NMConfig['Framework'] = 'qb' 

-- SQL Resource configuration: only one should be true
NMConfig['SQL'] = {
    ['oxmysql'] = true,       -- Use oxmysql (recommended for QBcore)
    ['ghmattimysql'] = false, -- Use ghmattimysql (alternative)
}

NMConfig['Target'] = {
    targetType = 'qb', -- 'qb', 'ox' (defines how players interact)
}

-- General settings
NMConfig['General'] = {
    -- Discord webhook URL for logging all business card activities (creation, copying, etc.)
    -- Leave empty ('') to disable Discord logging
    -- Example: 'https://discord.com/api/webhooks/123456789/abcdefgh...'
    webhookURL = '',

    -- Item name that will be used in the inventory system
    -- This must match the item name defined in your inventory's items.lua or similar file
    -- Default: 'business_card'
    itemName = 'business_card',

    -- Notification system to use for displaying messages to players
    -- Options: 'okok' (okokNotify), 'native' (GTA V default), 'qb' (QBCore), 'ox' (ox_lib)
    -- Make sure the selected notification resource is installed and running on your server
    currentNotifyResource = 'ox',

    -- Language for all in-game messages, menus, and notifications
    -- Available languages depend on your locale files (usually 'en' for English, 'tr' for Turkish)
    -- Check your locale folder for available language options
    currentLocaleLanguage = 'en',

    Commands = {
        -- Command to open the admin management menu
        -- Usage: Type '/adminCreator' in chat (requires admin permission)
        -- You can change 'adminCreator' to any command name you prefer
        createmanage = 'adminCreator',
    },

    -- Price charged per business card copy
    -- When a player wants to duplicate an existing business card, they pay this amount
    -- Set to 0 to make copying free
    -- Currency depends on your server's economy system
    pricePerCopy = 5,
    
    -- Pricing for different business card sizes
    -- Players pay these amounts when creating a new card with the selected size
    CardSizePrices = {
        small = 0,    -- Small card size - Free (no additional cost)
        medium = 25,  -- Medium card size - Costs 25 currency
        large = 50,   -- Large card size - Costs 50 currency
    },

    -- List of license IDs that have admin access to management commands
    -- To find a player's license ID, check your server console or database
    -- Format: 'license:xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx'
    -- Add or remove lines as needed for multiple admins
    adminLicenseIDs = {
        'license:xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx', -- Example admin license ID - Replace with actual license
    },

    -- Available fonts for the business card editor
    -- Players can choose from these fonts when designing their cards
    -- You can add or remove fonts from this list as needed
    Fonts = {
        "Arial",
        "Merriweather",
        ...
    },
}

Last updated