A FiveM script that spawns interactive NPCs with customizable menus, allowing players to access tutorials, teleportation, commands, webhooks, and other features through a contextual UI.
- Debug -- Debug mode: true enables debug messages, false disables them.
- Locale -- Language setting: 'en' for English, 'de' for German, 'fr' for French, 'es' for Spanish.
- Framework -- Framework selection: 'qb' for QBCore, 'qbox' for QBox Framework, or 'esx' for ESX.
- Menu -- Menu system: "ox" for ox_lib context menus, "qb" for qb-menu.
- Inventory — Inventory system: "ox" for ox_inventory, "qb" for qb-inventory.
- Target -- Target system: "ox" for ox_target, "qb" for qb-target, or disabled.
- TextUI -- TextUI system: "ox" for ox_lib TextUI, "qb" for QBCore TextUI, or disabled.
- Notification -- Notification system: "ox" for ox_lib, "qb" for QBCore, "qbx" for QBox, "esx" for ESX, or "gta" for native GTA.
- NotificationPosition -- Notification position: "top", "top-right", "top-left", "bottom", "bottom-right", "bottom-left", "center-right".
- NotificationStyle -- Notification style: works only for "ox", default or custom CSS object.
- Locations -- Define interactive zones with coordinates, radius, custom notifications, blips, NPCs, and menus.
- Zone Notifications -- Custom notifications when entering or leaving defined zones.
- Blips -- Custom map blips for zones.
- NPCs -- Configurable NPCs in zones (model, scenario, location, interaction distance).
- Menus -- Multiple menu types per zone:
- Webhook: Contact admin, send messages to support, with embed options.
- Guide: Read guides and help texts with custom content, images, and metadata.
- Teleport: Choose a destination and teleport or set a waypoint.
- Command: Execute client commands from the menu.
- Export: Trigger exports/functions from the menu.
- Item: Receive items; can be limited to once per server restart.
- All menus are fully customizable (icon, title, description, metadata, options, events).
- Extendable -- Add more menus, guides, teleport locations, and features per zone.
- qb-core (QBCore): https://github.com/qbcore-framework/qb-core
- qbx_core (Qbox) https://github.com/Qbox-project/qbx_core
- es_extended (ESX): https://github.com/esx-framework/esx_core
- GTAV Mods: https://www.gta5-mods.com/
- GTACars: https://gtacars.net/
- Plebmasters: https://forge.plebmasters.de/
- FiveM Docs: https://docs.fivem.net/docs/
- FiveM Natives: https://docs.fivem.net/natives/
- Controls: https://docs.fivem.net/docs/game-references/controls/
- Blips: https://docs.fivem.net/docs/game-references/blips/
- Checkpoints: https://docs.fivem.net/docs/game-references/checkpoints/
- Markers: https://docs.fivem.net/docs/game-references/markers/
- Ped Models: https://docs.fivem.net/docs/game-references/ped-models/
- Scenarios: https://wiki.rage.mp/wiki/Scenarios
- Vehicle Models: https://docs.fivem.net/docs/game-references/vehicle-references/vehicle-models/
- Vehicle Colours: https://docs.fivem.net/docs/game-references/vehicle-references/vehicle-colours/
- Vehicle Flags: https://docs.fivem.net/docs/game-references/vehicle-references/vehicle-flags/
- Discord: https://discord.com/invite/PjM3997JnW
- Ko-fi: https://ko-fi.com/cxmmunityclub
- GitHub: https://github.com/DavidBrxxwn
CREATIVE COMMONS BY-NC 4.0 LICENSE
This work is licensed under the Creative Commons BY-NC 4.0 license. This means you are free to use, share, and modify it as long as you give credit to the author (BY) and do not use it for commercial purposes (NC). Sharing under the same license is not required.