Configuration

Apps

Config.Apps, the default home screen, custom apps registered from config, and the bundled app switch.

File: configs/config_apps.lua.

#Config.Apps

The list of core apps. One entry per app:

luaConfig.Apps = {
    { id = 'phone', default = true, dock = true, category = 'communication', removable = false },
    { id = 'marketplace', default = false, dock = false, category = 'business' },
}
Field Type What it does
id string Core app id. Do not change
default boolean Installed on a new phone. Apps with false are in the App Store
dock boolean Placed in the dock on a new phone
category string App Store category: communication, media, utilities, productivity, finance, business, social, games, entertainment
removable boolean false blocks uninstalling
label string Optional name instead of the locale's apps.<id>
icon string Optional icon name
hidden boolean true removes the app from every phone
jobs string list Optional. Only these jobs see the app. Enforced on the server too: requests from that app by a player with another job are refused

Shipped entries:

Installed by default In the dock Not removable
phone, video, messages, contacts, wisp, camera, photos, settings, appstore, clock, calculator, calendar, voice, health, weather, notes, mail, bank, wallet, invoices, services phone, messages, camera, photos phone, messages, camera, photos, settings, appstore

In the App Store, not installed by default: marketplace, news, darkchat, anon, chirp, pixl, clips, pets, arcade, cases, coins, askme, snap, live, flame.

Notes:

  • invoices leaves the home screen by itself while fx-billingapp is running, so the phone shows one invoice app, not two.
  • anon needs the second SIM. See Config.SecondSim.Apps on SIM.
  • Apps can also be switched off at runtime from the admin tablet.

#Config.HomeScreen

The home screen of a phone that was never arranged: a new player, or after resetting the phone. Once a player arranges their own home screen, theirs is kept.

Setting Type Default What it does
HomeScreen.Widget { name, size } or false { 'weather', 'medium' } The widget on top of the first page. Names: weather, calendar, clock, photos, bank, favorites, notes, alarms. Sizes: small, medium, large. false: no widget
HomeScreen.FirstPage string list 14 app ids The apps on the first page, in order (at most 16 under a medium widget). Apps a player does not have are skipped; every other app follows from the second page on. Bundled apps go by their identifier, for example fx_music or fx-billing

The dock takes the apps marked dock = true in Config.Apps.

#Config.CustomApps

Registers iframe apps without code. Each entry has the same fields as the AddCustomApp export. Default: empty.

luaConfig.CustomApps = {
    { identifier = 'my_app', name = 'My App', ui = 'my-app/html/index.html', icon = 'https://example.com/icon.png' },
}

Fields and limits: Custom apps and Custom app exports. Prices set here are not capped by Config.Limits.AppPriceMax.

#Config.BundledApps

The Fixitfy app resources that come with FX Phone (the [fx-apps] folder). false keeps that app from starting at all. An app that is not installed is ignored. FX Phone must be ensured before the apps.

Key Default App
['fx-billingapp'] true Billing: invoices
['fx-casinoapps'] true Fixitfy Play: phone games
['fx-companyapp'] true Company: employees, funds, directory
['fx-fansapp'] true Fans: creator subscriptions
['fx-garageapp'] true My Vehicles: garage and valet
['fx-mapsapp'] true Maps: friends' live locations
['fx-metubeapp'] true MeTube: videos and TV screens
['fx-musicapp'] true Music: streaming, speakers, Dynamic Island
['fx-orderapp'] false Order: businesses, menus, delivery, couriers
['fx-rentalapp'] true Rental: player-to-player car rental

An app switched off here has its start cancelled by FX Phone. An app that was already running when FX Phone started is stopped instead. The console names the app in both cases.

More about what each app does: Apps.