CAD Display

This submodule enables your passengers to view your CAD screen in real time via an in-vehicle laptop or your tablet

Activation Guide

1. Download and Install the Core

If you haven't already, be sure to install and configure the SonoranCAD Core first.

2. Activate the Submodule

Follow the submodule activation guide for the caddisplay & tablet submodules.

3. Configuration

Default caddisplay_config.lua

--[[
    Sonoran Plugins

    CAD Display Submodule Configuration
]]

local config = {
    enabled = true,
    pluginName = "caddisplay",
    pluginAuthor = "Sonoran Software Systems",
    configVersion = "1.0",

    lang = {
        addNewDisplayHelp = "Open the menu to begin placing a CAD display",
        vehNotCompatible = "This vehicle is not compatible with the CAD display placement system!",
        vehAlreadyDisplay = "This vehicle already has a CAD display placement!",
        menuHeader = "Sonoran CAD Display",
        creditsPanel = "Made by",
        spawningSubMenu = "CAD Display Spawning",
        attachingSubMenu = "Attaching",
        deletionSubMenu = "Remove placement?",
        attachMenuButton = "Attach CAD Display",
        deleteMenuButton = "Delete CAD Display Placement",
        spawnMenuButton = "Spawn CAD Display",
        deletionConfirmationButton = "Yes, remove from all of these vehicles",
        deletionCancelButton = "Cancel",
        deletionCancelled = "CAD display deletion cancelled",
        noDisplayFound = "No CAD display found in this vehicle!",
        modelComboBox = "Model:",
        vehAlreadyDisplayNoti = "~r~This vehicle already has a CAD display placement",
        notInVeh = "~r~You must be in a vehicle!",
        vehicleBone = "CAD Display - Vehicle Bone",
        object = "Object:",
        vehicleBoneComboBox = "Vehicle Bone",
        objectName = "Sonoran CAD Display",
        attachButton = "Attach",
        detachButton = "Detach",
        confirmPlacementButton = "Apply to all of this vehicle model",
        cannotGoFaster = "~r~You cannot go any faster!",
        cannotGoSlower = "~r~You cannot go any slower!"
    },

    commands = {
        cadDisplayMenu = "caddisplay",
        restricted = true -- should the CAD display menu be restricted?
    },

    permissionMode = "ace", -- Available Options: ace, framework, custom

    -- Ace Permissions Section --
    acePerms = {
        aceObjectUseMenu = "sonoran.caddisplay", -- Ace to open/attach CAD displays
        aceObjectAdminUseMenu = "sonoran.caddisplay.admin" -- Ace to save/delete placements for vehicle models
    },

    -- Framework Related Settings --
    framework = {
        frameworkType = "qb-core", -- Options: esx or qb-core
        civilianJobNames = {"unemployed"}, -- Jobs allowed to open the menu
        adminJobNames = {"admin"}, -- Jobs allowed to save/delete placements
        useCivilianJobListAsBlacklist = false -- Treat the civilian job list as a blacklist rather than whitelist
    },

    -- Configuration For Custom Permissions Handling --
    custom = {
        checkPermsServerSide = true, -- If true the permission event will be sent out to the server side resource
        permissionCheck = function(_, type) -- Always called server side.
            if type == 0 then -- Check permission to use the menu
                return true or false -- Return true if permitted, false otherwise
            end
        end
    },

    general = {
        notificationType = "native", -- Options: native, pNotify, okokNotify
        useAllowlistAsBlacklist = false -- If true, allowlistedCars is treated as a blacklist
    },

    -- Vehicles with built-in laptop screens you want to skin with the CAD DUI
    -- Each entry needs:
    --   vehicle         - spawn code (model name) for the vehicle
    --   screenTexture   - texture name on the built-in laptop model to replace with the DUI
    --   textureWidth    - optional width of the built-in texture in pixels (used to scale the DUI), default 512
    --   textureHeight   - optional height of the built-in texture in pixels (used to scale the DUI), default 256
    builtinScreens = {
        -- Example:
        -- {vehicle = "POLICE", screenTexture = "laptop_screen", textureWidth = 512, textureHeight = 256}
    },

    allowlistedCars = {
        "POLICE",
        "POLICE2",
        "POLICE3",
        "POLICE4",
        "FBI",
        "FBI2",
        "SHERIFF",
        "SHERIFF2"
    },

    -- Interaction settings
    interactKey = "G", -- Default key mapping for interaction (RegisterKeyMapping)
    interactControl = 47, -- Fallback control code (INPUT_DETONATE) - avoid horn (E)
    interactRange = 1.5, -- Distance in meters to allow interacting with the laptop
    requestAcceptKey = "Y", -- Key to accept a control request
    requestDenyKey = "L" -- Key to deny a control request
}

if config.enabled then Config.RegisterPluginConfig(config.pluginName, config) end

4. Usage

4a. Prop Spawning

You can spawn a CAD Display laptop prop using the in-vehicle menu, which is accessed via the /caddisplay command. By default, this command requires the sonoran.caddisplay permission.

Following the menu instructions, you can customize the laptop’s placement within your vehicle. Once you are satisfied with the placement, you may close the menu and the display will remain in your vehicle for the duration of its spawn.

If you have the sonoran.caddisplay.admin permission, you also have the option to save the placement for all vehicles using that spawn code. This ensures the placement is automatically applied to all future spawns of that vehicle.

Sonoran CAD - CAD Display - Main Menu

Sonoran CAD CAD Display - Spawning Menu

Sonoran CAD - CAD Display - Attaching Menu

Sonoran CAD - CAD Display - Delete Menu

4b. Using Built-in Laptops

You can also use your vehicle’s built-in laptop as the CAD Display, without spawning a separate laptop prop.

4 b. Continued

1. This option requires additional configuration and third-party software. To begin, navigate to the caddisplay_config.lua file located in the /sonorancad/configuration folder. The builtinScreens section of this configuration file is where you define vehicles equipped with built-in laptops.

2. To obtain the texture name you will need to use a third-party software such as OpenIV.

3. Within OpenIV, click File in the top-right corner, then select Open Folder and navigate to the folder containing your vehicle files

OpenIV - Open Folder Button

OpenIV - File Explorer

1. Once OpenIV opens your selected folder, you will see your vehicle files. From here, open the SPAWNCODE.ytd file. A .ytd file is a texture dictionary that contains the textures used by the vehicle, such as screens, decals, and interior displays. For this tutorial, the spawn code used is b3.

OpenIV - YTD Viewer

1. Within the OpenIV Texture Viewer, scroll through the textures and locate the laptop screen texture. In the case of b3, the texture name is laptop_screen. Some vehicles may include multiple screen textures; ensure you select the one used for the in-vehicle laptop display.

OpenIV - YTD Viewer - Laptop Screen Texture

1. Now that all required information has been gathered, you can begin adding it to the configuration. Be sure to note the texture’s dimensions as shown in OpenIV, as this information is required for proper display.

   Important: The texture dimensions must match exactly, or the display may not render correctly.

   For the tutorial vehicle, the configuration should appear as follows:

builtinScreens = {
    {
        vehicle = "b3",                 -- Vehicle spawn code
        screenTexture = "laptop_screen",-- Texture name from the .ytd file
        textureWidth = 256,             -- Texture width (must match OpenIV)
        textureHeight = 256             -- Texture height (must match OpenIV)
    }
},

4c. Using the Screen

While inside a supported vehicle, either with a placed laptop prop or a configured built-in screen, look at the laptop and press the default keybind G to take control of the display.

This submodule also allows the CAD Tablet to mirror your screen in real time. Once the tablet is active and your CAD is open, you and others around you will see your CAD screen mirrored onto the tablet prop in your hand.

4d. Passing Laptop Control

To transfer control of an in-vehicle laptop, have your passenger look at the laptop and press the default keybind G. This will send a control request to the current user.

Only one player may control the laptop at a time.

You can then press Y to accept the request or L to deny it. If accepted, the laptop will begin mirroring the passenger’s CAD Tablet.