Suty Phone

Installation

Installation

📁 What's in your package

Folder What it is
suty-phone The phone
suty-phone-assets Map tiles of the Maps and Garajes apps
suty-phone-props Phone, box and MagSafe models, plus the phone animations

Keep the folder names exactly as they are: a renamed copy does not start.

Inside suty-phone/install/:

File What it is for
suty-phone.sql Every table of the phone. Safe to run again: it never deletes or changes data
ox_inventory/items.lua + .png The items for ox_inventory
qb-inventory/items.lua The same items in QBCore's format (qb-inventory, ps-inventory, lj-inventory, qs-inventory)
esx/items.sql The same items for ESX's own inventory
server.cfg Start order, convars and ACE lines to copy into your server.cfg
custom-apps.md How other resources add their own app (Custom apps)
suty-phone-app-template/ An example custom app: copy it into your resources to start your own

suty-phone/locale/en/lua.lua holds the English texts, used with Config.Language = 'en' (Configuration). It isn't encrypted, so you can change any wording.

1. Resources

Copy the three folders into your resources folder.

2. Database

Select your server's database in HeidiSQL (or any SQL client) and run install/suty-phone.sql. The phone also creates any missing table when it starts.

MariaDB is required: the tables use ADD COLUMN IF NOT EXISTS, which MySQL doesn't have.

3. Items

ox_inventory

Copy the entries of install/ox_inventory/items.lua inside the return { ... } of ox_inventory/data/items.lua, copy the .png files into ox_inventory/web/images/, and restart ox_inventory.

QBCore inventories

Copy install/qb-inventory/items.lua into your item list (qb-core/shared/items.lua, or the inventory's own) and the .png files into the inventory's images. The phone items must stay unique = true.

ESX's own inventory

Run install/esx/items.sql.

The items

Item What it is
phone_cosmicorange, phone_burgundy, phone_silver, phone_barbiepink Premium phones
phone_air_skyblue, phone_air_lightgold, phone_air_spaceblack Air phones
phone_duo_blancoperla Duo, the foldable phone
phonebox_<colour> A box for each phone, opened with an unboxing animation
air_magsafe_battery MagSafe battery, charges the phone in use
rice_bag Dries a wet phone
phone_repair_kit Repairs water damage and a broken screen
klaro_tablet The Klaro employee's tablet, to activate lines

4. server.cfg

Copy what you need from install/server.cfg. suty-phone starts after everything it uses:

ensure oxmysql
ensure ox_lib
ensure qbx_core            # or qb-core / es_extended
ensure ox_inventory
ensure ox_target
ensure pma-voice
ensure suty-phone-assets
ensure suty-phone-props
# Optional, before suty-phone when you use them:
# ensure Renewed-Banking
# ensure illenium-appearance
ensure suty-phone

On QBCore with ox_inventory, don't start qb-inventory, and add setr inventory:framework "qb" before ox_inventory.

Keys and tokens go in server.cfg with set, never setr (with setr every player receives them):

# Photos and videos on Fivemanage (recommended)
set suty_phone_fivemanage_key "your Fivemanage API key"

# Video calls through Cloudflare TURN (hides the players' IPs, works behind strict NAT)
set suty_phone_cf_turn_key "TURN key id"
set suty_phone_cf_turn_token "TURN key API token"

# Discord logs (or paste them in server/logs_config.lua)
set suty_phone_logs_default "https://discord.com/api/webhooks/..."
set suty_phone_logs_bot_token "bot token, for the players' Discord pictures"

# GIFs in Messages and Wasap: this one IS setr, the phones ask KLIPY themselves
setr suty_phone_klipy_key "your KLIPY key"

⚠️ Never put a semicolon in a comment line of server.cfg: FiveM runs the text after it as a command.

📸 Photos and videos: Fivemanage (recommended)

Without it, photos and videos are saved on your server in suty-phone/media. That works, but it uses your disk and your bandwidth.

  1. Create an account at fivemanage.com and a team.

  2. In the dashboard, open Tokens › Create token and pick the Media type.

  3. Put it in server.cfg with set (never setr: only your server may read it):

    set suty_phone_fivemanage_key "your token"
    
  4. Restart suty-phone, take a photo in game and check your Fivemanage dashboard: the file shows up there.

The phone also deletes files on Fivemanage when players empty their trash, and songs on Fotogram stories need this key too.

🎞️ GIFs in Messages and Wasap: KLIPY

Without a key there's no GIF button.

  1. Sign up at partner.klipy.com and create an app to get its API key.

  2. Put it in server.cfg with setr: each player's phone asks KLIPY itself (KLIPY's rules), so this key is meant to be public:

    setr suty_phone_klipy_key "your KLIPY key"
    
  3. Restart suty-phone. The GIF button appears in Messages and Wasap.

A new KLIPY key is in testing mode: 100 searches per hour for your whole server. Before opening your server to everyone, request production access in partner.klipy.com.

Admin tools inside the apps (public places in Maps, Negocios, TuiteL moderation) use the ace command.sphoneadmin. Admins with add_ace group.admin command allow already have it; otherwise add:

add_ace group.admin command.sphoneadmin allow

5. config.lua

Open suty-phone/config.lua and go through the BEFORE THE FIRST START list at the top:

  1. Config.Carrier.store — your Klaro job, bank card item and NPC position
  2. Config.Carrier.emergencyJobs — jobs that can always be called
  3. Photo storage — the Fivemanage key in server.cfg, or read Config.Media
  4. Config.Maps.places — public places in Maps
  5. Config.VerifyCommands.licenses — who can give verified badges
  6. Config.Gifs — the KLIPY key
  7. Webhooks in server/logs_config.lua
  8. Config.RepairShop.minutes — how long a repair takes

Everything else works with its defaults. See Configuration.

6. Start

Start the server and read the console. Lines starting with [suty-phone] say what it found (framework, inventory, bank, garages) and anything that's missing, for example a Fivemanage key or a webhook.

7. Give yourself a phone

/giveitem <your id> phone_air_skyblue 1

Use the item, or press F1. A new phone starts on its welcome screens: language, NubeID username, passcode, face unlock.

🔄 Updating

  • Replace the suty-phone folder and restart it. The phone updates its own tables when it starts. Running the new suty-phone.sql again is also safe.
  • Keep your config.lua and server/logs_config.lua, and compare them with the new ones for new options.
  • Never delete suty-phone/media when photos are stored on your server (Config.Media.provider = 'local'): the players' photos are in it. You can also keep them in a resource of their own (Configuration).
  • Each new version adds an entry in config_nubeos.lua, and the players' phones offer the update in Settings.
  • If you edited locale/en/lua.lua, keep your copy and add the new lines of the new one.
  • Your server console tells you when a newer version is out: Update available: vX (this server runs vY). Download it from the Cfx portal (Granted assets).
  • Never restart suty-phone-props or suty-phone-assets with players online.

🔒 What the phone sends to suty.dev

To tell you about updates, suty-phone sends suty.dev a small report when it starts and every 6 hours: its version, your server's name, the player count, the framework and a random id of the install. Nothing about your players (no names, licenses or chats). suty.dev only answers with the newest version number; it never sends code.

Merry Christmas.

From Suty.