Frameworks

On this page, you will find everything you need to set up the framework integration of a Garmingo product.

Framework Library

The Framework Library is Garmingo's in-house interface to manage different frameworks and ensure consistent integration across all products. All content on this page refers exclusively to the Framework Library.

Supported Frameworks

• ESX Legacy
• ESX Infinity
• QBCore
• Custom Framework
• Standalone

Configuration File

All settings of the Framework Library can be found in the respective product folder in the framework.json file and here as an example:

{
    /*
     * (C) Copyright 2024 Garmingo UG - All rights reserved
     * This is the default configuration file for configuring framework integrations.
     * By default, the automatic framework detection is active, which tries to detect the framework based on common interfaces.
     * If you have an anti-cheat measure that also prohibits server-side access to these interfaces, you should urgently deactivate this feature.
     * You should also note that only one framework may be activated at a time.
     */

    /*
     * When enabled the resource will try to automatically detect frameworks on server-side startup.
     * If a framework is successfully detected, this option disables itself and must be manually enabled for re-use.
     */
    "AutoDetect": true,

    /*
     * This option specifies which framework to use.
     * To select a framework enter its name as defined below (NOT THE NUMBER).
     * The following options are included in this version of the Framework Library:
     * 1. None (Standalone)
     * 2. ESX Infinity
     * 3. ESX Legacy
     * 4. QBCore
     * 5. Custom
     */
    "Framework": "None",

    /*
     * This option is used to specify a custom ESX shared object event.
     * Only for ESX Infinity.
     */
    "ESXEvent": "esx:getSharedObject",

    /*
     * Below are the settings for using a custom framework. If you are not using a custom framework you do not have to change anything.
     * How to use: Create exports for the given functionality and enter the export name here. You will find information on the export parameters and their exact function on our docs page: https://docs.codineerdigital.com/purchase-and-installation/frameworks#setting-up-a-custom-framework
     * You can learn more about FiveM exports here: JavaScript: https://docs.fivem.net/docs/scripting-reference/runtimes/javascript/functions/exports/
     * Please note that we offer no support for implementing your custom framework!
     */
    "ExportResource": "CustomFramework"
}

Settings

AutoDetect

AutoDetect specifies if the Framework Library should try to automatically detect the used framework. It only works for ESX Legacy, ESX Infinity, and QBCore.

Note

Sometimes AutoDetect falsely identifies ESX Legacy as ESX Infinity. In such cases, a manual change from the one to the other is required.

Framework

This field sets the framework to use. It is either set by AutoDetect or manually by you. Please note that if AutoDetect is set to true, it will overwrite this setting.

You can choose from:

{
    "Framework": "ESX Legacy",
    "Framework": "ESX Infinity",
    "Framework": "QBCore",
    "Framework": "Custom" // Custom Framework,
    "Framework": "None" // Standalone,
}

ESXEvent

This field sets the ESX Shared Object Event and is only needed for ESX Infinity.

Note

Warning: Trying to enter the ESX Legacy Export will break the configuration. There is no need to specify the Export!

ExportResource

This field specifies which resource is exporting the framework functions. It is only needed for Custom Framework setups.