{"id":19506106,"url":"https://github.com/thymona/menuv","last_synced_at":"2025-10-07T20:49:38.506Z","repository":{"id":37815245,"uuid":"314238916","full_name":"ThymonA/menuv","owner":"ThymonA","description":"FiveM menu library for creating menu's with NUI","archived":false,"fork":false,"pushed_at":"2022-12-20T10:22:31.000Z","size":5797,"stargazers_count":116,"open_issues_count":22,"forks_count":129,"subscribers_count":7,"default_branch":"master","last_synced_at":"2025-04-09T22:18:16.887Z","etag":null,"topics":["fivem","fivem-script","library","lua","menu","nui","standalone","standalone-library"],"latest_commit_sha":null,"homepage":"https://menuv.fivem.io/api/","language":"Lua","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"gpl-3.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/ThymonA.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2020-11-19T12:18:02.000Z","updated_at":"2025-03-09T23:00:46.000Z","dependencies_parsed_at":"2023-01-30T00:15:23.708Z","dependency_job_id":null,"html_url":"https://github.com/ThymonA/menuv","commit_stats":null,"previous_names":[],"tags_count":6,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ThymonA%2Fmenuv","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ThymonA%2Fmenuv/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ThymonA%2Fmenuv/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ThymonA%2Fmenuv/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/ThymonA","download_url":"https://codeload.github.com/ThymonA/menuv/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248119286,"owners_count":21050755,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["fivem","fivem-script","library","lua","menu","nui","standalone","standalone-library"],"created_at":"2024-11-10T22:35:40.341Z","updated_at":"2025-10-07T20:49:33.472Z","avatar_url":"https://github.com/ThymonA.png","language":"Lua","readme":"# MenuV | Standalone Menu for FiveM | NUI Menu\n[![N|CoreV](https://i.imgur.com/iq1llQG.jpg)](https://github.com/ThymonA/menuv)\n\n[![Issues](https://img.shields.io/github/issues/ThymonA/menuv.svg?style=for-the-badge)](https://github.com/ThymonA/menuv/issues)\n[![License](https://img.shields.io/github/license/ThymonA/menuv.svg?style=for-the-badge)](https://github.com/ThymonA/menuv/blob/master/LICENSE)\n[![Forks](https://img.shields.io/github/forks/ThymonA/menuv.svg?style=for-the-badge)](https://github.com/ThymonA/menuv)\n[![Stars](https://img.shields.io/github/stars/ThymonA/menuv.svg?style=for-the-badge)](https://github.com/ThymonA/menuv)\n[![Discord](https://img.shields.io/badge/discord-Tigo%239999-7289da?style=for-the-badge\u0026logo=discord)](https://discordapp.com/users/733686533873467463)\n\n---\n\n**[MenuV](https://github.com/ThymonA/menuv)** is a library written for **[FiveM](https://fivem.net/)** and only uses NUI functionalities. This library allows you to create menus in **[FiveM](https://fivem.net/)**. This project is open-source and you must respect the [license](https://github.com/ThymonA/menuv/blob/master/LICENSE) and the hard work.\n\n## Features\n- Support for simple buttons, sliders, checkboxes, lists and confirms\n- Support for emojis on items\n- Support for custom colors (RGB)\n- Support for all screen resolutions.\n- Item descriptions\n- Rebindable keys\n- Event-based callbacks\n- Uses `2 msec` while menu open and idle.\n- Documentation on [menuv.fivem.io/api/](https://menuv.fivem.io/api/)\n- Themes: **[default](https://i.imgur.com/xGagIBm.png)** or **[native](https://i.imgur.com/KSkeiQm.png)**\n\n## Compile files\n**[MenuV](https://github.com/ThymonA/menuv)** uses **[VueJS](https://vuejs.org/v2/guide/installation.html#NPM)** and **[TypeScript](https://www.npmjs.com/package/typescript)** with **[NodeJS](https://nodejs.org/en/)**. If you want to use the **`master`** files, you need to build the hole project by doing:\n\n```sh\nnpm install\n```\nAfter you have downloaded/loaded all dependencies, you can build **[MenuV](https://github.com/ThymonA/menuv)** files by executing the following command:\n```sh\nnpm run build\n```\n\nAfter the command is executed you will see a `build` folder containing all the resource files.\nCopy those files to a resource folder called `menuv` or create a symbolic link like that:\n\n### Windows\n\n```batch\nmklink /J \"repositoryPath\\build\" \"fxResourcesPath\\menuv\"\n```\n\n### Linux\n\n```sh\nln -s \"repositoryPath\\build\" \"fxResourcesPath\\menuv\"\n```\n\nYou can also check this tutorial on how to make a link:\n[https://www.howtogeek.com/howto/16226/complete-guide-to-symbolic-links-symlinks-on-windows-or-linux/](https://www.howtogeek.com/howto/16226/complete-guide-to-symbolic-links-symlinks-on-windows-or-linux/)\n\n**When your downloading a [release](https://github.com/ThymonA/menuv/releases), you don't have to follow this step, because all [release](https://github.com/ThymonA/menuv/releases) version are build version.**\n\n## How to use?\n\u003e ⚠️ **example.lua** can't be added in the **menuv** fxmanifest, you must make an seperate resource like: **[menuv_example](https://github.com/ThymonA/menuv/tree/master/example)**\n1. Add `start menuv` to your **server.cfg** before the resources that's uses **menuv**\n2. To use **[MenuV](https://github.com/ThymonA/menuv)** you must add **@menuv/menuv.lua** in your **fxmanifest.lua** file.\n\n```lua\nclient_scripts {\n    '@menuv/menuv.lua',\n    'example.lua'\n}\n```\n\n### Create a menu\nCreate a menu by calling the **MenuV:CreateMenu** function.\n```ts\nMenuV:CreateMenu(title: string, subtitle: string, position: string, red: number, green: number, blue: number, texture: string, disctionary: string, namespace: string, theme: string)\n```\n**Example:**\n```lua\nlocal menu = MenuV:CreateMenu('MenuV', 'Welcome to MenuV', 'topleft', 255, 0, 0, 'size-125', 'default', 'menuv', 'example_namespace', 'native')\n```\n\n### Create menu items\nCreate a item by calling **AddButton**, **AddConfirm**, **AddRange**, **AddCheckbox** or **AddSlider** in the created menu\n```ts\n/** CREATE A BUTTON */\nmenu:AddButton({ icon: string, label: string, description: string, value: any, disabled: boolean });\n\n/** CREATE A CONFIRM */\nmenu:AddConfirm({ icon: string, label: string, description: string, value: boolean, disabled: boolean });\n\n/** CREATE A RANGE */\nmenu:AddRange({ icon: string, label: string, description: string, value: number, min: number, max: number, disabled: boolean });\n\n/** CREATE A CHECKBOX */\nmenu:AddCheckbox({ icon: string, label: string, description: string, value: boolean, disabled: boolean });\n\n/** CREATE A SLIDER */\nmenu:AddSlider({ icon: string, label: string, description: string, value: number, values: [] { label: string, value: any, description: string }, disabled: boolean });\n```\nTo see example in practice, see [example.lua](https://github.com/ThymonA/menuv/blob/master/example/example.lua)\n\n### Events\nIn **[MenuV](https://github.com/ThymonA/menuv)** you can register event-based callbacks on menu and/or items.\n```ts\n/** REGISTER A EVENT ON MENU */\nmenu:On(event: string, callback: function);\n\n/** REGISTER A EVENT ON ANY ITEM */\nitem:On(event: string, callback: function);\n```\n\n## Documentation\nRead **[MenuV documentation](https://menuv.fivem.io/api/)**\n\n## License\nProject is written by **[ThymonA](https://github.com/ThymonA/)** and published under\n**GNU General Public License v3.0**\n[Read License](https://github.com/ThymonA/menuv/blob/master/LICENSE)\n\n## Screenshot\n**How is this menu made?** see **[example.lua](https://github.com/ThymonA/menuv/blob/master/example/example.lua)**\n\n\nDefault | Native\n:-------|:--------\n![MenuV Default](https://i.imgur.com/xGagIBm.png) | ![MenuV Native](https://i.imgur.com/KSkeiQm.png)\n[Default Theme](https://i.imgur.com/xGagIBm.png) | [Native Theme](https://i.imgur.com/KSkeiQm.png)\n","funding_links":[],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fthymona%2Fmenuv","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fthymona%2Fmenuv","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fthymona%2Fmenuv/lists"}