MenuV | Standalone Menu for FiveM | NUI Menu

---

MenuV is a library written for FiveM and only uses NUI functionalities. This library allows you to create menus in FiveM. This project is open-source and you must respect the license and the hard work.

Features

• Support for simple buttons, sliders, checkboxes, lists and confirms
• Support for emojis on items
• Support for custom colors (RGB)
• Support for all screen resolutions.
• Item descriptions
• Rebindable keys
• Event-based callbacks
• Uses 2 msec while menu open and idle.
• Documentation on menuv.fivem.io/api/
• Themes: default or native

Compile files

MenuV uses VueJS 2.6.11 or newer and TypeScript 3.8.3 or newer with NodeJS Package Manager. You need to have NPM a.k.a NodeJS Package Manager installed on your system in order to compile MenuV files.

First download all dependencies by doing

npm install

After you have downloaded/loaded all dependencies, you can compile MenuV files by doeing.

npx webpack

After the command is executed you will see a dist folder containing all the NUI files needed for MenuV.

When downloading a release, this step is not necessary. Files are already compiled.

How to use?

1. Add start menuv to your server.cfg before the resources that's uses menuv

2. To use MenuV you must add @menuv/menuv.lua in your fxmanifest.lua file.

   client_scripts {
      '@menuv/menuv.lua',
      'example.lua'
   }

Create a menu

Create a menu by calling the MenuV:CreateMenu function.

MenuV:CreateMenu(title: string, subtitle: string, position: string, red: number, green: number, blue: number, texture: string, disctionary: string, namespace: string, theme: string)

Example:

local menu = MenuV:CreateMenu('MenuV', 'Welcome to MenuV', 'topleft', 255, 0, 0, 'size-125', 'default', 'menuv', 'example_namespace', 'native')

Create menu items

Create a item by calling AddButton, AddConfirm, AddRange, AddCheckbox or AddSlider in the created menu

/** CREATE A BUTTON */
menu:AddButton({ icon: string, label: string, description: string, value: any, disabled: boolean });

/** CREATE A CONFIRM */
menu:AddConfirm({ icon: string, label: string, description: string, value: boolean, disabled: boolean });

/** CREATE A RANGE */
menu:AddRange({ icon: string, label: string, description: string, value: number, min: number, max: number, disabled: boolean });

/** CREATE A CHECKBOX */
menu:AddCheckbox({ icon: string, label: string, description: string, value: boolean, disabled: boolean });

/** CREATE A SLIDER */
menu:AddSlider({ icon: string, label: string, description: string, value: number, values: [] { label: string, value: any, description: string }, disabled: boolean });

To see example in practice, see example.lua

Events

In MenuV you can register event-based callbacks on menu and/or items.

/** REGISTER A EVENT ON MENU */
menu:On(event: string, callback: function);

/** REGISTER A EVENT ON ANY ITEM */
item:On(event: string, callback: function);

Documentation

Read MenuV documentation

License

Project is written by ThymonA and published under GNU General Public License v3.0 Read License

Screenshot

How is this menu made? see example.lua

Default	Native
Default Theme	Native Theme