> 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/noir-collection/installation.md).

# Installation & requirements

**NOIR Collection · Version 1.0.1**

[1 · Install](/tweak5m-docs/noir-collection/installation.md) → [2 · Database](/tweak5m-docs/noir-collection/sql-setup.md) → [3 · Items & icons](/tweak5m-docs/noir-collection/items-and-icons.md) → start and test

## Before you start

| You need         | Details                                                                |
| ---------------- | ---------------------------------------------------------------------- |
| Resource folder  | `cfx-tweak-noir-collection` — keep the exact name                      |
| Shared library   | One `cfx-tweak-lib` 1.0 installation                                   |
| Dependencies     | ox\_lib, oxmysql, ox\_inventory, ox\_target, object\_gizmo             |
| Server setup     | OneSync and a working framework/inventory integration                  |
| Files to back up | Existing resource/configuration, inventory items and relevant database |

Ground-placement features use object\_gizmo.

{% hint style="warning" %}
Choose the Collection **or** the individual packs. Do not start overlapping versions together. Moving an existing installation between them needs an explicit item-export and metadata/stash migration plan; stored contents are not transferred automatically. Never clear player data or rename tables to force conversion.
{% endhint %}

## 1. Extract the resource

For download and purchase access, use [Purchased? Start here](/tweak5m-docs/purchased-start-here.md). Place the complete `cfx-tweak-noir-collection` folder in your server resources directory. `fxmanifest.lua` must sit directly inside that folder. Avoid a duplicate nested resource folder, and keep all stream folders and delivered protection files.

## 2. Import the database

Open [SQL setup](/tweak5m-docs/noir-collection/sql-setup.md) for the copyable SQL and database checks. Import this pack's fresh-install SQL into the database used by oxmysql. The Library has no SQL.

## 3. Add the items and icons

Open [Items & inventory icons](/tweak5m-docs/noir-collection/items-and-icons.md) for the complete copyable Lua fragment. Merge it inside the existing ox\_inventory item table, then copy the supplied PNGs into the inventory image folder.

## 4. Review the configuration

Edit this pack's `config.lua` and the Library configuration. ESX uses `esx` in both. QBCore uses `Config.Framework = 'qbcore'` in the pack and `qb` in the Library, and requires a compatible ox\_inventory framework integration. This does not convert qb-inventory. Choose your required capacities/access settings before testing; keep existing storage identities stable during updates.

## 5. Add the startup order

The following is an **ESX example** for server.cfg. Merge it with your existing startup configuration; do not duplicate ensures or overwrite the whole file. Keep any additional setup required by your framework and dependencies.

```cfg
ensure oxmysql
ensure ox_lib
ensure es_extended
ensure ox_inventory
ensure ox_target
ensure object_gizmo
ensure cfx-tweak-lib
ensure cfx-tweak-noir-collection
```

Enable OneSync using your server's normal configuration. A compatible QB/OX setup uses `qb-core` instead of `es_extended`; it still needs the listed OX dependencies.

## 6. Restart and confirm it works

Apply the resource and inventory changes during maintenance, reconnect clients, and test before public use.

* No missing dependency, database-table, export or Lua startup errors.
* All 28 item definitions and icons are present exactly once.
* Product menu, intended carry/wear interactions and storage work with your configured settings.
* Male/female fits and your server's clothing/peds are acceptable.
* Check placement, retrieval, storage persistence and interaction cleanup.
* When using individual packs together, use one shared Library. When using the Collection, stop the individual packs.

Need help? [Open the appropriate support ticket](/tweak5m-docs/support.md) with the product/version, dependency versions, steps and first redacted error. Never share keys, passwords, private source or player data.