diff --git a/README.md b/README.md index 197b10f..d9c847d 100644 --- a/README.md +++ b/README.md @@ -1 +1,45 @@ -# r-_weapon_menu \ No newline at end of file + +# **rWeaponTablet** +> A customizable and lightweight NUI weapon tablet for FiveM + +**Preview**: [YouTube Demo](https://www.youtube.com/watch?v=6GjJmVp1l1o) +**Version**: v1.0.0 + +--- + +### **Script Overview** + +- **Performance**: Runs at **0.00 ms** (Client Resmon) +- **Fully customizable UI** (HTML / Tailwind CSS / JS) +- **Permission System**: Compatible with **ACE Perms** + +--- + +### **Tech Stack** + +- **Frontend**: HTML + Tailwind CSS +- **Icons**: FontAwesome +- **Backend**: Lua & Javascript +- **Notifications**: Ox_Lib + +--- + +### **Config.lua Preview** + +![Config Example](https://cdn.discordapp.com/attachments/1276361453049483347/1368343403091197962/image.png?ex=6817e099&is=68168f19&hm=9316610316953970d019f695b72e60802062a73eaba17b18437bf41322cddecd&) + +--- + +### **How to Add Weapons** + +1. Open the `config.lua` file. +2. Add a new line for the weapon (name + code). +3. Add a `.png` image to `build/ui/assets/img` named like the weapon code. + > Example: `WEAPON_COMBATPISTOL.png` + +--- + +### **Contact** + +- **Discord (user tag)**: `c1pps` +- Or join the community: [Join Discord Server](https://discord.gg/UtXSG9bE)