Field	Type	Description
`id`	`number`	Machine ID
`coords`	`table`	Machine coordinates
`balance`	`number`	Current machine balance
`stock.used`	`number`	Currently used stock space
`stock.total`	`number`	Total stock capacity
`label`	`string?`	Custom machine label
`role`	`string`	Player's role for this machine
`permissions`	`table`	Player's permissions for this machine
`street`	`string`	Street name resolved from the machine location

Field	Type	Description
`id`	`number`	Purchase ID
`machine_id`	`number`	Machine ID
`buyer_name`	`string`	Buyer name
`item_name`	`string`	Inventory item name
`item_label`	`string`	Display label of the item
`price`	`number`	Purchase price
`created_at`	`number`	Purchase timestamp

Framework	Housing	Inventory	Voice	Banking	Garages	Target
esx	esx_property	codem-inventory	mumble-voip	esx_society	cd_garage	qb-target
ox	loaf_housing	esx_inventory	pma-voice	fd_banking	esx_advancedgarage	ox_target
qb	ps-housing	ox_inventory	saltychat	ox_core	jg-advancedgarages	qtarget
vrp	qb-houses	ps-inventory		p_banking	loaf_garage
standalone	qs-housing	qb-inventory		qb-banking	lunar_garage
	vms_housing	qs-inventory		renewed-banking	okokGarage
	rx_housing	core_inventory		tgg-banking	qb_garages
	nolag_properties	tgiann_inventory		tgiann-bank	qbx_garages
	vms_housing	origen_inventory		wasabi_banking	ZSX_Garages
	bcs_housing	tgiann-inventory		okokBanking	vms_garages
	rtx_housing

DATA	LB-Phone	High-Phone	QS-Phone-Pro	YSeries	QB-Phone
Phone Numbers	✅	✅	✅	✅	✅
Settings	✅	✅	✅	✅	❌
Contacts	✅	✅	✅	✅	✅
Gallery	✅	✅	✅	✅	✅
SMS	✅	✅	✅	✅	✅
Voice Recordings	✅	❌	❌	❌	❌
Recent Calls	✅	✅	✅	✅	❌
Qwuaker	✅	✅	✅	❌	❌
Notes	✅	✅	✅	✅	❌
Mail	✅	✅	✅	❌	❌
DarkChat	✅	❌	✅	❌	❌
Peargram	✅	❌	✅	❌	❌
Alarms	✅	❌	✅	✅	❌
Map Waypoints	✅	❌	✅	✅	❌
Swiply	❌	❌	✅	❌	❌

Argument	Type	Optional	Explanation
number	`number \| string`	❌	A target phone number

Argument	Type	Optional	Explanation
src	`number`	❌	The player's server ID (source).

Argument	Type	Optional	Explanation
identifier	`string`	❌	Player identifier

Argument	Type	Optional	Explanation
number	`number \| string`	❌	A target phone number

Argument	Type	Optional	Explanation
src	`number`	❌	The player's server ID (source).
state	`boolean`	❌	`true` to block the phone, `false` to unblock.

Argument	Type	Optional	Explanation
app	`string`	❌	The internal name of the app (e.g., `"darkchat"`, `"swiply"`).
username	`string`	❌	The username of the account.
newPassword	`string`	❌	The new password to set.

Argument	Type	Optional	Explanation
src	`number`	❌	The player's server ID (source).
notification	`Notification`	❌	The notification data object.

Argument	Type	Optional	Explanation
number	`string`	❌	The target phone number.
notification	`Notification`	❌	The notification data object (same structure as above).

Argument	Type	Optional	Explanation
notification	`Notification`	❌	The notification data object (same structure as above).

Argument	Type	Optional	Explanation
coords	`vector3`	❌	Coords to check signal

Argument	Type	Optional	Explanation
playerId	`number`	❌	Player ID to check

Argument	Type	Optional	Explanation
playerId	`number`	❌	Player ID to Give
number	`string`	✅	What number should be assigned. If no number is given then script will generate random

Argument	Type	Optional	Explanation
playerId	`number`	❌	Player ID to Eject
number	`string`	✅	What number should be ejected. If no number is given, then current phone number will eject.

Argument	Type	Optional	Explanation
number	`string`	❌	A target phone number

Argument	Type	Optional	Explanation
src	`number`	❌	The server ID (source) of the player.
pin	`string`	❌	The new PIN code. Max 4 characters.

Argument	Type	Optional	Explanation
playerId	`number`	❌	Player ID to get from

Argument	Type	Optional	Explanation
state	`boolean`	❌	`true` to block the phone, `false` to unblock.

Argument	Type	Optional	Explanation
state	`boolean`	❌	`true` to turn on, `false` to turn off.

Argument	Type	Optional	Explanation
state	`boolean`	❌	`true` to enable Streamer Mode.

Argument	Type	Optional	Explanation
appName	`string`	❌	The internal name of the app (e.g., `"messages"`, `"camera"`).

Argument	Type	Optional	Explanation
appName	`string`	❌	The internal name of the app to close.

Argument	Type	Optional	Explanation
coords	`vector3`	❌	Coords to check signal

Argument	Type	Optional	Explanation
x	`float`	❌	x coordinates (0.0-1.0) 0 being right edge of the screen, 1 being left edge of the screen
y	`float`	❌	y coordinates (0.0-1.0) 0 being bottom edge of the screen, 1 being top edge of the screen

Argument	Type	Optional	Explanatio
title	`string`	❌	The title of the news post.
content	`string \| JSONContent`	❌	The content of the post. Can be a simple string or a `JSONContent` object.
image	`string`	❌	URL to the image attached to the news.
company	`string`	❌	The identifier of the company posting the news.

Argument	Type	Optional	Explanation
src	`number`	❌	The player's server ID (source).
state	`boolean`	❌	`true` to enable notifications, `false` to disable.

Argument	Type	Optional	Explanation
number	`number`	❌	The player's phone number.
state	`boolean`	❌	`true` to enable notifications, `false` to disable.

Argument	Type	Optional	Explanation
src	`number`	❌	The player's server ID (source).
state	`boolean`	❌	`true` to enable notifications, `false` to disable.

Argument	Type	Optional	Explanation
number	`number`	❌	The player's phone number.
state	`boolean`	❌	`true` to enable notifications, `false` to disable.

Argument	Type	Optional	Explanation
src	`number`	❌	The player's server ID (source).
type	`photo \| video`	❌	Type of media
url	`string`	❌	Direct URL to the image or video file.

Argument	Type	Optional	Explanation
number	`number`	❌	The player's phone number.
type	`photo \| video`	❌	Type of media
url	`string`	❌	Direct URL to the image or video file.

Argument	Type	Optional	Explanation
src	`number`	❌	The player's server ID (source).
mediaId	`number \| number[]`	❌	The id of media

Argument	Type	Optional	Explanation
src	`number`	❌	The player's phone number.
mediaId	`number \| number[]`	❌	The id of media

Argument	Type
src	`number`	❌	The player's server ID (source).

Argument	Type	Optional	Explanation
src	`number`	❌	The player's phone number.

Argument	Type	Optional	Explanation
src	`number`	❌	The player's server ID (source).
inboxType	`"inbox" \| "favourites"` `\| "sent" \| "bin"`	❌	Target inbox of player

Argument	Type	Optional	Explanation
number	`number`	❌	The player's phone number.
inboxType	`"inbox" \| "favourites"` `\| "sent" \| "bin"`	❌	Target inbox of player

Argument	Type	Optional	Explanation
src	`number`	❌	The player's server ID (source).
topic	`string`	❌	The subject line of the email.
message	`string`	❌	The main content of the email.
images	`string[]`	✅	An optional array of image URLs to attach.

Argument	Type	Optional	Explanation
src	`number`	❌	The player's phone number.
topic	`string`	❌	The subject line of the email.
message	`string`	❌	The main content of the email.
images	`string[]`	✅	An optional array of image URLs to attach.

Argument	Type	Optional	Explanation
src	`number`	❌	The player's server ID (source).
sender	`string`	❌	The display name of the email sender. (if using fake-data set last variable to true)
topic	`string`	❌	The subject line of the email.
message	`string`	❌	The main content of the email.
images	`string[]`	✅	An optional array of image URLs to attach.
customUser	`boolean`	✅	Set this to true, if sender is account that doesn't exist

Argument	Type	Optional	Explanation
number	`number`	❌	The player's phone number.
sender	`string`	❌	The display name of the email sender (if using fake-data set last variable to true)
topic	`string`	❌	The subject line of the email.
message	`string`	❌	The main content of the email.
images	`string[]`	✅	An optional array of image URLs to attach.
customUser	`boolean`	✅	Set this to true, if sender is account that doesn't exist

Argument	Type	Optional	Explanation
src	`number`	❌	The player's server ID (source).
label	`string`	❌	The name/label of the pin.
color	`number`	❌	Index of the pin color (0-4).
position	`Vector2`	❌	Coordinates for the pin.

Argument	Type	Optional	Explanation
number	`number`	❌	The player's phone number.
label	`string`	❌	The name/label of the pin.
color	`number`	❌	Index of the pin color (0-4).
position	`Vector2`	❌	Coordinates for the pin.

Argument	Type	Optional	Explanation
src	`number`	❌	The player's server ID (source).
title	`string`	❌	The title/name of the recording.
url	`string`	❌	Direct URL to the audio file (e.g., .ogg, .mp3).

Argument	Type	Optional	Explanation
number	`number`	❌	The player's phone number.
title	`string`	❌	The title/name of the recording.
url	`string`	❌	Direct URL to the audio file (e.g., .ogg, .mp3).

Argument	Type	Optional	Explanation
src	`number`	❌	The player's server ID (source).
coin	`string`	❌	The name/identifier of the coin (e.g., "bitcoin").

Argument	Type	Optional	Explanation
number	`number`	❌	The player's phone number.
coin	`string`	❌	The name/identifier of the coin (e.g., "bitcoin").

` with `className='px-4 pt-10 ...'`, to display the user bar at the top of the homepage if the user is logged in. This block conditionally renders the user's name and a logout button using the retrieved `currentUser` object and the `logoutUser` function. ```typescript // web/src/views/Homepage.tsx - Inside the return statement: return (

{/* ⬅️ ADD THIS BLOCK */} {currentUser && (

{getLang('Userbar:Title')}

{currentUser.username}

)} {/* ⬅️ END OF USER BAR BLOCK */}

{/* ... Rest of the component content ... */} ``` {% endstep %} {% endstepper %} # TRANSLATIONS FOR AUTH VIEWS To ensure the new authentication views support multiple languages, you need to define the translation keys for all user-facing text used in `AuthLogin` and `AuthRegister`. ### Defining Keys in Locale File You must add these translation keys and their corresponding English values to the appropriate locale file, typically `locale/en.lua` (for English). The format within the `.lua` file is: `["key"] = "value",` Add the following keys to your `locale/en.lua` file. These keys correspond to the strings used in `Auth.tsx`: {% tabs %} {% tab title="locale/en.lua" %}

-- Add these keys to the locale/en.lua file:

["Userbar:Title"] = "Welcome",

["Auth:Pages.Login.Title"] = "Login",
["Auth:Pages.Login.Form.Username"] = "Username",
["Auth:Pages.Login.Form.Password"] = "Password",
["Auth:Pages.Login.Form.Button"] = "Login",
["Auth:Pages.Login.Form.NoAccount"] = "Don't have an account?",
["Auth:Pages.Login.Form.NoAccount.Register"] = "Register",

["Auth:Pages.Register.Title"] = "Register",
["Auth:Pages.Register.Form.Username"] = "Username",
["Auth:Pages.Register.Form.Password"] = "Password",
["Auth:Pages.Register.Form.RepeatPassword"] = "Repeat Password",
["Auth:Pages.Register.Form.Button"] = "Register",
["Auth:Pages.Register.Form.HasAccount"] = "Already have an account?",
["Auth:Pages.Register.Form.HasAccount.Login"] = "Login",

["Auth:Errors.Error"] = "An error occurred",
["Auth:Messages.FillAllFields"] = "Please fill in all fields",
["Auth:Messages.AccountCreated"] = "Account created successfully",
["Auth:Messages.InvalidOldPassword"] = "Invalid old password",
["Auth:Messages.InvalidPassword"] = "Invalid password",
["Auth:Messages.InvalidUsernameOrPassword"] = "Invalid username or password",
["Auth:Messages.InvalidUserOrApp"] = "Invalid user ID or app name",
["Auth:Messages.InvalidUser"] = "Invalid user ID",
["Auth:Messages.NoValidUsers"] = "No valid users found",
["Auth:Messages.UsernameExists"] = "Username already exists",
["Auth:Messages.UpdatedSuccessfully"] = "Updated successfully",
["Auth:Messages.AllFieldsRequired"] = "All fields are required",
["Auth:Messages.DifferentPassword"] = "Passwords do not match",
["Auth:Messages.Logout"] = "You have been logged out of the app due to login on another device.",

{% endtab %} {% endtabs %} ### Localization for Other Languages To support other languages, repeat this process by creating or editing the corresponding locale file (e.g., `locale/fr.lua`) and adding the same keys with their appropriate localized values. # Battery System This page describes how to enable and configure battery system ## Installation {% stepper %} {% step %} ### Enable battery system in config 1. Open `configs/Config.lua` 2. Set `Config.BatterySystem = true` {% endstep %} {% step %} ### Add required items Next step is to add 3 new default items `powerbank_small`, `powerbank`, `powerbank_pro` in your inventory. {% tabs %} {% tab title="qb-core" %} 1. Go to your qb-core folder. 2. Open the file: /shared/items.lua 3. Scroll to the end of the file. 4. Before the closing } add the following code: ```lua ["powerbank_small"] = { name = 'powerbank_small', label = 'Small Powerbank', weight = 700, type = 'item', image = 'powerbank_small.png', unique = true, useable = false, shouldClose = false, description = 'A compact powerbank, fits right in your pocket.' }, ["powerbank"] = { name = 'powerbank', label = 'Powerbank', weight = 700, type = 'item', image = 'powerbank.png', unique = true, useable = false, shouldClose = false, description = 'A reliable powerbank to keep your devices charged on the go.' }, ["powerbank_pro"] = { name = 'powerbank_pro', label = 'Powerbank Pro', weight = 700, type = 'item', image = 'powerbank_pro.png', unique = true, useable = false, shouldClose = false, description = 'High-capacity powerbank for those who never want to run out of juice.' }, ``` {% endtab %} {% tab title="esx default" %} 1. Run this SQL query in your database: ```sql INSERT IGNORE INTO `items` (`name`, `label`, `weight`, `rare`, `can_remove`) VALUES ('powerbank_small', 'Small Powerbank', 1, 0, 1), ('powerbank', 'Normal Powerbank', 1, 0, 1), ('powerbank_pro', 'Powerbank Pro', 1, 0, 1), ('powerbank_small_discharged', 'Discharged Small Powerbank', 1, 0, 1), ('powerbank_discharged', 'Discharged Normal Powerbank', 1, 0, 1), ('powerbank_pro_discharged', 'Discharged Powerbank Pro', 1, 0, 1); ``` {% endtab %} {% tab title="ox inventory" %} 1. Go to your ox\_inventory folder. 2. open the file: `/data/items.lua` 3. Scroll to the end of the file. 4. Before the closing } add the following code: ```lua ['powerbank_small'] = { label = 'Small Powerbank', weight = 150, client = { image = 'powerbank_small.png', }, server = { export = '17mov_Phone.powerbank_small' }, consume = 0, stack = false }, ['powerbank'] = { label = 'Powerbank', weight = 150, client = { image = 'powerbank.png', }, server = { export = '17mov_Phone.powerbank' }, consume = 0, stack = false }, ['powerbank_pro'] = { label = 'Powerbank Pro', weight = 150, client = { image = 'powerbank_pro.png', }, server = { export = '17mov_Phone.powerbank_pro' }, consume = 0, stack = false }, ``` {% endtab %} {% endtabs %} {% endstep %} {% step %} ### Installing images into your inventory system Inside the resource you will find: `installation/images` This folder contains example icons meant for integration with the inventory system used on your server (e.g., qb-inventory, ox\_inventory, etc.). **Steps:** 1. Copy all powerbank images from the `installation/images` folder. 2. Paste them into the assets folder of your inventory system, for example: | qb-inventory | ox\_inventory | ps-inventory | esx\_inventory | | ---------------- | ------------- | ------------ | --------------- | | /html/images | /web/images | /html/images | /html/img/items | | {% endstep %} | | | | | {% endstepper %} | | | | After these steps, battery system should be working. You can configure everything related to Battery System inside `configs/Config.lua`, including custom powerbanks, battery lifespan and more. ## Exports ### Server #### ToggleCharging Toggles charging phone with active number **params:**

Argument	Type	Optional	Explanation
`src`	`number`	❌	The player's server ID (source).
`state`	`boolean`	❌	Set true to start chargingg, false to stop charging
`chargeValue`	`number`	✅	How fast phone will be charged (default 10000)

# FAQ This page answers the most common questions about the script.

Error when converting videos on Music App

if you experience sserver errors when trying to convert music from youtube, it would require you to add your cookies to config. Follow these steps:\ 1\. Open Google Chrome\ 2\. Add extension Get cookies.txt LOCALLY to your browser\ 3\. Open youtube with your account logged in\ 4\. Click on the extension, and then click export\ 5\. Change name of the downloaded file to cookies.txt\ 6\. Drop the file to `17mov_Phone/configs`\ 7\. In `configs/ApiKeys.lua` set `API.CookieFile` to `API.CookieFile = "configs/cookies.txt"` \ 8\. Restart your server After completing these steps, the music app should work as intended. However, you may need to repeat them occasionally, as cookies can expire over time.

# How to Install? The script is drag & drop if you're using ESX or QBCore. The only thing you must do is disable or remove old scripts from your server: #### QBCore * `qb-loading` * `qb-multicharacter` * `qb-spawn` * `qb-clothing` #### ESX * `esx_multicharacter` * `esx_identity` * `esx_skin` * `esx_loadingscreen` * `skinchanger` * `illenium-appearance` (\*) ## ⚠️ **Important:** These scripts cannot run at the same time as this system.\ If they are active, you will get problems like broken skins, overlapping menus, and other conflicts. {% hint style="info" %} You can still use **Illenium Appearance or above scripts**, but only if in `Configs/skin.lua` → `Skin.Enabled = false`. {% endhint %} # Missing Photos? This script comes with a feature called **Photos Generation Tool**. The tool allows you to automatically generate and save pictures of all clothes that exist on your server. If you use addon or replace clothes on your server, it is necessary to run this tool to make sure the pictures display correctly in the skin menu.

Example of the menu without generated pictures

Example of the menu with generated pictures

*** To run the tool, use the command `/photos` or use one of these methods: * **With event**: `17mov_CharacterSystem:OpenClothesPhotos` * **With export**: `exports["17mov_CharacterSystem"]:OpenClothesPhotos()` ## Main Menu The main menu looks like this:

To start, press **Start**, then wait around **10–30 minutes** *(time depends on amount of addon clothes)* for the system to take pictures of all clothes and props. ### Console Output During Work While the tool is running, the server console will show information about the status of saving pictures. ```markdown [script:17mov_Charact] [INFORMATION]: Saved photo. Model: mp_m_freemode_01, component: torso_1, drawable: 49 [script:17mov_Charact] [INFORMATION]: Saved photo. Model: mp_m_freemode_01, component: torso_1, drawable: 50 [script:17mov_Charact] [INFORMATION]: Saved photo. Model: mp_m_freemode_01, component: torso_1, drawable: 51 [script:17mov_Charact] [INFORMATION]: Saved photo. Model: mp_m_freemode_01, component: torso_1, drawable: 52 [script:17mov_Charact] [INFORMATION]: Saved photo. Model: mp_m_freemode_01, component: torso_1, drawable: 53 [script:17mov_Charact] [INFORMATION]: Saved photo. Model: mp_m_freemode_01, component: torso_1, drawable: 54 [script:17mov_Charact] [INFORMATION]: Saved photo. Model: mp_m_freemode_01, component: torso_1, drawable: 55 [script:17mov_Charact] [INFORMATION]: Saved photo. Model: mp_m_freemode_01, component: torso_1, drawable: 56 ``` # FAQ This page answers the most common questions about the script.

Can I use the menu without photos?

Yes, if you want to use arrow inputs instead of photos, just delete all pictures from the folder: `/web/photos/` and script will automatically switch to arrow mode.

Can I use another skin system or spawn selector?

Yes, that's why we designed Character System resource as "modular". There is a few modules, that you can disable: ``` - Location Selector - Register Menu - Character Selector - Skin System ``` Each of this module can be disabled and replaced by some another resource. To disable specified module just go to their config file and set `Module.Enabled = false`. For ex. if you want to disable *Location Selector* open `/configs/Location.lua` file, at very top you should see `Location.Enabled = true`, so to disable it just set: `Location.Enabled = false`. After this Location module will be disabled {% hint style="info" %} In case of Loadingscreen replace, you would need to navigate into fxmanifest.lua and delete those lines: {% endhint %} ``` loadscreen "web/index.html" loadscreen_manual_shutdown "yes" loadscreen_cursor "yes" ```

Can I limit character slots for players?

### **Yes, You can limit character slots in two ways:** #### Checking the player's Discord role: To do this, you first need to configure `configs/Discord.lua` and add the IDs of your Discord roles. Then, you can set how many character slots each role should have. ```lua Selector.Discord = { Enable = true, -- Should enable system? Token = "enter_your_discord_bot_token_here", -- Discord Bot token (bot must be on guild) Guild = "enter_your_guild_id_here", -- DiscordId of your server guild Roles = { -- There you can add roles and assign number of characters -- ["DISCORD_ID_OF_ROLE"] = NUMBER_OF_CHARACTERS, -- Template -- ["1111774118820446259"] = 10, -- Example } } ``` #### Adding player identifiers manually in the config You can also assign the number of character slots **manually** based on the player’s identifier.\ All identifiers supported by **FiveM** are supported here, for example: `discord`, `steam`, `ip`, etc. ```lua Selector.PlayerMaxCharacters = { ["license:xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx"] = 5, } ``` #### The default ESX `multicharacter_slots` database table is also supported.

Can I block specific clothes or reserve them for players?

**Yes, you can completely disable a specific clothing item in:** `Configs/Skin.lua → Skin.BlacklistedInputValues`: ```lua Skin.BlacklistedInputValues = { -- Here you can blacklist some clothes (inputs values) [`mp_m_freemode_01`] = { ["tshirt_1"] = { 15, 16, 17 }, }, } ``` This will block the clothing item for everyone. Then, you can reserve the blocked item for: * A single player * A specific job * A gang in: `Configs/Skin.lua → Skin.WhitelistedInputValues`: ```lua Skin.WhitelistedInputValues = { [`mp_m_freemode_01`] = { { name = "tshirt_1", values = { 15, 16 }, jobs = { "police" }, gangs = { "ballas" }, identifiers = { "license:8cbd53588ae8a50cf28da72afa411ca2453fde40" } }, }, } ```

# Common Issues On this page, you will find the most common errors and their solutions. If your issue is not listed here, or you still have trouble fixing it, please join our Discord where you can get more help

Missing Clothing / Missing Photos

If a clothing item does not show up in the menu at all, this is not an issue with our menu but with the clothing itself - if the clothing works, it **will be automatically added** to the menu. {% hint style="info" %} For problems with clothing functionality, please contact the **clothing creators**, not us. {% endhint %} If the clothing **shows up but has no picture**, check the guide in the [**"Missing Photos?"**](/character-system/missing-photos) section.

Missing Faces

In GTA natives, the logic for faces works like this: * **0–21** → Male faces * **21–45** → Female faces Some other menus break this logic. They allow you to pick, for example, two female faces at the same time. This makes no sense, because you can only set female once and then adjust `shapeMix` fully to the mother to get the same result. In our system, we decided to **split the 45 faces into male and female** groups. {% hint style="info" %} If you don’t like this and want it to work like in other menus, you just need to replace the Skin.FemaleFaceTranslations and Skin.MaleFaceTranslations from Configs/Skin.lua to this: {% endhint %}

Skin.FemaleFaceTranslation = {
    [0] = 0,
    [1] = 1,
    [2] = 2,
    [3] = 3,
    [4] = 4,
    [5] = 5,
    [6] = 6,
    [7] = 7,
    [8] = 8,
    [9] = 9,
    [10] = 10,
    [11] = 11,
    [12] = 12,
    [13] = 13,
    [14] = 14,
    [15] = 15,
    [16] = 16,
    [17] = 17,
    [18] = 18,
    [19] = 19,
    [20] = 20,
    [21] = 21,
    [22] = 22,
    [23] = 23,
    [24] = 24,
    [25] = 25,
    [26] = 26,
    [27] = 27,
    [28] = 28,
    [29] = 29,
    [30] = 30,
    [31] = 31,
    [32] = 32,
    [33] = 33,
    [34] = 34,
    [35] = 35,
    [36] = 36,
    [37] = 37,
    [38] = 38,
    [39] = 39,
    [40] = 40,
    [41] = 41,
    [42] = 42,
    [43] = 43,
    [44] = 44,
    [45] = 45,
}

Skin.MaleFaceTranslation = {
    [0] = 0,
    [1] = 1,
    [2] = 2,
    [3] = 3,
    [4] = 4,
    [5] = 5,
    [6] = 6,
    [7] = 7,
    [8] = 8,
    [9] = 9,
    [10] = 10,
    [11] = 11,
    [12] = 12,
    [13] = 13,
    [14] = 14,
    [15] = 15,
    [16] = 16,
    [17] = 17,
    [18] = 18,
    [19] = 19,
    [20] = 20,
    [21] = 21,
    [22] = 22,
    [23] = 23,
    [24] = 24,
    [25] = 25,
    [26] = 26,
    [27] = 27,
    [28] = 28,
    [29] = 29,
    [30] = 30,
    [31] = 31,
    [32] = 32,
    [33] = 33,
    [34] = 34,
    [35] = 35,
    [36] = 36,
    [37] = 37,
    [38] = 38,
    [39] = 39,
    [40] = 40,
    [41] = 41,
    [42] = 42,
    [43] = 43,
    [44] = 44,
    [45] = 45,
}

Addon Faces

If you're using addon Faces, you need to manually add them into `Skin.FemaleFaceTranslation` and `Skin.MaleFaceTranslation`. This both tables tell script which face should be on which slot for specified sex. Keys are value being displaied into menu and values are numbers from game. So for example: ``` Skin.FemaleFaceTranslation = { -- Face "21" from game will be displaied as 0 into menu for female characters [0] = 21, } ``` **If you're using the popular ONX Faces, they're supported out of the box, no configuration needed (Skin.EnableONXCustomFaces setting)**

Cannot Delete Character (error in server console)

If you see this error in the console when deleting a character, that means you missed some steps when installing your custom phone resource

Easiest way to fix this issue, is just remove phone tables from `qb-core/server/player.lua` and playertables table (around line 526). Replace this: ```lua local playertables = { -- Add tables as needed { table = 'players' }, { table = 'apartments' }, { table = 'bank_accounts' }, { table = 'crypto_transactions' }, { table = 'phone_invoices' }, { table = 'phone_messages' }, { table = 'playerskins' }, { table = 'player_contacts' }, { table = 'player_houses' }, { table = 'player_mails' }, { table = 'player_outfits' }, { table = 'player_vehicles' } } ``` With this: ```lua local playertables = { -- Add tables as needed { table = 'players' }, { table = 'apartments' }, { table = 'bank_accounts' }, { table = 'crypto_transactions' }, { table = 'playerskins' }, { table = 'player_contacts' }, { table = 'player_houses' }, { table = 'player_mails' }, { table = 'player_outfits' }, { table = 'player_vehicles' } } ``` #### ⚠️ This will solve issue with deleting character, but may cause problems with your phone resource. For more specific instructions please contact your phone provider

Video on loading screen is not working

If you configured the **loading screen** correctly but the `.mp4` file is still not showing, this may be caused by two reasons: * **Render errors** – try re-rendering the file again in `.mp4` format * **File size too large** – try compressing your video so that its size is **less than 100 MB** Sometimes FiveM internal http server causes weird problems with serving large files. You can try to upload your video to some external cloud services like [FiveManage ](https://fivemanage.com/)or [Cloudflare R2](https://www.cloudflare.com/developer-platform/products/r2)

Interior Not Loading

If you are seeing interior failing to load while selecting characters, please check `configs/Selector.lua` and ensure that `Selector.RefreshInterior` is set to `true`. If that does not fix the issue, you will need to modify default fivem spawn points using instruction below: 1. Navigate to your server's **resources** folder and locate the default map path, which is typically `resources/[cfx-default]/[gamemodes]/[maps]`. 2. Find the two specific resource folders named `fivem-map-hipster` and `fivem-map-skater`. 3. Inside each of these folders, locate and open the file named `map.lua`. 4. Delete all of the existing code within `map.lua` and replace it entirely with the following configuration: ``` 'a_m_y_hipster_02' { x = -827.42388916016, y = -730.15417480469, z = 108.13386535645 } ``` 5. Restart your server. Now your problem should be gone

# Exports/Events ## Base Usage Our script is designed to be **drag-and-drop**. This also means that all **events** and **exports** are bridged from the following resources: * `esx_skin` * `skinchanger` * `qb-clothing` * `illenium-appearance` So you can still use events like: ```lua TriggerEvent('skinchanger:loadSkin') ``` and all others as usual. *** ⚠️ **Important**:\ When using exports for **illenium-appearance**, you must still use `illenium-appearance` as the resource name, **not** `17mov_CharacterSystem`. {% columns %} {% column width="50%" valign="middle" %} ✅ Correct: ```lua exports["illenium-appearance"]:setPedComponents() ``` {% endcolumn %} {% column width="50%" %} ❌ Incorrect: ```lua exports["17mov_CharacterSystem"]:setPedComponents() ``` {% endcolumn %} {% endcolumns %} *** For more details, check the documentation of: * [**qb-clothing**](https://docs.qbcore.org/qbcore-documentation/qbcore-resources/qb-clothing) * [**illenium-appearance**](https://docs-illenium-dev-phem.vercel.app/free-resources/illenium-appearance/intro/#features) * [**skinchanger**](https://docs.esx-framework.org/en/esx_core/skinchanger) ## EXAMPLES Below you can find examples of events/exports that will work with our resource {% code title="SAVING CURRENT SKIN EVENT (CLIENT SIDE)" %} ```lua TriggerEvent("17mov_CharacterSystem:SaveCurrentSkin") ``` {% endcode %} {% code title="ESX VERSION OF OPENING WARDROBE / OUTFITS MENU (CLIENT SIDE)" %} ```lua TriggerEvent("17mov_CharacterSystem:OpenOutfitsMenu") ``` {% endcode %} {% code title="QBCORE VERSION OF OPENING WARDROBE / OUTFITS (CLIENT SIDE)" %} ```lua TriggerEvent("qb-clothing:client:openOutfitMenu") ``` {% endcode %} {% code title="ESX VERSION OF OPENING SKIN MENU (CLIENT SIDE)" %} ```lua TriggerEvent("qb-clothing:client:openMenuCommand") ``` {% endcode %} {% code title="QBCORE VERSION OF OPENING SKIN MENU (CLIENT SIDE)" %} ```lua TriggerEvent("esx_skin:openSaveableMenu") ``` {% endcode %} # Overview ## Introduction Introducing our groundbreaking Advanced HUD script for your servers! :bulb: Modern aesthetics, extensive player customization options, and top-tier optimization - these are the essentials your server needs to stand out in the FiveM community. Our latest HUD script is a perfect blend of style, functionality, and performance, designed to enhance the gaming experience for both ESX and QBCore servers. Dive into the details below and discover how our script can transform your server into a more engaging, personalized, and efficient gaming hub!

# Usage in other resources ## Toggle Display You can toggle display of whole HUD if you need this (ex. in clothing shop).

-- With export
exports["17mov_Hud"]:ToggleDisplay(state)

-- With client event
TriggerEvent("17mov_Hud:ToggleDisplay", state)

Argument	Type	Optional	Default Value	Explanation	Type	Explanation	Optional	Default
state	boolean	❌	-	Is HUD should be displayied?	boolean	Should display or not?	❌

## Hide Radar You can force rader to be hidden, no matter of player settings.

exports["17mov_Hud"]:HideRadar(state)

Argument	Type	Optional	Default Value	Explanation	Type	Explanation	Optional	Default
state	boolean	❌	-	Is radar should be hidden?	boolean	Should display or not?	❌

## Notification It's showing new notification ```lua -- With export exports["17mov_Hud"]:ShowNotification(text, type, title, time) -- With client event TriggerEvent("17mov_Hud:ShowNotification", text, type, title, time) ```

Argument	Type	Optional	Default Value	Explanation	Type	Explanation
text	string	❌	-	Text of notification	string: any	The text of notification
type	"info" \| "error" \| "success"	✅	"info"	Type of notification	string: "info" \| "error" \| "success"	Type of notification
title	string	✅	Config.Lang["DefaultNotification"]	Title of notification	string: any	The title of notification
time	number	✅	string.len(text) * 0.09 + 2000	Time of displaying notification (in miliseconds)

## Help Notification It's start showing of Help Notification. You can use controls like `~INPUT_CONTEXT~` and colors like `~g~` {% hint style="warning" %} **It should be used without any loop!** Later you can need to hide it with `HideHelpNotification()` {% endhint %} ```lua -- With export exports["17mov_Hud"]:ShowHelpNotification(text) -- With client event TriggerEvent("17mov_Hud:ShowHelpNotification", text) ``` | Argument | Type | Optional | Default Value | Explanation | | -------- | ------ | -------- | ------------- | ------------------------- | | text | string | :x: | - | Text of help notification | ## Hide Help Notification When you first use `ShowHelpNotification()` then you need to hide it with this function. ```lua -- With export exports["17mov_Hud"]:HideHelpNotification() -- With client event TriggerEvent("17mov_Hud:HideHelpNotification") ``` ## Help Notification (while) There is also avabile version of Help Notification to use into while loops. It's hiding automatically when stop hooking. ```lua -- With export exports["17mov_Hud"]:ShowHelpNotificationWhile(text) -- With client event TriggerEvent("17mov_Hud:ShowHelpNotificationWhile", text) ``` | Argument | Type | Optional | Default Value | Explanation | | -------- | ------ | -------- | ------------- | ------------------------- | | text | string | :x: | - | Text of help notification | ## Progress Bar Starting new progress bar ```lua -- With export exports["17mov_Hud"]:StartProgress(action, onStart, onTick, onFinish) -- With client event TriggerEvent("17mov_Hud:StartProgress", action, onStart, onTick, onFinish) ``` | Argument | Type | Optional | Default Value | Explanation | | -------- | -------- | -------------------- | ------------- | -------------------------------------------------------------------------------------------------------- | | action | object | :white\_check\_mark: | - | Look bellow | | onStart | function | :white\_check\_mark: | - | It will be hooked when progress is starting | | onTick | function | :white\_check\_mark: | - | Hooked every frame of progress | | onFinish | function | :white\_check\_mark: | - | Hooked when progress has been ended. Returns wasCanceled which are talking is progress has been canceled | #### Argument action object with default values ```lua local action = { duration = 0, -- Type: number (Progress bar time (in ms)) label = "", -- Type: string (Progress bar text) useWhileDead = false, -- Type: boolean (Can be used while player is dead?) canCancel = true, -- Type: boolean (Is can be canceled?) controlDisables = { -- If you want to disable some controls set it here disableMovement = false, -- Type: boolean (Disable movement controls?) disableCarMovement = false, -- Type: boolean (Disable car movement controls?) disableMouse = false, -- Type: boolean (Disable mouse controls?) disableCombat = false, -- Type: boolean (Disable combat controls?) }, animation = { -- Here you can play some animation/scenario animDict = nil, -- Type: string (Animation dict) anim = nil, -- Type: string (Animation name) flags = 0, -- Type: number (Animation flags) task = nil, -- Type: string (Scenario name) }, prop = { -- Spawning prop for progress bar model = nil, -- Type: number (Model hash) bone = nil, -- Type: string (Bone name) coords = vec3(0.0, 0.0, 0.0), -- Type: vector3 (Attachment offsets coords) rotation = vec3(0.0, 0.0, 0.0), -- Type: vector3 (Attachment rotation) }, propTwo = { -- Spawning prop for progress bar if you need two props model = nil, -- Type: number (Model hash) bone = nil, -- Type: string (Bone name) coords = vec3(0.0, 0.0, 0.0), -- Type: vector3 (Attachment offsets coords) rotation = vec3(0.0, 0.0, 0.0), -- Type: vector3 (Attachment rotation) }, } ``` ## Stop Progress With this function you can stop progress bar in any moment. Then onFinish will return false. ```lua -- With export exports["17mov_Hud"]:StopProgress() -- With client event TriggerEvent("17mov_Hud:StopProgress") ``` ## Open Settings You can open HUD Settings using: ```lua -- With export exports["17mov_Hud"]:OpenSettings() -- With client event TriggerEvent("17mov_Hud:OpenSettings") ``` ## Getting HUD colors You can get current HUD colors as HEX codes to use them for ex. in chat to made everyting fits. ```lua -- With export exports["17mov_Hud"]:GetTheme(function(theme) -- local lightmode = theme['dark'] -- print("Lightmode - Primary color:", lightmode['--color-primary']) -- print("Lightmode - Secondary color:", lightmode['--color-secondary']) -- print("Lightmode - Text Primary color:", lightmode['--color-text-primary']) -- print("Lightmode - Text Secondary color:", lightmode['--color-text-secondary']) -- print("Lightmode - Transparent color:", lightmode['--color-transparent']) -- local darkmode = theme['dark'] -- print("Darkmode - Primary color:", darkmode['--color-primary']) -- print("Darkmode - Secondary color:", darkmode['--color-secondary']) -- print("Darkmode - Text Primary color:", darkmode['--color-text-primary']) -- print("Darkmode - Text Secondary color:", darkmode['--color-text-secondary']) -- print("Darkmode - Transparent color:", darkmode['--color-transparent']) end) -- With client event TriggerEvent("17mov_Hud:GetTheme", function(theme) -- local lightmode = theme['dark'] -- print("Lightmode - Primary color:", lightmode['--color-primary']) -- print("Lightmode - Secondary color:", lightmode['--color-secondary']) -- print("Lightmode - Text Primary color:", lightmode['--color-text-primary']) -- print("Lightmode - Text Secondary color:", lightmode['--color-text-secondary']) -- print("Lightmode - Transparent color:", lightmode['--color-transparent']) -- local darkmode = theme['dark'] -- print("Darkmode - Primary color:", darkmode['--color-primary']) -- print("Darkmode - Secondary color:", darkmode['--color-secondary']) -- print("Darkmode - Text Primary color:", darkmode['--color-text-primary']) -- print("Darkmode - Text Secondary color:", darkmode['--color-text-secondary']) -- print("Darkmode - Transparent color:", darkmode['--color-transparent']) end) ``` Or you can also obtain colors with every update from settings with: ```lua RegisterNetEvent("17mov_Hud:UpdateTheme", function(theme) -- local lightmode = theme['dark'] -- print("Lightmode - Primary color:", lightmode['--color-primary']) -- print("Lightmode - Secondary color:", lightmode['--color-secondary']) -- print("Lightmode - Text Primary color:", lightmode['--color-text-primary']) -- print("Lightmode - Text Secondary color:", lightmode['--color-text-secondary']) -- print("Lightmode - Transparent color:", lightmode['--color-transparent']) -- -- local darkmode = theme['dark'] -- print("Darkmode - Primary color:", darkmode['--color-primary']) -- print("Darkmode - Secondary color:", darkmode['--color-secondary']) -- print("Darkmode - Text Primary color:", darkmode['--color-text-primary']) -- print("Darkmode - Text Secondary color:", darkmode['--color-text-secondary']) -- print("Darkmode - Transparent color:", darkmode['--color-transparent']) end) ``` ## Getting HUD settings You can also get current HUD settings. ```lua -- With export exports["17mov_Hud"]:GetSettings(function(settings) -- print(settings) end) -- With client event TriggerEvent("17mov_Hud:GetSettings", function(settings) -- print(settings) end) ``` You can also obtain settings with every update: ```lua RegisterNetEvent("17mov_Hud:UpdateSettings", function(settings) -- print(settings) end) ``` # Custom Indicators Our HUD allows you to easily extend its functionality by registering your own components, such as a stamina bar, a job label, or even a cryptocurrency tracker. ### 1. RegisterComponent Use this export to initialize a new element on the HUD. You can choose between a status type (circle near health, armour etc.) or a card type (for text and labels by default in top right). {% code overflow="wrap" lineNumbers="true" %} ```lua exports["17mov_Hud"]:RegisterComponent(componentName, componentData) ``` {% endcode %} Parameters: * `componentName` (string): A unique identifier for your component. * `componentData` (table): A configuration table containing: * `type`: The style of the component (`"status"` or `"card"`). * `label`: The text displayed on the component. * `icon`: A table containing `type` (`"svg"` or `"image"`) and the `data` (SVG string or file path). * `position`: A table with `x` and `y` coordinates (from 0.0 to 1.0). ### 2. UpdateComponentValue This export is used to dynamically update the data or progress of an existing component. ```lua exports["17mov_Hud"]:UpdateComponentValue(name, value) ``` Parameters: * `name` (string): The unique name of the component you wish to update. * `value` (any): The new value. * For status types, this is typically a float between `0.0` and `1.0`. * For card types, this can be any string or number value ### 3. ToggleComponentVisibility Allows you to show or hide a specific component based on game events (e.g., hiding the stamina bar when the player is in a vehicle). ```lua exports["17mov_Hud"]:ToggleComponentVisibility(name, value) ``` Parameters: * `name` (string): The unique name of the component. * `value` (boolean): Set to `true` to show the component, or `false` to hide it. ### 4. Integration Examples Below you can find a professional implementation of a Stamina status bar and a Job Information card. ```lua CreateThread(function() -- Registration: Stamina Component (Status Type) -- Displays a circular progress for the player's stamina exports["17mov_Hud"]:RegisterComponent("stamina", { type = "status", icon = { type = "svg", data = [[]], }, }) -- Registration: Job Component (Card Type) -- Displays a static or dynamic label for the player's current occupation exports["17mov_Hud"]:RegisterComponent("job_info", { type = "card", label = "Current Job", icon = { type = "svg", data = [[]], }, position = { x = 0.5, y = 0.5 }, }) exports["17mov_Hud"]:UpdateComponentValue("job_info", "Unemployed") while true do Wait(500) local exhaustionPercent = GetPlayerSprintStaminaRemaining(PlayerId()) local remainingStamina = (100.0 - exhaustionPercent) / 100.0 exports["17mov_Hud"]:UpdateComponentValue("stamina", remainingStamina) end end) ``` # Installation Guide This script was made to be **as simple as possible** to install on your server. The installation has only **one step**: adding the items to your framework (and optional images to your inventory).\ Everything you need is already included in the script files. *** ### Step 1: Copy Images (Optional) Copy the content from the folder: `installation/images`, paste it into the `images` folder of your inventory system. \ Below you can find the most common paths for popular inventory systems. If you use another system, the path should be similar. If you cannot find it, ask your inventory provider. | qb-inventory | ox\_inventory | ps-inventory | esx\_inventory | | ------------ | ------------- | ------------ | --------------- | | /html/images | /web/images | /html/images | /html/img/items | *** ### Step 2: Add Items to Your Framework Now you need to add the items. Below are instructions for **QBX**, **QBCore**, and **es\_extended**. If you are using **es\_extended** or a **custom inventory system**, installation can be different. Please ask your inventory provider how to add new items. {% tabs %} {% tab title="QBCore" %} 1. Go to your `qb-core` folder. 2. Open the file: `/shared/items.lua` 3. Scroll to the **end of the file**. 4. Before the closing `}` add the following code: ```lua ['mov_basic_wax'] = { ['name'] = 'mov_basic_wax', ['label'] = 'Basic Wax', ['weight'] = 10, ['type'] = 'item', ['image'] = 'mov_basic_wax.png', ['unique'] = false, ['useable'] = true, ['shouldClose'] = true, ['description'] = 'After application on the car, the car is resistant to external dirt, such as driving on unpaved roads, etc. It will still get dirty, but much more slowly. It lasts about 3 days on the car, after which time reapplication is required to maintain the effect.'}, ['mov_advanced_ceramic'] = { ['name'] = 'mov_advanced_ceramic', ['label'] = 'Premium Ceramic', ['weight'] = 10, ['type'] = 'item', ['image'] = 'mov_advanced_ceramic.png', ['unique'] = false, ['useable'] = true, ['shouldClose'] = true, ['description'] = 'After application on the car, dirt does not stick to the bodywork at all, so at the car wash, it only needs to be rinsed off. It lasts about 7 days on the car, after which time reapplication is required to maintain the effect.'}, ['mov_advanced_wax'] = { ['name'] = 'mov_advanced_wax', ['label'] = 'Advanced Wax', ['weight'] = 10, ['type'] = 'item', ['image'] = 'mov_advanced_wax.png', ['unique'] = false, ['useable'] = true, ['shouldClose'] = true, ['description'] = 'After application on the car, the car is highly resistant to external dirt, such as driving on unpaved roads, etc. It will still get dirty, but much more slowly. It lasts about 7 days on the car, after which time reapplication is required to maintain the effect.'}, ['mov_basic_ceramic'] = { ['name'] = 'mov_basic_ceramic', ['label'] = 'Basic Ceramic', ['weight'] = 10, ['type'] = 'item', ['image'] = 'mov_basic_ceramic.png', ['unique'] = false, ['useable'] = true, ['shouldClose'] = true, ['description'] = 'After application on the car, dirt does not stick to the bodywork, making it much easier to wash off at the car wash. It lasts about 3 days on the car, after which time reapplication is required to maintain the effect.'}, ``` {% endtab %} {% tab title="QBX\_Core" %} 1. Go to your `qbx-core` folder. 2. Open the file: `/shared/items.lua` 3. Scroll to the **end of the file**. 4. Before the closing `}` add the following code: ```lua ['mov_basic_wax'] = { ['name'] = 'mov_basic_wax', ['label'] = 'Basic Wax', ['weight'] = 10, ['type'] = 'item', ['image'] = 'mov_basic_wax.png', ['unique'] = false, ['useable'] = true, ['shouldClose'] = true, ['description'] = 'After application on the car, the car is resistant to external dirt, such as driving on unpaved roads, etc. It will still get dirty, but much more slowly. It lasts about 3 days on the car, after which time reapplication is required to maintain the effect.'}, ['mov_advanced_ceramic'] = { ['name'] = 'mov_advanced_ceramic', ['label'] = 'Premium Ceramic', ['weight'] = 10, ['type'] = 'item', ['image'] = 'mov_advanced_ceramic.png', ['unique'] = false, ['useable'] = true, ['shouldClose'] = true, ['description'] = 'After application on the car, dirt does not stick to the bodywork at all, so at the car wash, it only needs to be rinsed off. It lasts about 7 days on the car, after which time reapplication is required to maintain the effect.'}, ['mov_advanced_wax'] = { ['name'] = 'mov_advanced_wax', ['label'] = 'Advanced Wax', ['weight'] = 10, ['type'] = 'item', ['image'] = 'mov_advanced_wax.png', ['unique'] = false, ['useable'] = true, ['shouldClose'] = true, ['description'] = 'After application on the car, the car is highly resistant to external dirt, such as driving on unpaved roads, etc. It will still get dirty, but much more slowly. It lasts about 7 days on the car, after which time reapplication is required to maintain the effect.'}, ['mov_basic_ceramic'] = { ['name'] = 'mov_basic_ceramic', ['label'] = 'Basic Ceramic', ['weight'] = 10, ['type'] = 'item', ['image'] = 'mov_basic_ceramic.png', ['unique'] = false, ['useable'] = true, ['shouldClose'] = true, ['description'] = 'After application on the car, dirt does not stick to the bodywork, making it much easier to wash off at the car wash. It lasts about 3 days on the car, after which time reapplication is required to maintain the effect.'}, ``` {% endtab %} {% tab title="Default ESX" %} 1. Run this SQL query in your database: ```sql INSERT IGNORE INTO `items` (`name`, `label`, `weight`, `rare`, `can_remove`) VALUES ('mov_advanced_ceramic', 'Premium Ceramic', 10, 0, 1), ('mov_advanced_wax', 'Advanced Wax', 10, 0, 1), ('mov_basic_ceramic', 'Basic Ceramic', 10, 0, 1), ('mov_basic_wax', 'Basic Wax', 10, 0, 1) ; ``` {% endtab %} {% endtabs %} *** ### ⚠️ Map Conflicts If you are using **custom maps**, you might experience some problems.\ We explain more about this in the next chapter. # MLO Problems Because there are many different maps you can install on your server, there is a high chance you may have **conflicts**. This is **not a problem with our map**. It usually happens because of **duplicate files** on your server.

*** ## What is a Conflict? Sometimes addon maps, even if they are in **different locations**, share the **same files**. Unfortunately, FiveM cannot load multiple copies of the same streamed files. The way FiveM decides which file to use is **alphabetical order**: > Last file loaded wins. If FiveM does not load one of our files (because another file with the same name was already loaded), you may see problems such as: * Flickering buildings * Collision issues * Missing or broken map parts *** ## How to Fix This? There is no universal fix, because **every server is using different maps and has different conflicts**.\ But here are two possible solutions you can try: ### Solution 1: Manual Conflict Fix The idea is simple, find the **duplicate files** and manually **merge them**. 1. Use our automatic conflict scanner. It will show you which files are duplicated automatically after your server starts *(see example below)*

This image is only an example, by default 17mov_GarbaceCollector does not conflicts with 17mov_VehicleDirtSystem

2. Once you know the files, follow [the tutorial made by our partners NT**eam**](https://www.youtube.com/watch?v=XR9oRhCXdxU). They explain step by step how to merge two files into one *** ### Solution 2: Use 17 Movement Conflict Tool You can also use our **Conflict Tool**, which automatically finds and helps fix map conflicts on your server. You can check it out [here](https://17movement.net/products/17mov-conflict-tool). # How To Remove Stations If you don’t want to use one of the included car wash locations, you can **easily remove it**. Here is how to do it ### Step 1: Remove Files from the `stream` Folder Check the table below to see **which files** belong to the car wash you want to remove. Delete those files from your `stream` folder.

*** ### Step 2: Update the Config File After deleting the files, don’t forget to also **remove the car wash** from `Config.Stations` in your `Config.lua` file. And that’s it – the car wash location is now removed. # Managing Stations On this page, we will explain how you can **edit** or **create** a new custom location for your server. You can do this in your `Config.lua` file and `Config.Stations` table. *** ## 1. Location Structure Each location consists of only **3 coordinates** and 3 **values**. This is possible because the system calculates the rest of the needed coordinates automatically, based on the origin points of the objects listed below.

{
    cable = vec3(175.11, -1738.57458, 33.186),
    nozzle = vec3(174.521362, -1741.59753, 29.78719),
    nozzleRot = vec3(0.0, 45.0, 0.0),
    interface = vec3(177.0171, -1741.91028, 29.8663769),
    interfaceRot = vec3(0.0, 0.0, -90.0),
    cableLength = 5.0  -- Optional. Default is 5.0
    radius = 3.0,
    price = 10,
    requiredJob = nil,
}

*** {% tabs %} {% tab title="Cable" %} Coordinates of the **hose mount point** (bearing). This is the part of the model:

{% endtab %} {% tab title="Nozzle" %} Coordinates of the **resting position of the lance**. This is where players pick up the lance:

{% endtab %} {% tab title="Interface" %} Coordinates of the **interface point**. This is where players **pay** and **start** the car wash:

{% endtab %} {% tab title="Radius" %} Defines how far from the **cable origin point** the hose should be attached. For the default model, this value is always: `3.0` {% endtab %} {% tab title="cableLength" %} Defines the **length of the hose in meters** connecting the mount to the lance. Useful if the mount is **higher than 3.5m** above the lance. This prevents the hose from looking like a stiff line and instead simulates **gravity** in the hose physics. {% endtab %} {% tab title="Price" %} The cost in dollars that a player must pay to wash their vehicle. {% endtab %} {% endtabs %} ### Required Job Requires a **string value**. This defines which **server job** can use the lance. If set to `nil`, then **everyone** on the server can use it. *** ## 2. Adding a New Location To add a new car wash location: 1. Copy the template below. 2. Paste it into the `Config.Stations` table in your config. 3. Fill in the coordinates according to the instructions above. ```lua { cable = vec3(), nozzle = vec3(), nozzleRot = vec3(), interface = vec3(), interfaceRot = vec3(), radius = 3.0, cableLength = 5.0 -- Optional. Default is 5.0 price = 10, requiredJob = nil, } ``` # Understanding Our Structure Welcome to our Multiplayer Jobs documentation! Here, we'll explain the structure of our scripts, which are designed to be flexible and easily customizable to meet your needs. Our scripts consist of several folders and files: #### Web Folder This folder contains all the files related to the User Interface (UI). It's an open-source folder, allowing you to edit and customize the appearance of the scripts as needed. #### Client Folder This folder contains three files: * `client.lua` (encrypted): This file contains the main script code, and it's not accesible * `target.lua` (open-source): In this file, you can connect your target system if your `Config.useTarget` option is set to `true`. * `functions.lua` (open-source): This file contains various functions called at different moments during the game. You can use this file to connect your custom framework, notifications, and adapt the script to your needs. With numerous functions available, you can modify the script even from the backend perspective. #### Server Folder This folder contains: * `server.lua` (encrypted): This file contains the main script code. * `functions.lua` (open-source): Similar to the client-side `functions.lua`, this file contains various functions called at different moments during the game. You can use this file to connect your custom framework, notifications, and adapt the script to your needs. With numerous functions available, you can modify the script even from the backend perspective. #### Config The config file is a crucial part of our scripts, as it contains the most important and fundamental options for customization. These options are often in the form of integer or boolean values, allowing you to easily tailor the script to your specific needs. To modify an option, simply edit the value following the equal sign (=). Each option within the config file is thoroughly described, ensuring a clear understanding of its purpose and functionality. Here's an overview of what you might typically find in a config file: * **Enable/Disable Features**: You can enable or disable certain features by changing their boolean values (true/false). * **Default Values**: Set default values for various parameters, such as the maximum number of players, spawn locations, or job payout amounts. * **Time Settings**: Adjust time-related settings, such as the duration of specific job stages or cooldown periods between tasks. * **UI Customization**: Choose between two styles of UI * **Language Settings**: Define the language for in-game messages and notifications. Remember to save your changes after editing the config file. By carefully adjusting the options in the config file, you can ensure that the script works seamlessly with your FiveM server and provides an optimal experience for your players. ## End words By understanding the structure and organization of our scripts, you can easily customize and adapt them to your server requirements. This flexibility ensures that our Multiplayer Jobs scripts will be a perfect fit for your FiveM server. # Most Used Config Options Welcome to our page dedicated to the most useful options in the Config file! The Config file is an essential part of any FiveM script, as it contains a plethora of settings and variables that determine how your script works. Understanding how to navigate the Config file and make the right adjustments is crucial for a smooth and successful server operation. On this page, we will guide you through some of the most important and valuable options in the Config file that can enhance the gameplay experience for both you and your players. From adjusting vehicle settings to fine-tuning the economy, we have got you covered. By the end of this page, you will have a better understanding of how to customize and optimize your server to create the best possible experience for your community.

Option	Description
`Config.useModernUI`	Enable modern UI for the job system.
`Config.splitReward`	Enable party payout splitting when using old UI.
`Config.UseTarget`	Enable the use of a target system.
`Config.UseBuiltInNotifications`	Use built-in modern notifications.
`Config.RequiredJob`	Set the required job for players to participate.
`Config.RequireJobAlsoForFriends`	Require all party members to have the required job.
`Config.RequireOneFriendMinimum`	Require at least one player to form a team.
`Config.letBossSplitReward`	Enable boss to manage whole party rewards.
`Config.multiplyRewardWhileWorkingInGroup`	Enable reward multiplication based on party size.
`Config.EnableVehicleTeleporting`	Enable vehicle teleportation.
`Config.JobVehicleModel`	Set the model of the company vehicle.
`Config.PenaltyAmount`	Set the penalty amount for finishing work without a company vehicle.
`Config.DontPayRewardWithoutVehicle`	Don't pay rewards to players who finish without a company vehicle.
`Config.DeleteVehicleWithPenalty`	Delete vehicle even if it's not a company vehicle.
`Config.RequireFullJob`	Require players to complete 100% of progress before ending the job.
`Config.RequireWorkClothes`	Require players to wear work clothes.
`Config.RequiredItem`	Set the required item for players to participate.
`Config.RequireItemFromWholeTeam`	Require all party members to have the required item.
`Config.RestrictBlipToRequiredJob`	Hide job blip for players without the required job.
`Config.Blips`	Configure the company blip.
`Config.MarkerSettings`	Configure marker settings.
`Config.Locations`	Change job locations.
`Config.SpawnPoint`	Set the company car spawn point.
`Config.MixerSpawnPoint`	Set the company mixer spawn point.
`Config.EnableCloakroom`	Enable the use of a cloakroom.
`Config.Clothes`	Configure work clothes for male and female characters.
`Config.Lang`	Change translations used in the script. Remember that you also have to translate script in HTML file
`Config.JobBlipsStyle`	Configure job blips.
`Config.Reward`	Set the reward in Gruppe Sechs and Treasure Hunter
`Config.Price`	Set the price per every stop/bag in Deliverer, Garbage Collector, Window Cleaning and Postman
`Config.OnePercentWorth`	Set the payout value for 1% of progress in Builder Job.
`Config.Payments`	Set the reward for each level in Electrician Job

# Common Issues Welcome to the "Common Issues" page! This section is dedicated to addressing problems that frequently occur, are not caused by our platform, and can be easily fixed. Our aim is to provide you with quick solutions and guidance to help you overcome these issues and enjoy a seamless experience.\ \ Please note that if a script is not listed here, it means that we have not yet identified any common issues for it. We constantly update this page as new information becomes available, so be sure to check back regularly for the latest tips and solutions. If you encounter a problem that is not covered on this page, please feel free to contact our support team for further assistance. We're always here to help!

# Electrician Game Freeze A common issue encountered in the electrician job is that after interacting with the first minigame, the screen freezes, and players are unable to perform any actions. This problem usually arises when you are not using our official and modified version of the electrician minigame, but instead are using a default version downloaded from the internet. To avoid this issue, make sure to use the proper version of the script available on the Keymaster. This version has been specifically adapted for the electrician job and is included in the package. The script is called Howdy-Minigame. By using this version of the minigame, you can ensure a smooth and enjoyable experience for players while avoiding the screen freeze problem. # Black Screen on Start Are you facing a problem with a black screen on startup while working on your system? If yes, then don't worry, we have a solution for you. This issue usually occurs due to a problem in the fuel system in the /client/functions.lua file. However, we cannot provide a universal solution for every system, as every fuel system is different. Therefore, we suggest you either connect your own fuel system or remove the existing one. To remove the fuel system, follow the steps mentioned below: Original code:

function SetVehicle(vehicle)
    -- Setup here your vehicle keys, fuel etc..
    
    if Config.Framework == "QBCore" then
        exports['LegacyFuel']:SetFuel(vehicle, 100.0)
        TriggerEvent("vehiclekeys:client:SetOwner", Core.Functions.GetPlate(vehicle))
    elseif Config.Framework == "ESX" then
    
    else
    
    end
end

Modified code: ```lua function SetVehicle(vehicle) -- Setup here your vehicle keys, fuel etc.. if Config.Framework == "QBCore" then TriggerEvent("vehiclekeys:client:SetOwner", Core.Functions.GetPlate(vehicle)) elseif Config.Framework == "ESX" then else end end ``` By following these steps, you can remove the fuel system and solve the black screen issue on startup.
# Job Clothes Issue ### Bad Looking Clothes If you're experiencing issues with your job clothing our scripts, such as clothes looking different than intended or having holes, it's likely caused by modified clothing packs that change the order of the clothing items. To fix this issue, you need to adjust the numbers of your clothes in the Config.Clothes file for both male and female clothing. The quickest way to do this is to first wear the clothes in-game, then copy the numbers of your clothes into the configuration file. ### Not working clothes at all If you're using a framework other than ESX and QBCore, you'll need to configure your entire clothing system in the /client/functions.lua file to ensure that it works with the script's ability to restore your original clothing. Unfortunately, we can't provide universal guidance as every clothing system is different. However, the goal of this modification is to adapt the clothing restoration to the defaults. After properly connecting your clothing system to our script, don't forget to remove the following code that cancels the function execution at the top of the file: {% code overflow="wrap" %} ```lua if Config.Framework ~= "QBCore" and Config.Framework ~= "ESX" then print("CANNOT CHANGE CLOTHES, PLEASE CONFIGURE UR CLOTHES SYSTEM IN /Client/Functions.lua file.") return end ``` {% endcode %} # Overview ## Available Languages You can check the available languages [here](/speech-recognition/available-languages) ## Debug ```lua Config.Debug = true ``` By enabling this the speech which is detected printed into F8 Console ## Hud Indicator UI ```lua Config.EnableHudIndicators = true ``` Set to false, if you want to delete the red/orange/green microphones icon in corner which indicates the speech recognition to the player and looks like this

ONLY ICON IS SHOWN ON SCREEN NOT THE TEXT [ TEXT IS TO SHOW THE DIFFERENCE BETWEEN THE ICONS ]

# Available Languages ```lua Afrikaans (south africa) af-za afrikaans (south africa) af-za albanian (albania) sq-al amharic (ethiopia) am-et arabic (algeria) ar-dz arabic (bahrain) ar-bh arabic (egypt) ar-eg arabic (israel) ar-il arabic (jordan) ar-jo arabic (kuwait) ar-kw arabic (lebanon) ar-lb arabic (mauritania) ar-mr arabic (morocco) ar-ma arabic (oman) ar-om arabic (qatar) ar-qa arabic (saudi arabia) ar-sa arabic (state of palestine) ar-ps arabic (tunisia) ar-tn arabic (UAE) ar-ae arabic (yemen) ar-ye armenian (armenia) hy-am azerbaijani (azerbaijan) az-az basque (spain) eu-eswhat bengali (bangladesh) bn-bd bengali (india) bn-in bosnian (herzegovina) bs-ba bosnian (herzegovina) bs-ba bulgarian (bulgaria) bg-bg burmese (myanmar) my-mm catalan (spain) ca-es croatian (croatia) hr-hr czech (czech republic) cs-cz danish (denmark) da-dk dutch (belgium) nl-be dutch (netherlands) nl-nl english (australia) en-au english (canada) en-ca english (ghana) en-gh english (hong kong) en-hk english (india) en-in english (ireland) en-ie english (kenya) en-ke english (new zealand) en-nz english (nigeria) en-ng english (pakistan) en-pk english (philippines) en-ph english (singapore) en-sg english (south africa) en-za english (tanzania) en-tz english (united kingdom) en-gb english (united states) en-us estonian (estonia) et-ee filipino (philippines) fil-ph finnish (finland) fi-fi french (french) fr-fr french (belgium) fr-be french (canada) fr-ca french (switzerland) fr-ch galician (spain) gl-es georgian (georgia) ka-ge german (austria) de-at german (germany) de-de german (switzerland) de-ch greek (greece) el-gr gujarati (india) gu-in hebrew (israel) iw-il hindi (india) hi-in icelandic (iceland) is-is indonesian (indonesia) id-id italian (italy) it-it italian (switzerland) it-ch japanese (japan) ja-jp javanese (indonesia) jv-id kannada (india) kn-in kazakh (kazakhstan) kk-kz khmer (cambodia) km-kh korean (south korea) ko-kr lao (laos) lo-la latvian (latvia) lv-lv lithuanian (lithuania) lt-lt macedonian(north macedonia) mk-mk malay (malaysia) ms-my malayalam (india) ml-in marathi (india) mr-in mongolian (mongolia) mn-mn nepali (nepal) ne-np norwegian bokmal (norway) no-no persian (iran) fa-ir polish (poland) pl-pl portuguese (brazil) pt-br portuguese (portugal) pt-pt punjabi (gurmukhi india) pa-guru-in romanian (romania) ro-ro russian (russia) ru-ru kinyarwanda (rwanda) rw-rw serbian (serbia) sr-rs sinhala (sri lanka) si-lk slovak (slovakia) sk-sk swati (south africa) ss-latn-za southernsotho(south africa) st-za spanish (argentina) es-ar spanish (bolivia) es-bo spanish (chile) es-cl spanish (colombia) es-co spanish (costa rica) es-cr spanish (dominican) es-do spanish (ecuador) es-ec spanish (el salvador) es-sv spanish (guatemala) es-gt spanish (honduras) es-hn spanish (mexico) es-mx spanish (nicaragua) es-ni spanish (panama) es-pa spanish (paraguay) es-py spanish (peru) es-pe spanish (puerto rico) es-pr spanish (spain) es-es spanish (united states) es-us spanish (uruguay) es-uy spanish (venezuela) es-ve sundanese (indonesia) su-id swahili (kenya) sw-ke swahili (tanzania) sw-tz swedish (sweden) sv-se tamil (india) ta-in tamil (malaysia) ta-my tamil (singapore) ta-sg tamil (sri lanka) ta-lk telugu (india) te-in thai (thailand) th-th setswana (south africa) tn-latn-za turkish (turkey) tr-tr tsonga (south africa) ts-za ukrainian (ukraine) uk-ua urdu (india) ur-in urdu (pakistan) ur-pk uzbek (uzbekistan) uz-uz venda (south africa) ve-za vietnamese (vietnam) vi-vn isixhosa (south africa) xh-za zulu (south africa) zu-za cantonese (hong kong) yue-hant-hk mandarin (china) zh (cmn-hans-cn) mandarin (taiwan) zh-tw (cmn-hant-tw) ``` # Basic Stuff ## Player Loaded Event ```lua Config.PlayerLoadedEvents = { ["QBCore:Client:OnPlayerLoaded"] = true, ["esx:playerLoaded"] = true, ["playerSpawned"] = true, } ``` If you are using any other framework like vRP or Standalone Server you should add the event here based on the Framework ## On First Talk ```lua Config.ApprovalRequestMode = "onFirstTalk" ``` **Approval Request Modes:**\ \ "onFirstTalk" - When player will want to talk something first time on server (only after loading) "onFirstJoin" - When player will first join ur server (after ur Config.PlayerLoadedEvents event) "onEvent" - You can open the apporval menu anytime you want. Select this option, and then trigger the "17mov\_SpeechRecognition:OpenApprovalMenu" event --- [Next Page](https://docs.17movement.net/llms-full.txt/1)

{getLang('Auth:Pages.Login.Title')}

{getLang('Auth:Pages.Register.Title')}

{getLang('Userbar:Title')}

Argument	Type	Optional	Explanation
src	`number`	❌	The player's server ID (source).
name	`string`	❌	The name of the conversation.
joinCode	`string`	✅	Code to join conversation. If not provided, it will be generated automatically.

Argument	Type	Optional	Explanation
src	`number`	❌	The player's server ID (source).
conversationId	`number`	❌	ID of the conversation to add the user to.

Argument	Type	Optional	Explanation
search	`string`	✅	Search query to filter auctions by title.
category	`"all" \| "item" \| "car"`	✅	Fetching auctions only from this category
sort	`"priceAsc" \| "priceDesc"\| "newest"`	✅	Sorting auctions by this param
cursor	`number`	✅	Number of items to skip (pagination). Requires `limit`.
limit	`number`	✅	Maximum number of auctions to return.
userId	`number`	✅	Filter auctions created by a specific user ID.

Argument	Type	Optional	Explanation
title	`string`	❌	The title of the auction.
description	`string`	❌	Detailed description of the item/vehicle.
images	`string[]`	❌	Array of image URLs.
phoneNumber	`string`	✅	Contact phone number for the seller.
price	`number`	❌	Price of the item.
seller	`number`	✅	User ID of the seller. Defaults to 0 (System).
category	`"item" \| "car"`	❌	Auction category
hideNumber	`boolean`	❌	Whether to hide the seller's phone number.

Argument	Type	Optional	Explanation
src	`number`	❌	The player's server ID (source).
contactNumber	`string`	❌	The phone number of the contact to add.
firstname	`string`	❌	The contact's first name.
lastname	`string`	❌	The contact's last name.
notes	`string`	✅	Optional notes about the contact.
image	`string`	✅	Optional URL for the contact's avatar.

Argument	Type	Optional	Explanation
from	`string`	❌	Caller's phone number.
to	`string`	❌	Receiver's phone number.
type	`"phone" \| "video"`	✅	Is video-call or default call?

Argument	Type	Optional	Explanation
number	`number`	❌	Target player number
message	`string`	❌	Message content.
sender	`number \| string`	✅	Sender number or name, default is "System"

Argument	Type	Optional	Explanation
src	`number`	❌	The player's server ID (source).
level	`number`	❌	Verification level: `0` (None), `1` (Verified), `2` (Business), `3` (Gov).

Argument	Type	Optional	Explanation
fromAccount	`string`	❌	Sender's wallet account number
toAccount	`string`	❌	Receiver's wallet account number
fromName	`string`	❌	Name displayed as the sender
toName	`string`	❌	Name displayed as the receiver
description	`string`	❌	Transaction label or description
amount	`number`	❌	The monetary value of the transaction

Argument	Type	Optional	Explanation
src	`number`	❌	The server ID of the player.
username	`string`	❌	The desired login/username
password	`string`	❌	The account password.
appName	`string`	❌	Name of the app (Full list available in Config.AppDefinitions)
accountData	`table`	❌	The specific Data Object for the app (see above)

Argument	Type	Optional	Explanation
number	`number`	❌	The target player's phone number
username	`string`	❌	The desired login/username
password	`string`	❌	The account password.
appName	`string`	❌	Name of the app (Full list available in Config.AppDefinitions)
accountData	`table`	❌	The specific Data Object for the app (see above)

Property	Type	Description
`name`	string	Unique identifier for the application.
`label`	string	The display name shown under the icon.
`ui`	string	URL to the app's `index.html`.
`icon`	string	Path to the icon image.
`iconBackground`	string \| object	The Icon Background Object or HEX VALUE
`default`	boolean	If `true`, the app cannot be uninstalled and is preinstalled
`preInstalled`	boolean	If `true`, the app is installed by default on new phones.
`resourceName`	string	The name of your resource
`rating`	float	Store rating (1-5)
`job`	object	The Job Object or nil. This parameter is optional. Here you can restrict app to certain jobs

Property	Type	Description
`name`	string	Same name as in AddApplication
`resourceName`	string	Resource name that registered the app
`uninstall?`	boolean	Whether or not uninstall app from player phone (If this is not set to true, you'll remove app temporary, if it has preInstalled or default value it will automatically install itself again

Argument	Type	Optional	Explanation
callback	`(url: string) => void`	❌	Function triggered when media is saved. Receives the URL.
disablePhoto	`boolean`	✅	If `true`, the photo mode will be disabled. Default value is `false`
disableVideo	`boolean`	✅	If `true`, the video mode will be disabled. Default value is `false`

Argument	Type	Optional	Explanation
callback	`(data: string \| string[]) => void`	❌	Triggered when media is selected. Returns URL or array of URLs.
multiple	`boolean`	✅	If true, user can select multiple items. Default value is `false`
type	`'image' \| 'video' \| 'both'`	✅	What type of media should be pickable. Default value is `'image'`
enableLink	`boolean`	✅	If true, allows user to input a custom URL link. Default value is `false`

Name	Type	Optional	Description
`username`	string	❌	The username to attempt login with.
`password`	string	❌	The user's password.

Name	Type	Description
`success`	boolean	The `success` boolean is `true` upon success.
`message`	string	The `message` string provides an error description (if unsuccessful) or a confirmation message.

Name	Type	Optional	Description
`username`	string	❌	The username for the new registration.
`password`	string	❌	The new user's password.
`accountData`	unknown	✅	Optional additional account data to be saved (e.g., email, date of birth). Can be `null`.

Name	Type	Description
`username`	string	Current login username
`accountData`	unknown	Return data provided while registering


`ExternalAuthContext`	stores information about whether the user is logged in
`ExternalAuthProvider`	manages authorization logic and automatic redirects