beyond_lib

Beyond Lib Installation

This guide will walk you through installing Beyond Lib on your FiveM server. Beyond Lib is a framework abstraction layer that provides unified access to ESX and QB-Core functions.

Prerequisites

Beyond Lib depends on oxmysql please ensure it is installed on your server before attempting to install Beyond Library, related resources below:

Before installing Beyond Lib, ensure you have:

  • FiveM Server: Latest recommended version
  • Database: MySQL/MariaDB with oxmysql
  • Framework: ESX or QB-Core already installed and working
  • Admin Access: Server file system access

Step 1: Download Beyond Lib

  1. Download Beyond Lib from your CFX Keymaster.
  2. Extract the archive to get the beyond_lib folder

Step 2: Install Beyond Lib

2.1 Copy Files

Move the beyond_lib folder to your server’s resources directory to a location where you can control start order:

lua
   resources/
   ├── [beyond]/
   │   └── beyond_lib/
   │   └── ... other beyond resources
   └── ... rest of your resources

An example of a good location is resources/[beyond] this will allow you to control the start order of your resources within this folder and it will not attempt to load automatically, since we have not set this up before.

2.2 Configure server.cfg

Add Beyond Lib to your server.cfg. Important: Beyond Lib must be started after your framework but before any resources that depend on it.

server.cfg
ensure oxmysql
ensure es_extended OR qb-core

ensure beyond_lib

-- your_other_resources here

Step 3: Basic Configuration

3.1 Configure Beyond Lib

Edit beyond_lib/config.lua and set up your config however you would like, the default config is as follows:

beyond_lib/config.lua
Config = {}
 
-- Enable automatic updates (optional)
Config.Updates = true
 
-- Authority groups for admin functions
Config.AuthorityGroups = {
    'admin',
    'god',
    'superadmin'
}

Ensure your Authority Groups are set up correctly, this is used to determine what players have access to certain actions in Beyond Development resources. This information should be set up to match your framework’s permission system.

3.2 Framework Detection

Beyond Lib automatically detects your framework. No additional configuration is needed for standard ESX or QB-Core installations.

Framework-Specific Setup

ESX Setup

Beyond Lib automatically detects ESX. Supported versions:

  • ESX 1.2+
  • ESX Legacy
  • ESX Final

No additional configuration needed for standard ESX installations.

QB-Core Setup

Beyond Lib automatically detects QB-Core. Supported versions:

  • QB-Core 1.0+
  • All recent versions

No additional configuration needed for standard QB-Core installations.

Custom Framework Setup

For custom frameworks, you may need to create custom adapters. We do not support custom frameworks, but you can create your own adapters if you need to within the beyond_lib/frameworks folder.

Common Installation Issues

Framework Not Detected

Problem: [beyond_lib] No compatible framework found

Solutions:

  • Ensure your framework is started before Beyond Lib
  • Check framework resource name matches standard names
  • Verify framework is properly installed and working

Resource Load Order Issues

Problem: Resources using Beyond Lib fail to start

Solutions:

  • Ensure Beyond Lib is started after your framework
  • Check server.cfg load order
  • Verify Beyond Lib started successfully
  • Ensure the script is named beyond_lib

Database Connection Issues

Problem: Database-related errors

Solutions:

  • Ensure oxmysql is installed and configured
  • Check database credentials
  • Verify database connectivity

Permission Errors

Problem: Authority group functions not working

Solutions:

  • Configure Config.AuthorityGroups correctly
  • Ensure ACE permissions are set up
  • Check framework permission integration

Support

If you encounter issues:

  • Check console for error messages
  • Verify framework is working correctly
  • Test with minimal resources to isolate issues
  • Join Discord for community support
  • Review documentation for common solutions

Installation complete! Beyond Lib should now be providing framework abstraction for Beyond resources on your server.

PreviousGetting Started
NextConfiguration