Browse docs

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.

Filesystem permissions

When Sky Base saves files for another resource, FiveM requires an explicit write permission. Add one line for each installed Sky resource that uses file storage to server.cfg, before ensure sky_base. For example:

server.cfg

add_filesystem_permission sky_base write sky_jobs_base
add_filesystem_permission sky_base write sky_ambulancejob

Use the complete resource list to select the lines for your server, then perform a full server restart. These filesystem permissions are separate from the ACE permissions used for administrator commands.

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.
notification: Choose the notification interface. "default" uses Sky; supported external choices are listed in the UI integration table.
helpnotify: Choose the keyboard-prompt/TextUI interface independently from notifications. The shipped value is "default".
progressbar: Choose a supported progress provider. "auto" detects an installed provider at startup; progress has no built-in Sky fallback.
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.
target: Select an optional target system, or keep "none" for marker and keyboard interactions.

Additional Configuration Files

sky_base includes several other important configuration files:

functions.lua: Edit public client behavior such as multi-action help. Notification and single-action prompt adapters have their own files below.
sv_functions.lua: Modify server-side functions, like giving vehicles.
sv_config.lua: Configure webhooks. For more details, visit the webhooks documentation page.
config/integration/banking folder: Configure external society banking adapters or use the internal job banking backend.
config/integration/ folder: Provider adapters are grouped by feature, such as inventory, phone, garage, fuel and billing.
config/integration/notification, helpnotify and progress folders: Configure the matching UI providers or implement the supplied custom templates. See supported providers and setup.
config/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

Common Console Errors

Understand frequent FiveM and Sky-Systems console errors and what they usually mean.

Changelog

Full change history for sky_base.