Documentation

Setup

Steps for setting up your zyke_lib resource

#Installation

#Download

Download zyke_lib.zip from the latest release.

Download the release .zip, not GitHub's green Code → Download ZIP button. The source code is missing the built files the resource needs.

#Dependencies

Install your framework (ESX, QBCore, or Qbox) and oxmysql. ox_lib is optional. See Dependencies.

#Resource

Place the resource in your server's resources folder as zyke_lib. Keep the folder name as it is, since every Zyke resource loads it by name.

#Start Order

Start zyke_lib after your framework, database, and inventory, and before every Zyke resource:

cfg
ensure oxmysql
ensure ox_lib
ensure es_extended # or qb-core / qbx_core
ensure ox_inventory # your inventory
ensure zyke_lib

# Zyke resources after this line

See Resource Starting Sequence.

#Information

This guide will cover everything you need to know in order to set up your zyke_lib resource. If you wish to have this guide expanded further or you need assistance, please open a ticket in our Discord.

#Config

The first step is to head over to zyke_lib/shared/config.lua. This file is your main configuration. If you wish to understand all values, they are explained in Config.

#Fetching framework

Your framework will fetch automatically, since the v1.0.0 release. However, if this doesn't work you may need to add your framework manually.

Head into zyke_lib/shared/framework.lua, in here you can configure the way your framework fetches as well as your file name. Note that the framework needs to be labeled either "QBCore" or "ESX", but you can change the way the framework fetches.

If you need further assistance, please visit our [Discord](https://discord.zykeresources.com).

#Other

If you are experiencing issues using any of our resources, we recommend going through our functions and syncing them with your server modifications. Servers that use custom inventories, progressbars etc may require other values, which you would need to add yourself.