ton-jobblips

Enable job blips for some of your jobs, working with ESX, QBCore or a custom framework.

Adding the resource

1. Go to the Releases part of the repository and download the file.

2. Unzip the file and place it in your resources folder.

3. In the server.cfg, include this command: ensure ton-jobblips

The config.lua

The config looks like this:

CONFIG = {
    ---The rate of refresh of the unit blips.
    ---I would recommend letting this value to 1500-3500 due a high value can cause a network thread overflow.
    REFRESH_RATE = 3000,

    ---The colors that the units can set to theirselves when using the blips.
    ---You can check what colors are available here: https://docs.fivem.net/docs/game-references/blips/#blip-colors
    ---You can change the index of the color to make it a more accessible command parameter.
    ALLOWED_COLORS = {
        ['1']  = 1,
        ['3']  = 3,
    },
    EVENT_PREFIX     = '__jobblips_ton__:',
    DEBUG_ENABLED    = true,
    ---Here include first the framework and then the framework resource name like in the example below. If you use QB for example, add {'qbcore', 'qb-core'} instead of the default one.
    FRAMEWORK        = {'esx', 'es_extended'}, ---'esx', 'qbcore' or 'custom (If you choose custom, you need to edit the file named `framework.lua` in the `server` folder)'.
    JOBS             = {'police', 'ambulance'}, ---The jobs that need to see the blips to cooperate between themselves.
    LOCALES          = {
        ['NOT_ALLOWED'] = 'You are not allowed to use this command',
        ['NOT_COLOR']   = 'This color does not exist',
    },
    COMMANDS         = {
        {'enablerefs', 'Listen references without appearing in the map'},
        {'ref', 'Enable/disable references'},
        {'updatecolor', 'Update the color (Requires the color argument)'},
        {'removerefs', 'Disable and remove references'},
    }
}

Here you can edit this value according to your server preferences, the config.lua is made for easy editing how the resource works. I don't recommend touching other parts of the resource if you don't know what are you doing.

Framework

The resource works with QbCore and ESX just changing a config. If you wan't to use a custom framework, you should go to the framework.lua files in the server and the client and add your framework events, methods and exports.

Notes

Yes, I know this is not a very usefull documentation because this is a simple resource and how it works is explained in the config. If you need something else I can help you in my developing Discord community which you can find here: https://discord.gg/ucAfcAdwXD (We mainly work with Lua, C#, Typescript and React so we can all learn and share knowledge 😄)