> For the complete documentation index, see [llms.txt](https://tweak5m.gitbook.io/tweak5m-docs/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://tweak5m.gitbook.io/tweak5m-docs/tweak5m-library/installation.md).

# Installation

### Install

1. Download and extract the Library.
2. Put the folder named exactly `cfx-tweak-lib` in your server resources directory.
3. Install and start `ox_lib`.
4. Choose your framework and providers in `config.lua`. Start the selected framework and providers before the Library.
5. Add `ensure cfx-tweak-lib` before the Tweak5M scripts that depend on it.

The Library has no SQL file, inventory items or inventory images to import. Each consuming script lists its own additional requirements.

### Framework selection

Use `esx`, `qb`, `standalone`, or `auto` in the Library configuration. Choose explicitly if more than one framework is installed. QBCore selection does not replace OX inventory or target integrations; NOIR requires its documented OX dependencies and a compatible framework integration.

### Resource name

Keep the exact folder name. Renaming the Library prevents it from operating and breaks dependent resource references.

## First installation walkthrough

1. Back up any existing Library configuration.
2. Extract the archive and locate the folder containing `fxmanifest.lua`.
3. Place that folder in your server's resources directory as `cfx-tweak-lib`. Avoid an extra nested resource folder.
4. Confirm ox\_lib and the selected framework/providers are installed.
5. Open the Library's `config.lua`, choose the framework, then save.
6. Add `ensure cfx-tweak-lib` after dependencies and before consuming scripts in server.cfg.
7. Restart during maintenance, check the first startup errors, then use a consuming script to check notifications and prompts.

## SQL and inventory setup

There is no Library SQL file to import and no Library inventory item to register. Follow each consuming script's SQL, item and icon instructions separately.

## Copyable startup example

For an ESX NOIR installation, start your inventory/target/database providers as shown in the pack's guide. The Library itself goes after its providers and before consuming scripts:

```cfg
ensure ox_lib
ensure cfx-tweak-lib
```

This small block does not replace a consuming product's full dependency list. Install the Library only once. There is **no Library SQL or inventory-item block** to paste.