Documentation

Installation

General installation guide for Pepper resources.

The exact steps are in each product's documentation. In general:

1. Download

Download the resource from the Cfx.re Portal.

2. Extract

Extract the archive. The folder name (e.g. pepper_garage) is the resource name – do not rename it unless the product docs explicitly allow it.

3. Install dependencies

Install every resource listed under "Dependencies" in the stated minimum version, typically:

  • ox_lib
  • oxmysql (if a database is used)
  • your framework (ESX Legacy, QBCore or Qbox), unless standalone

4. Copy to your resources folder

Copy the folder e.g. to resources/[pepper]/pepper_garage.

5. Adjust the configuration

Edit config/config.lua (and config/*.lua if present). Language via Config.Locale or ox_lib.

6. Import the database (if included)

If an install/*.sql file is included, import it into your database. Many Pepper resources create their tables automatically on first start – the product docs will say so.

7. Update server.cfg

Start the resource after its dependencies:

ensure ox_lib
ensure oxmysql
ensure es_extended   # or qb-core / qbx_core
ensure pepper_garage

8. Restart the server

A full restart is recommended (not just refresh/restart of the resource the first time).

9. Test the installation

Check the server console for errors and test the commands described for the product. Having problems? See Troubleshooting.


Found a mistake? Report it on Discord.