Code Monkey home page Code Monkey logo

clxw-xmenu's Introduction

clxw-xmenu for Fivem - README

Introduction


clxw-xmenu is a versatile and customizable menu system for FiveM servers. It allows server administrators to create a dynamic and interactive menu with multiple options and submenus. The menu is easily accessible and can be configured to cater to various server needs.

Features

  • Keybind Trigger: Default keybind is set to 'X', which can be pressed to open the main menu.
  • Allow Movement: Players can move around while the menu is open.
  • Disable Left Click: Prevents accidental actions like hitting someone when the menu is open and movement is allowed.
  • Hold to Show: The menu will display as long as the keybind is held.
  • Submenu Support: Unlimited nesting of submenus for organizing multiple actions.
  • Custom Icons: Each menu item can have its own icon for easy identification.
  • Event Execution: Each menu item has its own execution function, so you can customize it to your needs.
  • Customizable Design: You can customize every color of the UI by simply changing the color in the CSS Config!

Item Example

{
    label = "Your Label",
    icon = "streamline:your-icon",
    execute = function()
        -- Your custom code or event trigger
    end
}

Submenu Example

{
    label = "Submenu Label",
    icon = "streamline:your-icon",
    sub = true,
    items = {
        -- Submenu items
    }
}

Usage

  • Press the configured keybind ('X' by default) to open the menu.
  • Navigate through the options using the mouse or keyboard.
  • Click on an option to execute its associated action or to open a submenu.
  • Hold the keybind if HoldToShow is enabled, or release it to close the menu.

Customization

  • Icons: Customize icons using the icon sets of Iconify.
  • Execution: Attach custom functions to menu options for specific actions.
  • Submenus: Organize complex actions into submenus for better accessibility and user experience.

Notes

  • Ensure that the keybind does not conflict with other in-game keybinds.
  • Test the menu and submenus thoroughly to ensure all actions are executing correctly.
  • The menu can be expanded with more advanced features depending on server requirements.

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.