Custom apps
We offer you exports that can assist you in developing your own applications and integrating them into your phone.
Configβ
The most straightforward method for incorporating an app is by editing the config.customApps.lua
file.
Locate the Config.CustomApps
section and insert your app as demonstrated in the example below.
Config.CustomApps = {
{
key = "your-app-key", -- key is used to identify the app, must be unique.
name = "your-app-name", -- Display name of the app
defaultApp = true, -- Wether to show it by default or add it as downloadable from `Addapp`.
game = true -- If true the app will show under games section in play store. Optional.
ui = "https://cfx-nui-" .. GetCurrentResourceName() .. "/ui/dist/index.html", -- A link to a nui page. Built version.
-- App icon. You can use a link or a local image. Simply paste your app image in `/build/(yos/humanoid)/apps/{key}.png`
-- Make sure the file name matches the key.
icon = { -- Optional
yos = "https://cdn-icons-png.flaticon.com/512/2314/2314912.png", -- YPhone OS icon.
humanoid = "https://cdn-icons-png.flaticon.com/512/566/566312.png", -- YFlip OS icon.
},
disabledJobs = {"police"}, -- Not available for Police job
allowedJobs = {"ambulance"} -- Available for Ambulance only
},
{
... -- Add more apps here.
}
}
Custom appsβ
If you wish to implement a custom user interface (UI) for your application, you must develop a separate resource using our templates.
How to add a custom app?β
To add a custom app, you need to use the following export:
exports.yseries:AddCustomApp({
key = key,
name = "App Template",
defaultApp = true,
ui = "https://cfx-nui-" .. GetCurrentResourceName() .. "/ui/dist/index.html",
icon = "https://i.ibb.co/QY127HV/app-icon-placeholder.png"
})
How to remove a custom app?β
To remove a custom app, you need to use the following export:
exports.yseries:RemoveCustomApp(key)
Last updated