Configuration

Framework integration. 'auto' detects ESX, QBCore and QBox. Set 'esx', 'qbcore', 'qbox' or 'standalone' to choose one.

Language for the phone's text. English is the only language that ships.

Extra logging and developer test commands. Leave it false on a live server.

The target script for the payphone, carrier counter and dropped-phone options. 'auto' uses the first one started of ox_target and qb-target, or name one of them.

The ox_inventory item that opens the phone.

The ox_inventory item that carries a phone number.

Shape of a new number. Each X is a random digit.

Carrier name shown on the lock screen.

Days before a suspended number goes back into the pool.

Default key that opens and closes the phone. Players can rebind it in GTA's key bindings. '' turns the keybind off.

Chat command that opens the phone. '' turns it off.

Players can walk and sprint with W, A, S and D while using the phone with the cursor. Typing in a text field pauses it.

Allow Face ID unlock. Only the phone's owner can use it.

How many accounts one character may add to a phone.

How long an unlock lasts, in seconds (8 hours).

Lock the phone every time it is put away, so the next open asks for the passcode.

true makes a new phone set a passcode before it opens.

Shortest passcode a player may choose.

Longest passcode a player may choose.

Apps that exist on every phone. Remove an id to hide that app from every phone.

Ids = { 'calls', 'messages', 'camera', 'gallery', 'maps', 'cards', 'notes', 'clock',
        'weather', 'calculator', 'exchange', 'contacts', 'recorder', 'browser', 'music',
        'mail', 'beacon', 'garage', 'home', 'shift', 'companies', 'airwave', 'facetime',
        'depot', 'yapp', 'ember', 'cipher', 'bulletin', 'stall', 'trace', 'gloss',
        'glimpse', 'flick', 'settings' },

Turn apps off without removing them from the list, for example { camera = true }. SDK app ids work too.

How long a notification stays on the phone.

Metres within which other players hear a phone ring or buzz in someone's pocket. 0 means only the holder hears it.

The same range while the holder sits in a closed vehicle.

Starting position for a player who never moved the phone: 'right', 'centre' or 'left'.

Starting size, from 0.7 to 1.15.

Pixels from the side and bottom edge of the screen.

A put-away phone rises a little to show a new notification.

How long a notification peek stays up.

Drain while the phone is closed in a pocket. Only while the player is online.

Drain while the screen is on. About three hours of use per charge.

Charge while the phone is open in a vehicle with the engine running.

A call not answered within this time is a missed call.

A call is hung up after this many minutes.

A put-away phone shows the incoming call. The player presses the phone key to use it.

Calls use pma-voice channels 700001 to 799999. Keep other scripts' channels out of that range.

'targets': a muted player still hears the other side. 'leave': muting drops the audio both ways.

People standing nearby hear the other side of a call on speaker.

Speakerphone range in metres.

On speaker, the other side also hears the people near the holder, unless the holder is muted.

Service numbers that ring every on-duty player with one of the listed jobs. The first to answer takes the call.

Services = {
    { number = '911', label = 'Emergency', jobs = { 'police', 'ambulance' }, emergency = true },
    -- { number = '555-0110', label = 'Detectives', jobs = { 'police' }, minGrade = 2, requireDuty = false },
},

Turn the Companies app on or off. Off also hides its icon.

'toggle': a company is open while an employee on duty has tapped Open in the app. 'duty': it is open while any employee is on duty.

A call to a closed company still rings its employees on duty. With nobody on duty the caller hears that the company is unavailable.

Employees read and answer customer texts only while on duty.

A call nobody took, or a text to a closed company, gets one automatic text back.

At most one automatic text per customer per company in this many minutes.

A company without a number gets this prefix plus four digits from 3000 to 9999. The same company always gets the same number. Keep it clear of Config.Callbox.NumberPrefix.

Also list every framework job that has no entry in List. Hide the ones that are not businesses with Hidden and HiddenTypes.

Job names never listed, for example { 'unemployed', 'police', 'ambulance' }. Emergency services have their own numbers in Config.Calls.Services.

Qbox and QBCore job types never listed.

One entry per company.

List = {
    { job = 'mechanic', label = 'LS Customs', number = '555-0100', location = vector3(-347.3, -133.4, 39.0) },
    { job = 'taxi', label = 'Downtown Cab Co.', location = vector3(903.5, -170.6, 74.1) },
    { job = 'cardealer', label = 'Premium Deluxe Motorsport', icon = 'mechanic', location = vector3(-56.7, -1096.6, 26.4) },
    { job = 'reporter', label = 'Weazel News', icon = 'news', location = vector3(-598.9, -929.9, 23.9) },
    { job = 'airport', label = 'LSIA', location = vector3(-1037.6, -2737.6, 20.2) },
    -- A place without a job: shown and routed to, never called or texted.
    -- { id = 'pillbox', label = 'Pillbox Hill Medical', icon = 'ambulance', alwaysOpen = true, location = vector3(298.6, -584.5, 43.3) },
},

Turn the carrier counters on or off.

Price of a SIM with a new number. The number is issued on its first use. 0 is free.

Price of a replacement SIM for the player's main number. 0 is free.

Metres from a counter.

The map blip at every counter. false shows none.

Counter spots. None ship, so add your own.

Stores = {
    { label = 'Badger', coords = vector3(1137.4, -469.6, 66.7) },
},

Turn voicemail on or off.

Longest message a caller can leave.

Longest custom greeting.

A full mailbox takes no new messages.

Unheard messages one caller can leave in one mailbox.

Older messages are deleted. 0 keeps them.

How long after the call a caller has to leave the message.

Turn the Recorder app's voice memos on or off.

Longest memo.

Memos one phone can keep.

Mix nearby players' voices into a memo. Only players who have already allowed their microphone join, and nobody is asked mid-recording.

'voice' uses each speaker's own pma-voice range. A number sets a range in metres.

Most nearby voices mixed into one memo.

Nearby voices go through your TURN server. Without one, memos record only the holder. true removes that need, but direct links show nearby players each other's IP addresses.

Turn the Camera app on or off.

Photo width in pixels. Portrait photos are 3:4; held sideways the two sides swap.

Photo quality, from 0.5 to 1.

Video width in pixels. Portrait videos are 9:16.

Longest video.

Highest video bitrate in bits per second. It is lowered automatically so the longest video fits the upload cap.

Field of view for each zoom step.

Left Alt by default. With the phone open it switches between walking and using the cursor; in the camera it switches between aiming and the cursor. '' turns it off.

Degrees the camera turns per unit of mouse movement while aiming, at 1x zoom.

Show the Rotate button, so players can hold the phone sideways for landscape photos and video.

Turn the Photos app on or off.

Photos and videos one phone can keep. Recently Deleted counts.

Days in Recently Deleted before an item is gone for good.

Largest photo file.

Largest video file. MaxUploadKB in config_server.lua also caps it.

Turn the Clock app on or off.

Alarms one phone can keep.

How long Snooze waits.

An unanswered alarm or timer stops after this.

Turn the Notes app on or off.

Notes one phone can keep. Recently Deleted counts.

Longest note, in characters.

Days a deleted note stays in Recently Deleted.

Turn the Weather app on or off.

'auto' reads nx_fourseasons when it runs and the game's weather otherwise. 'fourseasons' or 'game' picks one.

Turn the Maps app on or off.

How often, in milliseconds, the map moves your dot while Maps is open.

Turn the Wallet app on or off.

Let players send money to a phone number. The money goes to the number's registered owner.

Smallest send, in whole dollars.

Largest single send.

Total one character may send per day.

Transactions shown per card.

Turn the Exchange app on or off. It shows prices only; trading stays on nx_computer.

Price refresh interval while the app is open.

Phones can be put on the ground and picked up. The /placephone command also needs this.

A player who goes down drops the phone they hold or carry.

Percent chance that a downed player drops their phone.

Chat command that puts the phone on the ground. '' turns it off.

false lets only the phone's owner pick it up.

Pick-up distance in metres.

Metres within which a ringing phone on the ground can be heard.

Hours before a phone left on the ground is removed. 0 keeps it.

Tilt that lays the prop flat with the screen up. Use 90.0 if dropped phones land face down.

Show a pick-up prompt next to a phone on the ground, as well as the target option.

Control that picks the phone up (38 is E).

What the prompt calls that key.

Turn Find My on or off.

How often a carried phone's position is saved.

How long Play Sound rings.

Put a blip on the map for a located phone.

Turn the Browser app on or off.

The page a new tab opens.

Bookmarks per phone.

Pages kept in History per phone.

Hosts that site images may load from, for example { 'r2.fivemanage.com' }. An empty list allows no remote images.

The built-in .lc sites. Set one to false to hide it.

Stories on news.lc, each { title, body }. With nx_computer, the laptop's city news is added.

Extra business entries on lifeinvader.lc.

Directory = {
    { name = 'Pizza Planet', description = 'Hot pizza, fast', number = '555-0142', site = 'pizza.lc' },
},

Turn the Waveform music app on or off.

Players may add their own track links.

Hosts (and their subdomains) that players' own links may use. An empty list accepts any https link, but then only the stations in Playlists play out loud, because out loud makes every nearby player's game fetch the link and shows their IP to that host.

Tracks one phone can add.

Players can play music through the speaker for people nearby.

Out-loud range in metres.

Highest out-loud volume, 0 to 1.

Music volume during a call. 0 pauses it.

Stations every phone has. Tracks are direct audio links (mp3, ogg, m4a or webm).

Playlists = {
    { id = 'nx', name = 'NX Radio', tracks = {
        { title = 'Song', artist = 'Band', url = 'https://cdn.example.com/song.mp3', artwork = '' },
    } },
},

Turn the Mail app on or off.

Addresses are username@Domain. 'auto' uses the nx_mail_domain convar, else your sv_projectName as a .com. With nx_computer running, the laptop's domain wins.

Old domains that still deliver.

Mails one mailbox keeps.

Longest mail body, in characters.

A new phone runs the setup screens on first boot.

Languages offered on the first setup screen.

Show phone screens to people nearby.

Metres within which players can read a phone in someone's hand.

Most phone screens one player's game draws at once, nearest first.

How often, in milliseconds, an open screen is sent to people watching it.

Your own screen shows on the phone in your hand in third person.

'picture' shows a live picture of the real screen. 'text' shows a large-text view instead.

Pictures per second while someone watches.

Where the screen sits on the phone prop, in local metres: Offset, Width, Height, Lift, Normal, Up and LandscapeUp. Only change it if you swap Config.Prop.Model.

A phone placed on a surface shows StandBy.

Chat command that lays your phone on the surface in front of you. '' turns it off.

Metres within which a phone on a surface can be read.

The privacy screen item. Using it fits it to the phone in hand. '' turns privacy screens off.

Degrees off straight-on where a protected screen goes dark.

Turn the Garage app on or off.

'auto' uses the first one started of jg-advancedgarages, cd_garage, qs-advancedgarages, okokGarage, mGarage, qbx_garages, qb-garages, esx and qb. Or name one of them.

Key script used for a valet car: 'auto', 'none', or a key script by name (qbx_vehiclekeys, qb-vehiclekeys, wasabi_carlock and others).

Bring a stored vehicle to the nearest road. Not available with qs-advancedgarages or okokGarage.

Valet price, taken from the bank and then cash. 0 is free.

Turn the Home app on or off.

'auto' uses the first one started of qbx_properties, ps-housing, qs-housing, bcs_housing, loaf_housing, nolag_properties, vms_housing, esx_property and qb-houses. Or name one. 'none' turns it off.

A doorbell ring notifies every online owner and key holder of the property.

Seconds before the same door rings the phones again.

How long Let them in works after a ring.

A housing script's ring must come from within this many metres of the door.

Turn the Shift job app on or off.

'auto' uses the Qbox, QBCore or ESX duty state. 'none' removes the duty switch, and everyone with the job gets alerts.

For ESX without a duty flag: 'police' and 'offpolice' count as on and off duty when that job exists.

The dispatch inbox in Shift.

Alerts older than this drop out of the inbox.

Alerts kept per job. The oldest go first.

Copy alerts from ps-dispatch, cd_dispatch, qs-dispatch, rcore_dispatch and core_dispatch.

Where the society balance comes from: 'auto', 'none', or one banking script by name (see bridge/jobs.lua).

Who sees the society balance: 'boss' for the job's boss grades, or a grade number.

The emblem shown for a job. Map a job to a built-in emblem (police, sheriff, ambulance, mechanic, taxi, realestate, news, lawyer), to your own square image, or to false for the plain Shift icon.

Emblems = {
    bcso = 'sheriff',
    burgershot = 'nui://my_assets/burgershot.png',
},

Characters can hold several jobs, work one at a time and switch in Shift.

'auto', 'nx' (built in), 'qbox', 'ps-multijob' or 'core_multijob'.

Jobs one character can hold.

Seconds between two job switches.

Job a player is set to when they leave their active job.

Resources allowed to call the multijob exports (AddJob, RemoveJob, GetJobs, GetJobMembers, GetJobNames).

Turn the Airwave radio app on or off.

Voice backend: 'auto', 'pma-voice', 'saltychat' or 'yaca-voice'.

Highest channel number.

Channel precision: 100.25 needs 2. At most 3.

Item needed to use Airwave, for example 'radio'. '' needs none.

How often players on a channel are re-checked for the item and job.

Restricted channels need the job on duty, where the framework has duty.

Also enforce Restricted inside pma-voice. pma-voice keeps one check per channel, so this replaces another radio script's checks on those channels. Leave it off when another radio script runs; the app enforces Restricted either way.

Channels only some jobs may join. Whole numbers cover their decimals.

Restricted = {
    { from = 1, to = 10, jobs = { 'police', 'ambulance' } },
    -- { from = 11, to = 12, jobs = { police = 2 } }, -- with a minimum grade
},

Turn FaceTime video calls on or off.

People in one video call. Every phone sends to every other one.

How long a video call rings before it counts as missed.

What each phone sends, in portrait.

Upper limit per person you send to. It is lowered automatically in bigger calls.

Video calls use pma-voice channels 800001 to 899999. Keep it clear of Config.Calls.Voice.

Turn Depot, the app store, on or off.

Apps every phone has and nobody can remove.

Apps a new phone comes with. The rest wait in Depot.

Apps put once on phones that already exist, so a new default app reaches old phones too. Players can still remove them.

Let other resources add apps with RegisterApp. See the SDK page.

Streamer Mode default for new phones. Players switch it in Settings, Privacy.

Turn the Yapp social app on or off.

Jobs that get the government badge automatically.

Handles only GovJobs may take.

Days before a profile can change its handle again.

Days an old handle stays held after a change.

Seconds a post can be edited after posting.

Edits allowed per post.

Minutes between trending recalculations.

Lowercase words refused in posts, names, bios and handles.

Turn the Ember dating app on or off.

Youngest age a profile can have. Never below 18.

Oldest age a profile can have.

Shortest bio, in characters.

Longest bio, in characters (at most 300).

Fewest photos per profile, taken from the player's own Photos.

Most photos per profile (at most 6).

Profiles unused this long leave everyone's deck.

Cards sent to the phone at a time.

Characters per chat message.

Likes per 10 minutes, per account and per character.

Messages per minute, per account and per character.

Gender ids (a-z, 0-9). A new id needs a phone.ember.gender.id label in the locale file.

Turn Cipher, the anonymous chat rooms, on or off. Players appear only under an alias.

Players may pick their own alias (3 to 20 characters, unique).

Rooms one account can own.

Rooms one account can be in. Starter rooms are not counted.

Members per room. Starter rooms have no cap.

Messages older than this are deleted.

At most one banner per room per phone in this time.

Starter rooms every player joins automatically. Keep each key the same once the server is live.

Turn the Bulletin news app on or off. With nx_computer running, Bulletin is the front page of the laptop's Newsroom, and the laptop's settings decide who writes.

Jobs that can write articles, each with its lowest grade. Standalone only.

From this grade, a writer can edit anyone's article and send Breaking news. Standalone only.

One Breaking alert per this many minutes, across the server.

How long the front page shows the Breaking banner.

Article categories.

Turn the Stall classifieds app on or off. With nx_computer running, Stall shows the laptop's classifieds board and uses its limits.

A listing comes down after this many days.

Live listings per account.

Wait between two posts.

Charged per post, from the bank and then cash. 0 is free.

Photos per listing (0 to 4).

Turn Trace, the person and vehicle lookup, on or off.

What a person search shows. Any of number, job, grade, gender and age.

What a plate search shows. Any of model, color and owner (name only).

Jobs never listed. Their cars show no owner.

Character identifiers never listed.

Plates that never answer.

Charged per search, from the bank and then cash, whether anything is found or not. 0 is free.

Players can turn on Call Screening in Settings. A caller who is not in their contacts states who they are before the phone rings.

Setting for new phones: 'off', 'ask' (the caller types a reason first) or 'silence' (straight to voicemail).

Time the caller has to answer.

Characters in a typed reason.

Callers may also record a short clip. Needs the media backend.

Longest voice clip.

Different accounts that must report a number before it shows Spam Risk.

Reports older than this stop counting.

The robodialer in Cipher: pay to call many numbers with a recorded pitch. A victim who presses 1 is connected to the campaign's own number.

Only these jobs may run campaigns. An empty list allows anyone.

Paid up front for every number dialled.

'cash', 'bank' or 'black_money'. Falls back to cash where there is no black money.

Numbers one campaign dials.

Seconds between two calls of one campaign.

A number gets at most one robocall in this time.

Wait between two campaigns of one character.

Characters in a pitch.

Longest recorded pitch. Needs the media backend.

Turn the Gloss photo app on or off.

Photos per post.

Characters in a caption.

Characters in a comment.

A story disappears after this.

Lowercase words refused in captions, comments, names and bios.

Turn the Glimpse snap app on or off.

Opened snaps and chat lines vanish after this unless saved.

A story disappears after this.

A streak breaks when this long passes without a snap both ways.

Size of the best friends list.

The friend map. Everyone starts hidden and chooses who sees them.

How often positions on the friend map update.

Turn the Flick video app on or off.

Longest video.

Characters in a caption.

Characters in a comment.

A Waveform station track can play over a video (Config.Music.Playlists).

Lowercase words refused in captions, comments, names and bios.

Turn payphones on or off.

Prop models that work as payphones, for example 'prop_phonebox_01a'. The payphone options sit on the booth prop itself, and only on one that stands there: a booth a car knocked down, one a map or another script hides, or one lying on its side offers nothing.

Cash per started minute. 0 is free.

Numbers that are always free to call.

Metres. Walking further away hangs up.

Booth numbers are this prefix plus three digits.

Only known payphone spots in the base map can become booths.

Payphones your custom maps add, as vector3 positions, for example vector3(-36.35, -1379.17, 28.33). These only let a booth prop at that spot register when Whitelist is on; they never place a target by themselves. A custom booth model also goes in Models.

New booths one character may ever register by using them first. 0 means no cap.

Show the payphone options only on a booth the player can actually reach, not one buried in a wall or a shelf.

The receiver prop held during a payphone call: Model, Bone, Offset and Rotation.

The call pose: Dict, DictFemale and Base.

The police MDT companion: seized phones, tower dumps and device traces, always under a warrant. 'auto' turns it on while an allowed MDT resource runs.

Resources allowed to call the MDT exports.

The officer must hold one of these jobs. An empty list skips the check.

Metres per side of a cell tower square.

Days tower pings are kept.

Time to read an open phone, or one whose passcode is known.

Time to crack a locked phone. 0 turns cracking off.

Turn Live Activities on or off.

Live activities at once per player.

Live activities per resource per player.

Cards shown on the lock screen.

Seconds before an activity ends by itself, unless it sets its own ttl (at most 8 hours).

Seconds without an update before a card dims.

A billing job takes card payments on its phone and the customer confirms on theirs. Needs nx_realbanking; off without it.

Metres between the two phones.

Smallest payment.

Largest payment. nx_realbanking's own invoice limits apply too.

A charge nobody paid expires after this.

The merchant must be on duty, when the job system reports duty.

How long a payment can be refunded. 0 means no refunds.

Who may refund: false for the boss only, or a grade number and up.

After a customer declines, the same charge is not offered to them again for this many seconds.

Hours of charges shown in the merchant's history.

Days charge records are kept.

Resources allowed to use CreateTerminalCharge and GetTerminalCharge. nil allows any resource.

Phone backups. A backup is restored during setup of a new or erased phone.

New phones back up automatically unless the owner turns it off.

Hours between automatic backups.

Largest backup, in bytes (256 KB).

Backups kept per phone.

Backups kept per character.

Older backups are deleted, except each phone's newest.

Wait between two manual backups.

Extra setting keys to include in backups, for example { 'x.myapp.' } for an SDK app.

The accent colour of the phone's interface. Use a hex colour.

Show a phone prop in the player's hand.

The prop model. nx_phone_handset ships with the resource.

Hand bone the prop attaches to. 28422 is the right hand, 60309 the left.

Small position nudge. The model sits correctly at zero.

Rotation that turns the screen toward the face.

Position nudge while the phone is held sideways for the camera.

Rotation while the phone is held sideways.

How the phone is held while reading. 'classic' is the cellphone@ hold; 'relaxed' is the lower, looser texting hold with male and female variants.

Animation dictionary for the classic hold. cellphone@female has female variants.

Raising the phone. TextIdle and TextOut set holding and putting it away.

Raising the phone to the ear. CallIdle and CallOut set the call pose and hanging up.

Blend-in speed. BlendOut (-8.0) is the blend-out speed.

Playback flags for raising the phone. FlagIdle and FlagExit cover holding and putting it away. The shipped flags let players walk and aim while holding the phone; change them only if you know GTA's animation flags.

How often, in milliseconds, the idle pose is re-applied if it blends off.

Share accounts, mail and the laptop's apps with nx_computer. 'auto' turns it on when nx_computer is running. true always expects it (the self-check warns if it is missing), and false keeps the two separate.

Putting the phone away during a call lowers it to the bottom of the screen with a call bar.

Players may create new accounts in Settings, Accounts, up to MaxAccountsPerCharacter.

Words a phone name may not contain, for example { 'admin', 'police' }. Letters and digits are compared.

Where photos, videos and recordings are stored. 'fivemanage' is the only backend that works today.

Largest single upload, in KB.

Delete uploads older than this. 0 keeps them.

How long a phone's upload link stays valid, in seconds.

Upload links one player may request per hour for voicemail, greetings and memos.

How long the server keeps checking that an upload arrived. The storage CDN can take minutes to show a new file.

A self-hosted, Fivemanage-compatible server (https only). '' uses the official Fivemanage API. The server must also let your ApiKey look a file up (GET <Url>/file/<id>, returning the file with the metadata the phone sent) and delete it. Without the lookup no photo, video or voice note is ever confirmed: the phone says the storage did not confirm the upload, and the server console names the lookup address.

Your own Fivemanage API key (Dashboard, Tokens). One API v3 key covers images, video and audio. Leave it empty to keep uploads off.

Older v2 key name, used only when ApiKey is empty.

Hosts uploaded files are served from. An empty list means r2.fivemanage.com plus the host of FiveManage.Url. List a self-hosted server's file host here if it differs. '.example.com' matches any subdomain.

Any action without its own entry.

Opening the phone.

Placing a call.

Sending a message.

Uploading a photo or video.

Adding or editing contacts.

The SendMessage export, counted per calling resource, not per player.

STUN and TURN servers handed to the phones in a video call. Sent only to the members of that call.

Config.Server.FaceTime = {
    Ice = {
        { urls = 'stun:stun.l.google.com:19302' },
        -- { urls = 'turn:turn.example.com:3478', username = 'user', credential = 'secret' },
    },
}

Force every call through your TURN server so players only see the relay's address. nil turns it on when a TURN server is configured. Needs a TURN entry or TurnSecret, or calls cannot connect.

A coturn use-auth-secret. The server then mints short-lived TURN logins per call, which is safer than a fixed username and password that every caller receives.

The TURN server URLs used with TurnSecret, for example { 'turn:turn.example.com:3478' }.

Seconds a minted TURN login stays valid.

Discord webhook URLs. '' turns a log off.