For the complete documentation index, see llms.txt. This page is also available as Markdown.

Registering the Application

To make the phone recognize your new application, you must register it using the exported function in your client/main.lua.

Icon Background Object
{
    angle = 45,
    colors = { "#FF0000", "#0000FF" }
}
Job Object
{
    name = "police",
    grade = 0
}

AddApplication

Registers a new application icon on the home screen.

exports['17mov_Phone']:AddApplication(appData)
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

RemoveApplication

Works only for external apps

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

Locales

We've introduced system that lets you translate AppName or description in store via locales - depends what language user selects, description and name can be different. In order to do this, you need to specify new locales in locale:

  • Appname:Title - For changing titles. Please be aware that AppName needs to be capitalized - that means only first letter can be uppercase

  • Store:Appname:Description - For changing description. Please be aware that AppName needs to be capitalized - that means only first letter can be uppercase

Last updated