📕User guide

User guide on how to use the Dynasty Notify

1. Open the scoreboard

You can select with which key open the scoreboard

Config.ScoreBoardKey = "z"

2. Server Max Players

You can manually write how many Server Max Players the scoreboard shows in case your servers has not stated it in server.cfg

Config.MaxPlayers = 1000 

3. On duty police export

In case you have an export that obtains all the police players that are "onduty" you can use it here. In case you don't have, the scoreboard will show how many police players are online

Config.CurrentPoliceExport = nil

4. Default duty status

You can use "on" if you want the status to be green or "off" if you want it to be red in case you don't have an export that obtains the duty status of a job

Config.DefaultDuty = "on"

5. Highlighted illegal actions

In Config.IllegalActions you add or remove items to the table. In order you select in which place of the table it appears. minimumPolice are the minimum police officers required to the robbery or illegal action to be active. label is the displayed name in the scoreboard an image is the image you want to use. The image hast to be inside images folder.

Config.IllegalActions = {
    storerobbery = {
        order = 1,               -- Place in the list
        minimumPolice = 3,       -- Minimum required police in the server required to the event
        label = "Store Robbery", -- Name displayed in the UI
        image = "store.png"      -- Image
    },
    liquor = {
        order = 2,
        minimumPolice = 3,
        label = "Liquor shop",
        image = "liquor.png"
    },
    jewelry = {
        order = 3,
        minimumPolice = 6,
        label = "Jewelry",
        image = "jewelry.png"

    },
    fleeca = {
        order = 4,
        minimumPolice = 9,
        label = "Fleeca",
        image = "fleeca.png"

    },
    pacific = {
        order = 5,
        minimumPolice = 10,
        label = "Pacific",
        image = "pacific.png"

    },
}

6. Displayed jobs

Config.DisplayedJobs = {
    police = {
        order = 1,                        -- Place in the list
        label = "Police",                 -- Name displayed in the UI
        onDutyExport = nil,               -- Export that get how many members of this job are on duty. Show all online players with this job if there is no export.
        icon = "fa-solid fa-user-shield", -- Icon
    },
    ambulance = {
        order = 2,
        label = "Ambulance",
        onDutyExport = nil,
        icon = "fa-solid fa-truck-medical",
    },
    mechanic = {
        order = 3,
        label = "Mechanic",
        onDutyExport = nil,
        icon = "fa-solid fa-wrench"
    },
    taxi = {
        order = 4,
        label = "Taxi",
        onDutyExport = nil,
        icon = "fa-solid fa-taxi"
    },
    -- electrician = {
    --     order = 5,
    --     label = "Electrician",
    --     onDutyExport = nil,
    --     icon = "fa-solid fa-bolt"
    -- },
}

7. Default Configurations

Config.DefaultConfigs = {
    ---@Background
    background1 =
    "linear-gradient(158deg, rgb(29, 53, 70, 0.4) 0%, rgb(26, 41, 54, 0.4) 50%, rgba(25, 37, 52, 0.4) 100%)", -- Boxes background
    background2 =
    "linear-gradient(0deg, rgba(37, 55, 71, 0.4) 0%, rgba(62, 78, 93, 0.4) 47%, rgba(37, 55, 71, 0.4) 100%)", -- Players background
    bodyBackground = "linear-gradient(158deg, rgba(3, 0, 19, 0.96) 0%, rgba(0, 15, 6, 0.96) 100%)",           -- Body background

    ---@Color
    color1 = '#07e6a7', -- Manages almost every
    color2 = '#f1f1f1', -- Server Subtitle and other titles
    color3 = '#27565a', -- Icons background

    ---@Logo
    logo = "../images/dynasty_logo.png", -- Add logo to dynasty_scoreboard/html/images

    ---@ServerTitle

    serverTitle = "Dynasty",    -- Server title
    serverSubtitle = "Roleplay" -- Server subtitle
}