Repository files navigation

MenuV is a library written forFiveM and only uses NUI functionalities. This library allows you to create menus inFiveM. This project is open-source and you must respect thelicense and the hard work.

• 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
• Uses2 msec while menu open and idle.
• Documentation onmenuv.fivem.io/api/
• Themes:default ornative

MenuV usesVueJS andTypeScript withNodeJS. If you want to use themaster files, you need to build the hole project by doing:

npm install

After you have downloaded/loaded all dependencies, you can buildMenuV files by executing the following command:

npm run build

After the command is executed you will see abuild folder containing all the resource files.Copy those files to a resource folder calledmenuv or create a symbolic link like that:

mklink /J"repositoryPath\build""fxResourcesPath\menuv"

ln -s"repositoryPath\build""fxResourcesPath\menuv"

You can also check this tutorial on how to make a link:https://www.howtogeek.com/howto/16226/complete-guide-to-symbolic-links-symlinks-on-windows-or-linux/

When your downloading arelease, you don't have to follow this step, because allrelease version are build version.

⚠️example.lua can't be added in themenuv fxmanifest, you must make an seperate resource like:menuv_example

1. Addstart menuv to yourserver.cfg before the resources that's usesmenuv
2. To useMenuV you must add@menuv/menuv.lua in yourfxmanifest.lua file.

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

Create a menu by calling theMenuV: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:

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

Create a item by callingAddButton,AddConfirm,AddRange,AddCheckbox orAddSlider 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, seeexample.lua

InMenuV 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);

ReadMenuV documentation

Project is written byThymonA and published underGNU General Public License v3.0Read License

How is this menu made? seeexample.lua

Default	Native
Default Theme	Native Theme