πŸ’‘Installation

Our library will always remain open-source, allowing you to add your own functions, frameworks, inventories, and more.

All available options are commented in the configuration section below. If you're using a resource that we don't currently support, please feel free to suggest it in our Discord so we can consider adding it as a supported resource.

  1. Configure elite-lib inside "shared/config.lua".

    Config.Settings = {
        Debug = true,
        Framework = "auto", --[[
            Options:
                "auto",
                "esx",
                "qb",
                "qbox",
                "custom"
        ]]
        Inventory = "auto", --[[
            Options:
                "auto",
                "ox_inventory", (Recommended)
                "qb-inventory",
                "esx", (native, not recommended)
                "qb", (native, not recommended)
                "custom"
        ]]
        Target = "auto", --[[
            Options:
                "auto",
                "ox",
                "qb",
                "custom"
        ]]
        Database = "auto", --[[
            Options:
                "auto",
                "esx",
                "qb",
                "qbox",
                "custom"
        ]]
        Progressbar = "auto", --[[
            Options:
                "auto",
                "es_extended",
                "progressbar", (QBCore)
                "ox_lib",
                "custom"
        ]]
        Menu = "auto", --[[
            Options:
                "auto",
                "esx_default_menu",
                "ox_lib",
                "qb-menu",
                "custom"
        ]]
        Input = "auto", --[[
            Options:
                "auto",
                "esx_menu_dialog", (NOT RECOMMENDED)
                "ox_lib",
                "qb-input",
                "custom"
        ]]
        Utils = "utils" -- Don"t change this!
    }
  2. Ensure elite-lib in your server.cfg before any other resource using the resource, but efter your framework is ensured. It should look like this:

ensure qb-core
# elite-lib should always be ensured after your framework.
ensure elite-lib
# elite-lib should always be ensured before any resource that uses elite-lib.
ensure elite-geopals
ensure elite-hunting
  1. Start the server and enjoy!

Last updated