🍏 Apps

Managing Apps

Adding/Removing Apps

You can add or remove apps from the phone by modifying the config/config.json file:

1. Navigate to config/config.json
2. Locate the apps section
3. Add or remove app entries as needed
4. Restart the phone system (preferably the whole server)

Important Notes:

• JSON files don't support comments
• If apps don't disappear after removal, ensure you completely removed the entry (don't just comment it out)
• Always validate JSON syntax after modifications

Basic App Structure

{
    "key": "app_identifier",
    "name": "App Display Name",
    "description": "App Category/Description",
    "defaultApp": false
}

App Restrictions

Job-Based Restrictions

You can restrict apps based on player jobs using disabledJobs and allowedJobs arrays:

{
    "key": "darkchat",
    "name": "Dark Chat",
    "description": "Communication",
    "defaultApp": false,
    "disabledJobs": ["police"],
    "allowedJobs": ["cartel"]
}

Restriction Types

Disabled Jobs

• Purpose: Prevent specific jobs from accessing the app
• Usage: Add job names to disabledJobs array
• Example: Police officers cannot access illegal communication apps

"disabledJobs": ["police", "sheriff", "fbi"]

Allowed Jobs

• Purpose: Only allow specific jobs to access the app
• Usage: Add job names to allowedJobs array
• Example: Only cartel members can access dark chat

"allowedJobs": ["cartel", "gang", "mafia"]

Restriction Logic

• If allowedJobs is defined: Only listed jobs can access the app
• If disabledJobs is defined: All jobs except listed ones can access the app
• If both are defined: allowedJobs takes precedence
• If neither is defined: All jobs can access the app

Store-Hidden Apps

Set "storeHidden": true to keep an app out of the App Store / Play Store. Players cannot download it there. Install it with the InstallApp server export or an installer item.

{
    "key": "ghostlink",
    "name": "Ghostlink",
    "description": "Vehicle intrusion toolkit",
    "defaultApp": false,
    "storeHidden": true
}

Ghostlink USB

Ghostlink ships hidden from the store. Using ghostlink_usb installs it on the player's phone and consumes one USB after a successful installation. The player must have a phone set up. If Ghostlink is already installed, the USB is not consumed.

1. Add the ghostlink_usb definition from inventory-items/ox-items-*.txt or inventory-items/qb-items-*.txt to your inventory's item definitions.
2. Copy inventory-items/ghostlink_usb.png into your inventory's image folder. For ox_inventory, use ox_inventory/web/images/ghostlink_usb.png.
3. Restart the server, give the player a ghostlink_usb, and use it from the inventory.

For ox_inventory, add this to ox_inventory/data/items.lua:

['ghostlink_usb'] = {
    label = 'Ghostlink USB',
    weight = 50,
    stack = true,
    close = true,
    consume = 0, -- yseries consumes one USB after a successful install
    description = 'Installs the Ghostlink toolkit on your phone',
    client = { image = 'ghostlink_usb.png' },
    server = { export = 'yseries.UseGhostlinkInstallItem' },
},

Change or disable the installer item in config/config.ghostlink.lua:

Config.Ghostlink.InstallItem = 'ghostlink_usb' -- false disables the installer item

If you change the item name, update the inventory definition to match. Keep the ox_inventory server export and consume = 0; yseries handles consumption itself.

Ghostlink Payments

Configure skill prices and currency display in config/config.ghostlink.lua:

Config.Ghostlink.CurrencyEnabled = false -- false = free skills; true = use the payment hooks
Config.Ghostlink.CurrencyLabel = 'GHOST' -- display label only
Config.Ghostlink.SkillsById.disable_engine.price = 1

When CurrencyEnabled = true, yseries calls the editable payment hooks in server/custom/functions/ghostlink.lua. Add your charging logic there: framework money, crypto, or items.

-- Balance shown in the app. Return nil to hide it and skip the early balance check.
function GetGhostlinkBalance(source)
    return nil
end

-- Charge here before the skill runs. Return true to run it, false to cancel.
function ChargeGhostlinkSkill(source, amount, skillId)
    return true
end

Custom App Integration

Adding Custom Apps

1. Create App Configuration:

{
    "key": "myapp",
    "name": "My Custom App",
    "description": "Utilities",
    "defaultApp": false,
    "allowedJobs": ["mechanic"]
}

2. Implement App Logic:
   • Create UI components in the phone interface
   • Add server-side handlers if needed
   • Implement app-specific functionality

App Development Guidelines

• Performance: Keep apps lightweight and responsive
• Consistency: Follow existing app design patterns
• Security: Validate all user inputs server-side
• Permissions: Respect job restrictions and permissions

Configuration Examples

Security App (Police Only)

{
    "key": "police_mdt",
    "name": "Police MDT",
    "description": "Law Enforcement",
    "defaultApp": false,
    "allowedJobs": ["police", "sheriff", "fbi"],
    "icon": "shield"
}

Illegal Communications (No Police)

{
    "key": "encrypted_chat",
    "name": "Encrypted Chat",
    "description": "Communication",
    "defaultApp": false,
    "disabledJobs": ["police", "sheriff", "fbi", "ems"]
}

Universal Utility App

{
    "key": "calculator",
    "name": "Calculator",
    "description": "Utilities",
    "defaultApp": true
}

Troubleshooting

Common Issues

1. Apps not appearing/disappearing:
   • Check JSON syntax validity
   • Ensure complete restart of resource/server
   • Verify app entries are properly formatted
2. Job restrictions not working:
   • Check job names match exactly (case-sensitive)
   • Verify player job data is properly set
   • Test with different job assignments
3. JSON parsing errors:
   • Use a JSON validator to check syntax
   • Remove any comments from JSON files
   • Check for trailing commas

Validation Steps

1. JSON Validation: Use online JSON validators
2. Job Testing: Test restrictions with different job roles
3. Server Logs: Check console for configuration errors
4. Player Testing: Have players with different jobs test access

Debug Commands

-- Check current player job
/job