Solstice-CyberRadial

A sleek, cyberpunk-themed radial menu system for FiveM servers.

Features

• Cyberpunk-themed UI with customizable colors

• Smooth animations and transitions

• Multi-level menu support

• Multiple action types (commands, events, exports)

• Responsive design for all resolutions

• Font Awesome icon support

• Easy configuration

• Export functions for developer integration

Installation

1. Download the Solstice-CyberRadial resource

2. Place it in your FiveM resources folder

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

4. If using the cyber notification style, ensure Solstice-CyberNotify is installed

Configuration

Basic Settings

Open config.lua to modify basic settings:

Config.Settings = {
    OpenKey = 'F1',            -- Key to open/close the menu
    CommandName = 'radialmenu', -- Command to open menu
    NotifyType = 'cyber',      -- Notification type (native, mythic, cyber)
    Debug = false              -- Debug mode
}

Color Customization

The menu's appearance can be customized through the Config.Colors table:

Config.Colors = {
    primary = { r = 255, g = 0, b = 0, a = 1 },       -- Primary accent color
    background = {
        main = { r = 10, g = 0, b = 0, a = 0.85 },    -- Main background
        item = { r = 15, g = 0, b = 0, a = 0.9 }      -- Menu item background
    },
    -- Additional color settings available
}

Usage

Opening the Menu

• Press the configured key (default: F1)

• Use the command /radialmenu

• Call the export: exports['Solstice-CyberRadial']:showMenu()

Navigation

1. Move your mouse to highlight menu items

2. Click to select

3. Press ESC to go back or close the menu

Menu Structure

Menu items are configured in config.lua using the following structure:

{
    id = "unique_id",         -- Unique identifier
    label = "DISPLAY_TEXT",   -- Display text
    icon = {"fas", "icon"},   -- Font Awesome icon
    type = "action_type",     -- Command, client_event, server_event, or export
    action = "action_name",   -- Action to execute
    items = {                 -- Optional submenu items
        -- Submenu items follow the same structure
    }
}

Action Types

• command: Execute a FiveM command

• client_event: Trigger a client event

• server_event: Trigger a server event

• export: Call a resource export

Exports

Show Menu

exports['Solstice-CyberRadial']:showMenu(customConfig)

Hide Menu

exports['Solstice-CyberRadial']:hideMenu()

Add Menu Item

exports['Solstice-CyberRadial']:addMenuItem(menuId, item)

Commands

• /radialmenu: Toggle menu visibility

Customization

Adding Custom Menu Items

local newItem = {
    id = "custom_action",
    label = "CUSTOM",
    icon = {"fas", "star"},
    type = "client_event",
    action = "custom:event"
}

exports['Solstice-CyberRadial']:addMenuItem("parent_menu_id", newItem)

Notification Systems

The menu supports three notification systems:

• Native FiveM notifications

• Mythic Notifications

• Cyber Notifications (recommended)

Examples

Basic Menu Structure

Config.Menu = {
    {
        id = "category",
        label = "CATEGORY",
        icon = {"fas", "folder"},
        items = {
            {
                id = "action",
                label = "ACTION",
                icon = {"fas", "play"},
                type = "command",
                action = "do_something"
            }
        }
    }
}

Troubleshooting

Common Issues

1. Menu not appearing

   • Ensure the resource is started in your server.cfg

   • Check for script errors in the console

   • Verify the keybind is not conflicting with other resources

2. Icons not showing

   • Check icon names in your configuration

3. Actions not working

   • Verify event names match your configuration

   • Check if required resources are running

   • Enable debug mode in config for detailed logging

Support

For additional support or feature requests, please contact:

• Discord: [Solstice Development]