# 04 — FiveM Resource Installation Complete customer guide for registering a FiveM server, configuring the Forge license and installing protected Nord Forge resources. # Installation Overview # FiveM Resource Installation This guide explains how to install a Nord Forge resource on a FiveM server from start to finish. For protected Nord Forge resources, the installation requires **both**: 1. A valid Nord Forge product license. 2. A FiveM server registered in Nord Forge. A valid Forge Key alone is **not enough**. ## Complete installation flow Follow these steps in order: 1. Sign in to Nord Forge. 2. Confirm the resource is available in **My Products**. 3. Copy your global **Forge Key**. 4. Register your FiveM server in **Forge → Servers**. 5. Add the Forge Key and Keymaster to `server.cfg`. 6. Download the latest resource release. 7. Extract the resource to your FiveM resources folder. 8. Install any required dependencies. 9. Import SQL files if the resource requires them. 10. Configure the resource. 11. Add `ensure resource_name` to `server.cfg`. 12. Restart the server. 13. Check the console for successful Nord Forge validation. > Always register the FiveM server before starting a protected resource for the first time. # Step 1 — Get Your Forge Key # Step 1 — Get Your Forge Key Every Nord Forge account has a global Forge Key. Example: ```text FG-XXXX-XXXX-XXXX-XXXX ``` ## Where it is used Protected Nord Forge resources use this key to identify the customer account and verify product access. Add it to your FiveM `server.cfg`: ```cfg setr nord_license "FG-XXXX-XXXX-XXXX-XXXX" ``` Replace the example with your real Forge Key. ## Important Do not share your Forge Key publicly. Never publish it in: - GitHub repositories - Discord channels - Screenshots - Public support messages - Shared server configuration examples # Step 2 — Register Your FiveM Server # Step 2 — Register Your FiveM Server Before using a protected resource, you must register the FiveM server in Nord Forge. ## What you need You need the FiveM server license key configured as: ```cfg sv_licenseKey "cfxk_xxxxxxxxxxxxxxxxx" ``` Nord Forge uses this Keymaster to identify the FiveM server. ## Register the server In Nord Forge: 1. Sign in to your account. 2. Open **Servers**. 3. Click **Add Server**. 4. Enter the server Keymaster / `sv_licenseKey`. 5. Optionally enter a server name. 6. Save the server. You can normally paste either: ```text cfxk_xxxxxxxxxxxxxxxxx ``` or: ```cfg sv_licenseKey "cfxk_xxxxxxxxxxxxxxxxx" ``` ## Server must match The Keymaster registered in Nord Forge must match the Keymaster used by the FiveM server. If the server is not registered, protected resources can return: ```text server_not_registered_add_keymaster_in_forge ``` ## Default server limit By default, one Forge account can have up to: ```text 3 active registered servers ``` The platform administrator can change this limit. # Step 3 — Configure server.cfg # Step 3 — Configure `server.cfg` Add the Nord Forge licensing configuration to your FiveM `server.cfg`. Recommended configuration: ```cfg setr nord_license "FG-XXXX-XXXX-XXXX-XXXX" setr nord_keymaster "cfxk_xxxxxxxxxxxxxxxxx" sv_licenseKey "cfxk_xxxxxxxxxxxxxxxxx" ``` ## `nord_license` Your global Nord Forge license key: ```cfg setr nord_license "FG-XXXX-XXXX-XXXX-XXXX" ``` ## `nord_keymaster` The FiveM server Keymaster used by Nord Forge validation: ```cfg setr nord_keymaster "cfxk_xxxxxxxxxxxxxxxxx" ``` ## `sv_licenseKey` Your normal FiveM server license: ```cfg sv_licenseKey "cfxk_xxxxxxxxxxxxxxxxx" ``` ## Important These two values must refer to the same FiveM server: ```cfg setr nord_keymaster "cfxk_xxxxxxxxxxxxxxxxx" sv_licenseKey "cfxk_xxxxxxxxxxxxxxxxx" ``` The same Keymaster must also be registered in **Nord Forge → Servers**. ## Legacy Forge Key fallbacks Some older resources may also support: ```cfg setr nord_forge_key "FG-XXXX-XXXX-XXXX-XXXX" ``` or: ```cfg setr forge_key "FG-XXXX-XXXX-XXXX-XXXX" ``` The preferred configuration is: ```cfg setr nord_license "FG-XXXX-XXXX-XXXX-XXXX" ``` # Step 4 — Download the Resource # Step 4 — Download the Resource Once the product is assigned to your account: 1. Open **My Products**. 2. Select the resource. 3. Review the latest version and changelog. 4. Check for configuration changes or database migrations. 5. Download the latest release. ## Before updating an existing resource Check whether the release contains: - Critical update warnings - Configuration changes - Database migrations - Compatibility notes - New dependencies Back up your current configuration and database before installing a major update. # Step 5 — Install the Resource # Step 5 — Install the Resource After downloading the resource ZIP: ## 1. Extract the ZIP Extract the resource package. You should normally get a folder such as: ```text nord_inventory ``` or: ```text nord_crafting ``` ## 2. Move it to the FiveM resources directory Example: ```text resources/[nord]/nord_inventory ``` Recommended structure: ```text resources/ └── [nord]/ ├── nord_inventory/ ├── nord_crafting/ └── nord_hud/ ``` ## 3. Do not rename protected resources unnecessarily Some protected resources identify the product using the resource/build configuration. Keep the original resource folder name unless the resource documentation explicitly says it can be changed. ## 4. Check `fxmanifest.lua` Make sure the resource contains a valid FiveM manifest: ```text fxmanifest.lua ``` or, for legacy resources: ```text __resource.lua ``` Do not remove Nord Forge protection/bootstrap files from protected customer builds. # Step 6 — Install Dependencies # Step 6 — Install Dependencies Some Nord Forge resources require additional FiveM resources. Examples can include: - Frameworks - Database libraries - Inventory systems - Target systems - Notification systems - Voice systems - UI libraries ## Check the individual resource documentation Every resource can have different requirements. Before starting it, check: - Dependencies - Minimum supported versions - Framework support - Required start order ## Start dependencies first Example: ```cfg ensure oxmysql ensure qb-core ensure nord_inventory ``` The exact order depends on the resource. If a Nord resource depends on another resource, the dependency should normally start first. # Step 7 — Database & SQL # Step 7 — Database & SQL Some Nord Forge resources require database tables or migrations. If the resource package contains SQL files, review them before starting the resource. Example files: ```text install.sql database.sql migration.sql ``` ## Installation Import the required SQL into the database used by your FiveM server. Common database tools include: - phpMyAdmin - Adminer - HeidiSQL - MySQL/MariaDB CLI ## Updates If a Nord Forge release is marked as: ```text Database Migration Required ``` read the release notes before updating. Always back up the database before applying a migration to a production server. # Step 8 — Configure the Resource # Step 8 — Configure the Resource Open the resource configuration files and configure them for your server. Depending on the product, this can include: - Framework - Locale - Inventory - Target - Notifications - Text UI - Database - Permissions - Integrations Common configuration locations include: ```text config.lua config/ shared/config.lua locales/ ``` Protected Nord Forge builds are designed to keep supported configuration, locale and public files editable. ## Do not edit protected runtime files If a runtime file is protected, do not attempt to remove or bypass the protection. Use the exposed configuration files and documented APIs instead. # Step 9 — Add the Resource to server.cfg # Step 9 — Add the Resource to `server.cfg` Add the resource to your FiveM startup configuration. Example: ```cfg ensure nord_inventory ``` For several Nord resources: ```cfg ensure nord_inventory ensure nord_crafting ensure nord_hud ``` ## Recommended order Put required dependencies before the Nord resource. Example: ```cfg ensure oxmysql ensure ox_lib ensure qb-core ensure nord_inventory ``` The exact order depends on the resource documentation. ## Licensing configuration should already exist Make sure the license configuration is present before starting protected resources: ```cfg setr nord_license "FG-XXXX-XXXX-XXXX-XXXX" setr nord_keymaster "cfxk_xxxxxxxxxxxxxxxxx" sv_licenseKey "cfxk_xxxxxxxxxxxxxxxxx" ``` # Step 10 — Start & Verify # Step 10 — Start & Verify Restart your FiveM server after completing the installation. You can also start the resource manually from the server console: ```text ensure nord_inventory ``` or: ```text restart nord_inventory ``` ## What to check Verify that: - The resource starts without Lua errors. - Nord Forge license validation succeeds. - The server is recognized as registered. - Required dependencies are running. - Database tables exist. - The resource UI/features load correctly. ## Forge validation problems If the resource reports: ```text server_not_registered_add_keymaster_in_forge ``` register the server in Nord Forge. If it reports: ```text missing_keymaster_use_server_cfg_setr_nord_keymaster ``` add: ```cfg setr nord_keymaster "cfxk_xxxxxxxxxxxxxxxxx" ``` If it reports: ```text invalid_forge_key ``` verify: ```cfg setr nord_license "FG-XXXX-XXXX-XXXX-XXXX" ``` # Full Installation Example # Full Installation Example This is a complete example for installing a protected Nord Forge FiveM resource. ## 1. Register the server in Nord Forge Register: ```text cfxk_MY_SERVER_KEY ``` under: ```text Nord Forge → Servers ``` ## 2. Configure `server.cfg` ```cfg sv_licenseKey "cfxk_MY_SERVER_KEY" setr nord_license "FG-MY-FORGE-KEY" setr nord_keymaster "cfxk_MY_SERVER_KEY" ensure oxmysql ensure qb-core ensure nord_inventory ``` ## 3. Install the files Place the resource at: ```text resources/[nord]/nord_inventory ``` ## 4. Configure it Edit the supported configuration files inside the resource. ## 5. Import SQL Import any required SQL or migration files included with the resource. ## 6. Restart the server Start the FiveM server and verify that Nord Forge licensing succeeds. ## Final checklist - Product is in **My Products** - Forge Key is active - FiveM server is registered in Forge - `nord_license` is configured - `nord_keymaster` is configured - `sv_licenseKey` matches the registered Keymaster - Resource folder is installed correctly - Dependencies are installed - SQL is imported when required - Resource is added to `server.cfg` - Server console shows no licensing error