Skip to main content

Introduction

sky_base is a crucial component for all Sky-Systems scripts, designed to enhance performance, streamline configuration, and provide a unified framework for easier management. This guide will introduce you to sky_base and walk you through its configuration and use.

What is sky_base?​

sky_base is a library that all Sky-Systems scripts rely on for optimal performance and simplified configuration. It includes global settings, functions, and framework-specific code, making it easier to manage and customize multiple scripts across your FiveM server.

Configuration​

The primary configuration file for sky_base is config/config.lua. Below is an overview of its settings:

config/config.lua​

Config = {
    -- Global settings for all scripts
    framework = "esx", -- esx, qb, custom - can be customized in config/framework
    sql = "oxmysql", -- oxmysql or mysql-async
    locale = "en", -- locale file to use from config/locales/

    interactionDistance = 1.2, -- distance from where you can interact with a marker / npc
    defaultBlipSize = 0.8,
    defaultMarkerColor = {
        red = 0,
        green = 255,
        blue = 255,
    },
    enableOXTarget = false, -- enable the OX Target system -> replaces help notification
}

Key Configuration Options​

  • framework: Choose between esx, qb, or custom. This determines which framework-specific code to use.
  • sql: Select your SQL system (oxmysql or mysql-async).
  • locale: Set the language for the locale file from config/locales/ for all our scripts.
  • interactionDistance: Defines the distance from which players can interact with markers or NPCs.
  • defaultBlipSize: Sets the default size for blips on the map.
  • defaultMarkerColor: Customizes the color of markers (RGB values).
  • enableOXTarget: Enables or disables the OX Target system, which replaces help notifications.

Additional Configuration Files​

sky_base includes several other important configuration files:

  • functions.lua: Edit non-framework-related client functions such as notifications and help notifications.
  • sv_functions.lua: Modify server-side functions, like giving vehicles.
  • sv_config.lua: Configure webhooks. For more details, visit the webhooks documentation page.
  • framework/ folder: Contains esx.lua, qb.lua, and custom.lua. These files hold framework-specific code, which is open-source for customization to fit any framework.

Troubleshooting​

For any base related issues encountered during the installation or update process of our scripts, ensure that:

  • You have the latest version of sky_base, reinstall it to be sure.
  • The correct framework is set in sky_base config.

For further assistance, please contact our support team on discord.

With sky_base, managing and configuring multiple scripts becomes easier, allowing you to focus on enhancing the gameplay experience on your FiveM server.