Apps

These server exports manage built-in apps listed in config/config.json, including apps hidden from the store with "storeHidden": true. If the phone is open, its home screen updates when the layout changes.

Use the Identify Player exports to get a phone's IMEI. For the USB installer, see Ghostlink USB.

Adds the app to the first free home-screen slot.

lua

---@param phoneImei string The target phone's IMEI
---@param appKey string App key from config/config.json (for example, 'ghostlink')
---@return boolean success
---@return string|nil error 'invalid_imei' | 'unknown_app' | 'phone_not_found' | 'already_installed' | 'install_failed'
local success, err = exports.yseries:InstallApp(phoneImei, appKey)

Removes the app from the home screen, dock, and folders.

lua

---@param phoneImei string The target phone's IMEI
---@param appKey string App key from config/config.json
---@return boolean success
---@return string|nil error 'invalid_imei' | 'unknown_app' | 'phone_not_found' | 'not_installed' | 'uninstall_failed'
local success, err = exports.yseries:UninstallApp(phoneImei, appKey)

Checks the home screen, dock, and folders.

lua

---@param phoneImei string The target phone's IMEI
---@param appKey string App key from config/config.json
---@return boolean installed
local installed = exports.yseries:IsAppInstalled(phoneImei, appKey)

Call this from your server-side reward handler after validating that the player completed the heist:

lua

local phoneImei = exports.yseries:GetPhoneImeiBySourceId(source)
if not phoneImei then return end

local success, err = exports.yseries:InstallApp(phoneImei, 'ghostlink')
if not success then
    print(('Ghostlink install failed: %s'):format(err))
end

Apps

Install app

Uninstall app

Is app installed

Example: install Ghostlink after a heist

On this page