Pulse Phone docs

Supported integrations

For Pulse Phone 1.5.28 min readUpdated

7. Other scripts it connects to automatically

Detection chooses which script handles each area, so you don't name them. The start-up line lists what was found. phone:diag shows every script the phone considered and why it used or skipped each one. To force one, set Config.Providers.<area> in config/config.lua to the resource name, or 'none' to switch that area off.

What detection does not do for you. Choosing a script is automatic; these steps are not. Check the ones for the areas you use before players rely on them:

  • Items: your inventory's item entries and pictures, and on some inventories the lines that make an item usable. The start-up check prints the exact entries still missing: what to do for your inventory.
  • Jobs and grades (duty, hiring and company accounts in the Services app): job names that differ from the defaults go in that company's job list in Config.Services, and bossGrade sets the boss grade (your framework).
  • Saving photos on a hosted server whose web port is not reachable: a FiveManage token or your own storage (Photos and videos).
  • Video calls and Live for the public: an external video relay (Video calls).
  • Garage directions for garage scripts that do not publish their garages: Config.Garage.garages (garage table below). The valet is off for some garage scripts.
  • Housing: qb-houses, qbx_properties and ps-housing need oxmysql; each housing script supports only the lock and key actions in the housing table below.
  • Scripts that call another phone's exports: one change each (Switching from another phone).
Area Supported scripts
Company accounts Renewed-Banking, qb-banking, qb-management, okokBanking, qs-banking, fd_banking, snipe-banking, tgg-banking, tgiann-bank, wasabi_banking, esx_addonaccount
Bank history in Wallet Renewed-Banking, qb-banking, ps-banking, okokBanking, tgiann-bank, esx_banking
Shared accounts in Wallet Renewed-Banking, qb-banking
Bills in Wallet esx_billing, okokBilling, QBCore's phone_invoices table
Garage app (vehicle list, directions, valet) jg-advancedgarages, cd_garage, okokGarage, vms_garagesv2, codem-garagesv2, qs-advancedgarages, qbx_garages, qb-garages, esx_garage, esx_advancedgarage, codem-garage, rcore_garage, loaf_garage. What each one supports: the garage table below
Home app qb-houses, qb-apartments, qbx_properties, qs-housing, loaf_housing, vms_housing, rtx_housing, ps-housing, bcs_housing, nolag_properties, esx_property
Dispatch (Smart 911, Services) ps-dispatch, cd_dispatch, core_dispatch, qs-dispatch, qs-police-creator, rcore_dispatch, codem-dispatchv2, linden_outlawalert. Without one, alerts arrive as phone notifications.
Vehicle keys (handed over with a valet delivery only) qbx_vehiclekeys, qb-vehiclekeys, qs-vehiclekeys, Renewed-Vehiclekeys, wasabi_carlock, MrNewbVehicleKeys, vehicles_keys, ak47_vehiclekeys, ak47_qb_vehiclekeys, t1ger_keys, 0r-vehiclekeys, VehicleKeyChain, brutal_keys, cd_garage and okokGarage keys
Fuel ox_fuel, Renewed-Fuel, lc_fuel, qs-fuelstations, cdn-fuel, ps-fuel, BigDaddy-Fuel, okokGasStation, x-fuel, rcore_fuel, LegacyFuel
Door locks ox_doorlock, qb-doorlock, cd_doorlock (read only), qs-doorlock-creator
Jobs your framework's jobs; several held jobs through wasabi_multijob, Qbox's own job list, or ps-multijob on QBCore
Interaction ox_target or qb-target for the store clerk and payphones, else an E prompt
Weather and time any weather sync script

Scripts written for other phones (police, EMS, job and boss-menu scripts) keep working when they send mail, texts or notifications through events: the phone answers the common event names other phones use. A script that calls another phone's exports needs one change (see "No such export" in section 11).

  • A script that starts after the phone, or restarts, is picked up within about two seconds.
  • When a supported script is running but its exports differ from the ones the phone knows (an older or newer version), a yellow line names the script and what is missing, and the phone uses the next option.
  • Each area in Config.Providers has a comment beside it in config/config.lua: bank, voice, housing, garage, inventory, dispatch, keys, vehiclelock, fuel, doorlock, society (company accounts), statement (bank history), accounts (shared accounts) and more. For a script that isn't listed, write a provider: optional-developer-kit/custom_provider_template.lua.
  • Every script, and exactly how the phone talks to each one, is in Integrations.
  • Keep your integration's required dependencies running before Pulse. Use phone:health to check the selected connection and follow any setup instructions shown for your server.

Not supported

Not supported, and why: nui_doorlock (no server-side way to read or change a door, and no longer maintained); Chezza's inventory (no published documentation; on ESX it still works through ESX's own item functions); ak47_qb_inventory's own export (not documented, so QBCore's item functions are used). loaf_housing publishes no exports page, so its adapter could not be checked again: it stays in, and lists nothing if its exports have changed.

Housing, by script:

Housing script List and waypoint Lock Keys
qb-houses yes (needs oxmysql) yes give / take
qbx_properties yes (needs oxmysql) no list only
qs-housing yes no no
loaf_housing yes yes, with loaf_keysystem running give / take / list
vms_housing yes no give / take / list
rtx_housing yes yes give / take / list
ps-housing yes (needs oxmysql) no (its door lock script handles the doors) give / take / list
bcs_housing yes yes take / list (give in its own menu)
nolag_properties yes yes give / take / list
esx_property yes, with lock state in its own menu list

Company management (the Services app)

Every employee of a Config.Services company gets a duty switch. Boss grades also get the employee list, and can offer jobs, promote, demote, fire and use the company account. Every action is checked on the server, and a boss can only manage grades below their own.

Hiring is an offer the player accepts. Nobody gets a job they didn't agree to, and nobody can be hired from across the map:

  1. The boss opens Services > Your Company > Hire. Players within 8 m who are not in the company are listed; Offer Job sends the offer. A typed player ID must also be within 8 m.
  2. The player gets a notification that opens the offer, with Accept and Decline. The starting grade is the company's lowest.
  3. On Accept the server checks again that the boss still manages the company and that the two are still within 8 m, then sets the job. The boss is told either way.

A player has one open offer at a time. An offer lapses after 2 minutes, or when either player leaves. Offers and hires go to the activity log.

Garage scripts: what the phone reads and what it changes

The Garage app reads your garage script: the character's vehicles, where each one is, and the impound and its fee where the script records them. It changes only two things, each with its own switch in Config.Garage (config/apps.lua):

  • Valet (valet.enabled, on by default; not on ox_core, ND Core or vRP): brings a stored car to the player. It marks the car as out in your framework's vehicle table (player_vehicles.state or owned_vehicles.stored), creates it near the player, takes the fee from their bank and hands over the keys through your key script. It is off for garage scripts that keep "parked" in a column of their own (table below): there the car would still show as parked, and could be taken out a second time. The valet has not yet been verified in game with these garage scripts.
  • Lock / Unlock (remoteLock.enabled, on by default): only for the player's own car that is already out in the world.

The phone never takes a car out of a garage script's storage or puts one back, never releases a car from an impound or pays an impound fee, and hands over keys only with a valet delivery.

Garage script Vehicle list Directions to its garages Valet
qb-garages, qbx_garages, esx_garage from the script's own columns from the script on
esx_advancedgarage, okokGarage from the script's own columns from its config file on
jg-advancedgarages, cd_garage, vms_garagesv2, qs-advancedgarages from the script's own columns from the script off
codem-garage the framework's table, plus the garage name from its parking column Config.Garage.garages off
rcore_garage, loaf_garage the framework's table only (their storage is not public) Config.Garage.garages off
No garage script (QBCore, Qbox or ESX) the framework's table Config.Garage.garages on

The columns each script is read from, and the order the phone prefers them in, are in Garages in the advanced reference.

Garage: car photos, locks, positions

  • Photos of every car, add-on cars included: in game, with the phone.admin ace, run /phonecarphotos (cars with no photo yet), /phonecarphotos all (every car again) or /phonecarphotos <model>. Every vehicle is photographed against the sky, cut out and saved through the phone's media store (needs screenshot-basic), about a second each. Backspace or Esc stops it. Without a photo, players see the official picture (Config.Garage.imageUrl), then a drawing. Run it again after adding cars.
  • Lock / Unlock from the app (Config.Garage.remoteLock) uses qbx_vehiclekeys, Renewed-Vehiclekeys, MrNewbVehicleKeys or t1ger_keys when running, and the game's own lock otherwise, which is what qb-vehiclekeys, wasabi_carlock, cd_garage and similar read. For another lock script, register a provider in bridge/server/vehiclelock.lua (example inside).
  • Directions to a garage need its position: from your garage script, or Config.Garage.garages. Impound lots: Config.Garage.impounds.
  • Config.Providers.garage forces one garage script. For an in-house one, see Custom Garage.

Switching from another phone

  1. Remove the old phone first: take its folder out of resources and delete its ensure line.
  2. Scripts that use the common phone events (mail, texts, notifications, invoices) need nothing: the phone answers those event names itself.
  3. Scripts that call another phone's exports by name get No such export in the console. Switch those calls to exports.phone:.... The matching calls (SendMail, SendMessage, Notify, SendBill, DispatchAlert ...) are in Exports, usually one line per call.
  4. Bring your players' data across with phoneimport in the server console. Run phoneimport --dry-run first to see what would be copied, then phoneimport. Players keep their phone numbers, and contacts, calls, chats, photos and more come across where the old phone had them. The import only reads the old tables, and a second run never duplicates anything. Which old phones it reads, and exactly what comes across from each, is in Importing Data.

One write happens before any import: on its first start, Pulse renames the old phone's tables that share a name with its own to old_<name>. Nothing is deleted, and the console lists every table that moved. Back up the database first; how to undo it is in section 2. What does not carry over: direct writes into another phone's own tables, mail and notification buttons, texts from a script to a player who is offline (delivered live only), attachments on script texts, and opening apps by script.

Other scripts: HUD and dispatch scripts that read the common state bag names (phoneOpen, phoneNumber, onCallWith, speakerphone, flashlight ...) keep working. phone_api in the server console prints the add-on API; Custom Apps shows how to add your own app.