Pulse Phone docs

Requirements

For Pulse Phone 1.5.23 min readUpdated

2. Requirements

What Required? What happens without it
OneSync on Required The start-up check fails with OneSync ... off. Add set onesync on.
Game build 2699 or newer Required The handset model does not stream. Set sv_enforceGameBuild.
oxmysql (or ghmattimysql, mysql-async) on MariaDB 10.6+ or MySQL 8 Recommended With no SQL resource running, data is kept in the server's key/value store. It persists, but you can't query it, and past about 30 players you should use a database.
A voice script: pma-voice, mumble-voip, SaltyChat, TokoVOIP or YACA Recommended Calls connect but carry no audio.
screenshot-basic Recommended (the standard resource, or the lighter copy in your download: see the quick start, step 6) The camera frames shots but cannot save photos.
A framework Optional The phone runs standalone: phones keyed to the player's licence, and the phone keeps its own bank.

A complete server.cfg block:

server.cfg
set onesync on
set sv_enforceGameBuild 2699        # or newer

ensure oxmysql
# ... your framework, then your inventory, banking, garage and housing scripts ...
ensure pma-voice
ensure screenshot-basic
ensure phone
# ... scripts that use the phone ...

The database. Which store the phone uses is decided at every start:

Your server Where the phone keeps its data
oxmysql, mysql-async or ghmattimysql running, and the database answers The database. Tables are created on the first start and new ones added by themselves after every update.
No SQL resource running at all The server's key/value store, automatically. It persists across restarts but can't be queried. Past about 30 players, or if the console warns that saving the store is slow, use a database.
A SQL resource running, but the database does not answer within 30 seconds Nothing is stored until it answers. The console says why, and the phone retries every 15 to 60 seconds and finishes starting by itself once the database answers.

In the last case you can tell the phone to use the key/value store instead with set phone_db_fallback "kvp" in server.cfg; that data stays in the key/value store and is never copied into the database later, so use it on a test server, not as a way round a broken connection. Every query also has a 10-second deadline: a query the database never answers is reported as failed to the app that asked, and the console names that query once.

Supported databases: MariaDB 10.6 or newer, or MySQL 8.0 or newer. Each release's phone.sql is checked on a fresh MariaDB database running MySQL 8's SQL mode before the package is built. Older versions (MariaDB 10.4 or 10.5, MySQL 5.7) are not tested and not supported, even where they may work.

phone.sql is only for hosts that don't let a resource create tables. No collation is named in it: your server's utf8mb4 default applies, as it does when the phone creates the tables itself. It is safe to run on an existing database, and running the new one again after an update adds only what is missing.

sv_stateBagStrictMode can stay on. Everything other players see of a phone (the hold animation, the handset in the hand, its screen, the flashlight) is set by the server after it checks the value, never by the player's game.

Switching phones

Another phone's tables. If a phone you used before left tables with the same names (for example phone_messages), they are renamed to old_<name> at first start, so Pulse Phone can create its own. Nothing is deleted. If your database user may not rename tables, the start-up check shows [FAIL] Database with the table names: give the user ALTER rights, or rename each to old_<name> in your database tool (HeidiSQL, phpMyAdmin), and restart.

This rename is the one change Pulse makes to tables it does not own, and it can also move a table another script uses under the same name (the console names it). Back up the database before the first start. To undo a rename, stop the server and remove ensure phone first, then restore the backup or swap the names back: Undoing a rename.