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.

Key Configuration Options

  • debug: Enables debug mode. When true, additional logs and error details will be shown in the console — please use this when you send us an error so we get more information.
  • locale: Set the language for the locale file from config/locales/ for all our scripts.
  • useMph: Set to true to use miles per hour (MPH), or false to use kilometers per hour (KMH) for speed displays.
  • 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 using RGB values.
  • enableOXTarget: Enables or disables the OX Target system, which replaces help notifications with a more advanced targeting system.

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: 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.

Support

Need help? Our support team is always ready to assist

Join Discord