Solstice-CyberMenu

QB-CyberMenu is a highly customizable, cyberpunk-themed menu system for FiveM. It features smooth animations, customizable colors, and an easy-to-use API for creating and managing menus.

Installation

1. Download the Solstice-CyberMenu resource

2. Place it in your server's resources folder

3. Add ensure Solstice-CyberMenu to your server.cfg

4. Restart your server

Configuration

All menu customization can be done through the config.lua file.

Color Configuration

Config.Menu = {
    -- Main Colors
    primaryColor = {
        r = 255,  -- Red
        g = 0,    -- Green
        b = 76,   -- Blue
        a = 1     -- Alpha/Opacity (0-1)
    },
    
    -- Customize other colors in config.lua
}

Usage

Basic Menu Creation

-- Register a menu
exports['Solstice-CyberMenu']:RegisterMenu('mymenu', {
    title = 'My Menu',
    items = {
        {
            header = 'Menu Item',
            txt = 'Item Description',
            icon = 'fas fa-star',
            action = {
                type = 'client',
                event = 'myScript:doSomething'
            }
        }
    }
})

-- Open the menu
exports['Solstice-CyberMenu']:OpenMenu('mymenu')

Menu Item Types

1. Client Event

{
    header = 'Client Action',
    txt = 'Triggers a client event',
    icon = 'fas fa-user',
    action = {
        type = 'client',
        event = 'myScript:clientEvent',
        args = {'arg1', 'arg2'} -- Optional
    }
}

1. Server Event

{
    header = 'Server Action',
    txt = 'Triggers a server event',
    icon = 'fas fa-server',
    action = {
        type = 'server',
        event = 'myScript:serverEvent',
        args = {'arg1', 'arg2'} -- Optional
    }
}

1. Command

{
    header = 'Command',
    txt = 'Executes a command',
    icon = 'fas fa-terminal',
    action = {
        type = 'command',
        command = 'car'
    }
}

1. Export

{
    header = 'Export Action',
    txt = 'Calls a resource export',
    icon = 'fas fa-code',
    action = {
        type = 'export',
        resource = 'myResource',
        export = 'myExport',
        args = {'arg1', 'arg2'} -- Optional
    }
}

API Reference

Exports

RegisterMenu

Registers a menu that can be opened later.

exports['Solstice-CyberMenu']:RegisterMenu(menuId, menuData)

OpenMenu

Opens a registered menu.

exports['Solstice-CyberMenu']:OpenMenu(menuId)

CloseMenu

Closes the currently open menu.

exports['Solstice-CyberMenu']:CloseMenu()

Examples

Police Menu Example

exports['Solstice-CyberMenu']:RegisterMenu('police', {
    title = 'POLICE ACTIONS',
    items = {
        {
            header = 'Handcuff Person',
            txt = 'Restrain or release the closest person',
            icon = 'fas fa-handcuffs',
            action = {
                type = 'client',
                event = 'police:client:CuffPlayer'
            }
        },
        {
            header = 'Check ID',
            txt = 'View closest person ID',
            icon = 'fas fa-id-card',
            action = {
                type = 'client',
                event = 'police:client:CheckID'
            }
        }
    }
})

Job Menu Example

exports['Solstice-CyberMenu']:RegisterMenu('job', {
    title = 'JOB ACTIONS',
    items = {
        {
            header = 'Clock In',
            txt = 'Start your shift',
            icon = 'fas fa-clock',
            action = {
                type = 'client',
                event = 'job:client:ClockIn'
            }
        },
        {
            header = 'Job Store',
            txt = 'Access work equipment',
            icon = 'fas fa-store',
            action = {
                type = 'server',
                event = 'job:server:OpenStore'
            }
        }
    }
})

Troubleshooting

Common Issues

1. Menu not appearing

   • Ensure the resource is started

   • Check for script errors in console

   • Verify the menu ID exists

2. Icons not showing

   • Check for typos in icon names

3. Events not triggering

   • Verify event names are correct

   • Check event registration

   • Ensure arguments are properly formatted

Support

For additional support or bug reports, please contact us through our discord server

Version History

• 1.0.0: Initial Release

  • Basic menu functionality

  • Cyberpunk theme

  • Event handling

  • Custom configurations