Skip to main content

Configuration

All fiveLib resources are built with a config-first approach. Server owners can customize behavior without touching core logic or editing client/server files.

Config Structure​

Depending on the resource, configuration files may be located in:

  • config.lua
  • shared/config.lua

All important values are centralized and clearly commented for ease of use.

Common Settings​

Most fiveLib resources allow you to configure:

  • Framework selection: qb, qbox, or esx.
  • Permissions: Job restrictions and access rules.
  • Timers: Cooldowns and durations.
  • Economy: Rewards, prices, and success chances.
  • Interactions: Target, text UI, or menu systems.
  • Adapters: Inventory and notification system integrations.

Framework Compatibility​

Resources automatically adapt based on your selected framework:

Config.Framework = 'qb' -- qb / qbox / esx

No manual edits inside core files are required for basic framework integration.

Best Practices​

  • Only Edit Config: Always adjust values only inside the config file.
  • Avoid Core Edits: Avoid editing core logic unless explicitly documented or you are a developer.
  • Restart After Change: Restart the resource after making changes to the config: 
    restart fiveLib-resourceName

Updates​

Configuration files are designed to remain forward-compatible. When updating a resource, only newly added config options may need review.