Interaction menu is a modular, raycast, zone and entity based interaction system for FiveM. It leverages sprites and DUI to render rich, in-game menus, allowing players to interact with entities, world positions, zones, vehicles, and more. Menus are tracked in a centralized container structure and automatically cleaned up via a dedicated garbage collector.
The script offer a wide range of features, including:
- A dedicated
HTML template engine
for creating custom options - Dedicated media components, picture, music, and video players
- Multiple triggers for events, commands, exports and more
- A variety of pre-made beautiful themes
- Full customization of existing themes and the ability to add new ones with ease
- Bridges for compatibility with target scripts like
ox_target
andqb-target
3D Menus
to maintain player immersion in the game world- User Friendly Syntax, clear, straightforward, and easy to pick up
…and many more features waiting to be discovered and brought to life with your creativity!
![]() |
![]() |
![]() |
![]() |
![]() |
Documentation is still a work in progress.
In the meantime, check out the examples in /lua/examples
for guidance.
The script includes numerous examples in the /lua/examples
directory to help you get started.
To explore these examples live within your server:
- Set
Config.devMode
andConfig.debugPoly
totrue
inconfig.shared.lua
. - This enables developer mode, allowing you to see and interact with the examples in real time.
Important: Remember to disable developer mode when you're done testing for optimal performance.
Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.
If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement".
Don't forget to give the project a star! Thanks again!
See LICENSE
for more information.
For questions, support, or community discussions, join Swkeep on Discord