FiveM Integration

​

Overview

• Real-time player position tracking on the live map
• Automatic identification of players by Steam ID or Discord ID
• In-game commands for creating calls, checking plates/names
• Vehicle and player synchronization
• Integration with CAD dispatch interface

​

Prerequisites

• FiveM server with admin access
• SnailyCAD instance running and accessible from your FiveM server
• Basic knowledge of FiveM resource installation

​

Installation

git clone https://github.com/SnailyCAD/fivem-integration.git

Config = {}

-- Your SnailyCAD API URL
Config.apiUrl = "https://your-cad-domain.com/api/v1"

-- Enable/disable features
Config.liveMap = true
Config.inGameCommands = true
Config.automaticLookups = true

-- Update intervals (in milliseconds)
Config.updateInterval = 500  -- How often to send player positions
Config.playerDataInterval = 5000  -- How often to update player data
}

ensure snailycad

restart snailycad

​

Player Identification

1. Steam ID: Automatically converted from hex format
2. Discord ID: If player is in your Discord server

​

Linking Players to CAD Accounts

​

Live Map Configuration

​

Server-Side Setup

Config.liveMap = true
Config.updateInterval = 500  -- Update every 500ms

​

CAD-Side Setup

​

Multiple Servers

1. Install the resource on each FiveM server
2. Add each server URL in Live Map settings
3. Dispatchers can switch between servers using the dropdown

​

In-Game Commands

​

Available Commands

-- Create a 911 call
/911 [description] [postal/location]

-- Check vehicle plate
/plate [plate_number]

-- Check person by name
/name [first_name] [last_name]

-- Check weapon serial
/weapon [serial_number]

-- Set panic button (LEO/EMS only)
/panic

-- Update status (LEO/EMS only)
/status [status_code]

​

Configuring Commands

Config.commands = {
    call911 = "911",
    plate = "plate",
    name = "name",
    weapon = "weapon",
    panic = "panic",
    status = "status"
}

-- Restrict commands to specific ACE permissions
Config.restrictCommands = true
Config.leoPermission = "snailycad.leo"
Config.emsPermission = "snailycad.ems"

​

Setting Permissions

# Grant LEO permissions to specific players
add_ace group.leo snailycad.leo allow
add_principal identifier.steam:110000XXXXXXXX group.leo

# Grant EMS permissions
add_ace group.ems snailycad.ems allow
add_principal identifier.steam:110000YYYYYYYY group.ems

​

Automatic Lookups

• Enter a vehicle (plate lookup)
• Get arrested (name lookup)
• Are searched by police (name lookup)

Config.automaticLookups = true
Config.autoPlateOnVehicleEnter = true
Config.autoNameOnArrest = true

​

Vehicle Synchronization

Config.syncVehicles = true
Config.syncInterval = 10000  -- Sync every 10 seconds

• Real-time vehicle tracking
• Automatic plate registration
• Vehicle status updates (stolen, impounded, etc.)

​

Webhooks from FiveM

Config.webhooks = {
    playerConnect = true,
    playerDisconnect = true,
    vehicleSpawn = true,
    vehicleDelete = true
}

​

Troubleshooting

​

Players Not Appearing on Map

1. Check Resource Status: Ensure resource is running (restart snailycad)
2. Verify API URL: Check Config.apiUrl is correct and accessible
3. Check Firewall: Ensure FiveM server can reach SnailyCAD API
4. Review Console: Look for errors in FiveM server console
5. Test Connection: Use curl from FiveM server to test API connectivity:
   curl https://your-cad-domain.com/api/v1/health
   

​

Players Not Linked to Accounts

1. Verify player has Steam or Discord linked in SnailyCAD
2. Check that identifiers are being sent (check console output)
3. Ensure Discord bot is in the same server as players
4. Verify Steam ID format is correct

​

Commands Not Working

1. Check Config.inGameCommands = true
2. Verify player has required ACE permissions
3. Check command syntax is correct
4. Review server console for errors

​

Connection Errors

• Ensure CORS_ORIGIN_URL includes your FiveM server IP
• Check that API is accessible from FiveM server

• If using HTTPS, ensure valid SSL certificate
• For development, you may need to allow self-signed certificates

• Check network connectivity between servers
• Verify firewall rules allow communication
• Increase timeout values in config if needed

​

Performance Optimization

​

Reduce Update Frequency

-- Lower frequency for better performance
Config.updateInterval = 1000  -- 1 second instead of 500ms
Config.playerDataInterval = 10000  -- 10 seconds

​

Limit Data Sent

-- Only send essential data
Config.sendVehicleData = false  -- Disable if not needed
Config.sendWeaponData = false   -- Disable if not needed

​

Optimize for Many Players

-- Batch updates for servers with 100+ players
Config.batchUpdates = true
Config.batchSize = 50  -- Send 50 players per update

​

Security Considerations

​

API Authentication

Config.apiToken = "your_secure_api_token"

​

Example Workflows

​

Traffic Stop Workflow

1. Officer initiates traffic stop in FiveM
2. Uses /plate ABC123 to check vehicle registration
3. Results appear in-game and in CAD
4. Dispatcher sees officer’s location on live map
5. Officer can create citations/warnings in CAD
6. Updates sync back to FiveM

​

Emergency Call Workflow

1. Player uses /911 Armed robbery at Legion Square
2. Call is created in SnailyCAD dispatch
3. Discord webhook notifies on-duty officers
4. Dispatcher assigns units to the call
5. Officers see call details and location
6. Live map shows responding units’ positions

​

Best Practices

1. Test in Development: Set up a test server before production deployment
2. Monitor Performance: Watch for performance impact on your FiveM server
3. Regular Updates: Keep the integration resource updated
4. Backup Configuration: Save your config files before updates
5. Document Permissions: Maintain a list of who has which permissions
6. Rate Limiting: Don’t set update intervals too low (causes unnecessary load)

​

Related Documentation

• Live Map - Configure live map tiles and settings
• Webhooks - Set up event notifications
• Permissions - Manage user access control