Skip to content

boiidevelopment/pluck

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

29 Commits
 
 
 
 
 
 
 
 
 
 

Repository files navigation

PLUCK - Predefined LUA UI Component Kit

Read the docs: Documentation

What is PLUCK?

Formally? Predefined LUA UI Component Kit When it's working great? Perfect Little UI Component Kit When it's not? Painfully Lame UI Clutter Kit

PLUCK lets you build UI entirely in Lua. No HTML. No CSS. No JavaScript. No problem.

Less "learning React" - more "just show the damn button."

Who's It For?

  • Scripters who hate coding UI but still want good-looking panels.
  • Developers who'd rather focus on gameplay.
  • Anyone tired of context menus pretending to be UI.
  • You. Yes, you.

Why Use PLUCK?

  • No Bloat - You only get what you actually use.
  • No Headaches - Buttons, modals, inputs - they just work.
  • No HTML - Build everything in clean, readable Lua.
  • Unified Look - Consistent visuals across your entire server.

What's Included?

Core UI
  • Components can be placed in any section and each has a variety of options to adjust; disabling scroll bars, adding buttons etc etc.
  • Tooltips can be attached to any "slot" or "card" item you use.
image
Slots image
Slot Popup
  • Intended to be paired with slots class to complete inventory setups; allows for displaying add/remove of items etc
image
Sidebar
  • Can be placed on left or right side, supports nested options.
image
Option Picker & Interaction Hints
  • Both components can run independently, however they were designed to be used together for my own personal projects; you do not have to use both in combination thats up to you.
image
Notifications
  • Types: error, info, warning, success, primary
image
Action Menu
  • Supports nested menus; essentially just a "radial menu" thats not radial.
image
Task List
  • Pretty simple task list; this is newest component it may be reworked.
image
Progress Bar
  • Basic stuff, its a progressbar, it shows progress.
image
Progress Circle
  • A progressbar? but a circle.. oooh.. fancy :D
image
DUI Sprite
  • Uses DrawInteractiveSprite to draw a UI in game space, instead of flat on screen.
image
Controls Display
  • Straight forward, for showing key control displays.
image

Quick Install

Download

Add the Resource

  • Drop the pluck folder into your resources directory.

Add to server.cfg

  • ensure pluck

Start or Restart

F8 Console:

  • refresh; ensure pluck

Notes

PLUCK is actively maintained and continuously improved. Core components are stable and production-ready - new features and refinements are added regularly based on real-world usage.

What's Stable:

  • All core UI components (slots, sidebars, notifications, progress bars, etc.)
  • DUI sprite system
  • Action menus and task lists

What's Coming:

  • Additional components as needed
  • Performance optimizations
  • Community-requested features

PLUCK powers all official boii scripts going forward. If it's good enough for production releases, it's good enough for your server.

A Note on Code Quality: JavaScript isn't my primary language. If you spot something dumb, inefficient, or just plain wrong - let me know. I'm here to make this better, not defend bad code. Pull requests and constructive feedback are always welcome.

Support

Need help? Found a bug? Want to complain about my JavaScript?

👉 Discord

Support Hours: Mon–Fri, 10AM–10PM GMT
Outside those hours? Leave a message. I'll get to it when I'm back.

About

PLUCK (Predefined LUA UI Component Kit) For FiveM

Resources

License

Stars

Watchers

Forks

Packages

 
 
 

Contributors