🤖 Configuration

🔧 Core Framework & Integrations

These options define which core systems your server uses.
Ensure they match the resources installed on your server.

• Framework: Core framework handler (qbox, qbcore)
• Inventory: Inventory resource integration
• Apartments: Housing / apartment system
• SpawnSystem: Character spawn handler
• Logs: Logging provider
• Appearance: Skin & appearance system
• StartingApartment: Automatically assign an apartment on first character

CopyConfig.Framework = 'qbox'
Config.Inventory = 'ox_inventory'
Config.Apartments = 'qb-apartments'
Config.SpawnSystem = 'standalone'
Config.Logs = 'ox_lib'
Config.Appearance = 'illenium-appearance'
Config.StartingApartment = false

🐞 Debugging & Logging

Controls console output and debug verbosity.

CopyConfig.Debug = false
Config.DebugLevel = "none" -- none | info | debug

Use debug only during development, as it can be verbose.

🌍 Language & Localization

Defines the default language used for UI labels and messages.

CopyConfig.Language = "en"

👤 Character Slot Settings

Controls how many characters a player can have and whether deletion is allowed.

CopyConfig.EnableDeleteButton = true
Config.DefaultNumberOfCharacters = 5
Config.PlayersNumberOfCharacters = {
    -- ['license:example'] = 10
}

• DefaultNumberOfCharacters applies to all players
• PlayersNumberOfCharacters overrides per license

🎬 Character Creation Cinematic (Door Scene)

This scene is played when entering character creation or selection. It controls walking animation, camera placement, and fallback models.

CopyConfig.DoorScene = {
    Duration = 4000,
    StartCoords = vector4(965.06, 58.37, 112.55, 45.66),
    EndCoords   = vector4(955.54, 59.52, 112.55, 113.73),
    Camera      = vector4(963.26, 63.16, 112.55, 186.60),
    Model       = 'mp_m_freemode_01'
}

📏 Height & Scaling System

Allows players to select character height and dynamically scales the ped.

CopyConfig.HeightScale = {
    enabled = true,
    heightMultiplier = 1.5,
    scaleSpeed = {
        enabled = true,
        inverse = false
    }
}

Config.Height = {
    enabled = true,
    min = 170,
    max = 220,
    default = 175
}

• Height values are in centimeters
• Scaling is applied smoothly during creation

📍 Spawn & Camera Handling

Defines where players are placed during selection and after spawning.

CopyConfig.DefaultSpawn = vector4(-1037.88, -2737.85, 20.17, 326.13)
Config.HiddenCoords = vector4(965.87, 63.24, 112.55, 114.26)
Config.CamTransitionSpeed = 1000

• HiddenCoords is used while the UI is open
• CamTransitionSpeed controls slot camera switching

🎭 Character Slot Positions

Each slot has its own ped position, camera angle, and idle animation.

CopyConfig.CharacterSlots = {
    [1] = {
        ped = vector4(911.93, 52.27, 111.70, 251.04),
        cam = vector4(915.86, 51.59, 111.66, 79.49),
        anim = { dict = "amb@world_human_hang_out_street@female_arms_crossed@base", name = "base" }
    }
}

Add or adjust slots to match your maximum character count.

🖥 UI Customization System

Players can customize UI visuals, audio, and slot animations.

CopyConfig.UISettings = {
    canChangeVisuals = true,
    canChangeAudio   = true,
    canChangeAnim    = true,
    defaults = {
        accent = '#d4af37',
        shape  = 'circle',
        volume = 0.2
    }
}

• Accent color uses HEX format
• Volume range: 0.0 to 1.0

🎞 Slot Preview Animations

Defines which animations can be selected in the UI.

CopyConfig.Animations = {
    {
        label = 'IDLE',
        dict = 'amb@world_human_hang_out_street@female_arms_crossed@base',
        anim = 'base',
        icon = 'fa-person'
    }
}

Icons use FontAwesome identifiers.

🌐 Social Links

Displayed as clickable buttons on the character selection screen.

CopyConfig.Socials = {
    { icon = 'fa-brands fa-discord', label = 'Discord', link = 'https://discord.gg/yourdiscord' },
    { icon = 'fa-solid fa-globe', label = 'Website', link = 'https://yourstore.tebex.io/' }
}

⌨ Controls Display

Shows helpful keybind hints to players.

CopyConfig.Controls = {
    { key = 'F1',  label = 'PHONE' },
    { key = 'ALT', label = 'TARGETING' }
}

✅ Notes

• Ensure all referenced resources are started before this script
• Restart the resource after changing core framework options
• UI changes usually apply instantly unless cached by the framework